Все поля Модели¶

null¶

Field.null¶

Если True, Django будет хранить пустые значения, как NULL в базе данных. По умолчанию False.

Избегайте использования nullв строковых полях, таких как CharField и TextField. Если строковое поле имеет null=True, это означает, что оно имеет два возможных значения для «нет данных»: NULLи пустая строка. В большинстве случаев иметь два возможных значения для «нет данных» излишне; соглашение Django заключается в использовании пустой строки, а не NULL. Единственным исключением является случай, когда для a заданы CharFieldоба параметра unique=True и blank=True. В этой ситуации null=Trueтребуется избежать нарушения уникальных ограничений при сохранении нескольких объектов с пустыми значениями.

Как для строковых, так и для нестроковых полей вам также нужно будет установить, blank=Trueесли вы хотите разрешить пустые значения в формах, поскольку nullпараметр влияет только на хранилище базы данных (см blank. Ресурсы ).

blank¶

Field.blank¶

Если True, поле может быть пустым. По умолчанию False.

Обратите внимание, что это отличается от null. nullотносится исключительно к базе данных, тогда как blank- к проверке. Если поле есть blank=True, проверка формы позволит ввести пустое значение. Если в поле есть blank=False, поле будет обязательным.

choices¶

Field.choices¶

Последовательность , состоящая из себя итерируемых ровно двух предметов (например ) для использования в качестве вариантов для этой области. Если предоставлены варианты выбора, они выполняются проверкой модели, и виджет формы по умолчанию будет представлять собой поле выбора с этими вариантами вместо стандартного текстового поля.[(A, B), (A, B) ...]

Первый элемент в каждом кортеже - это фактическое значение, которое должно быть установлено в модели, а второй элемент - это удобочитаемое имя. Например:

YEAR_IN_SCHOOL_CHOICES = [
    ('FR', 'Freshman'),
    ('SO', 'Sophomore'),
    ('JR', 'Junior'),
    ('SR', 'Senior'),
    ('GR', 'Graduate'),
]

Как правило, лучше всего определять варианты выбора внутри класса модели и определять константу с подходящим именем для каждого значения:

from django.db import models

class Student(models.Model):
    FRESHMAN = 'FR'
    SOPHOMORE = 'SO'
    JUNIOR = 'JR'
    SENIOR = 'SR'
    GRADUATE = 'GR'
    YEAR_IN_SCHOOL_CHOICES = [
        (FRESHMAN, 'Freshman'),
        (SOPHOMORE, 'Sophomore'),
        (JUNIOR, 'Junior'),
        (SENIOR, 'Senior'),
        (GRADUATE, 'Graduate'),
    ]
    year_in_school = models.CharField(
        max_length=2,
        choices=YEAR_IN_SCHOOL_CHOICES,
        default=FRESHMAN,
    )

    def is_upperclass(self):
        return self.year_in_school in {self.JUNIOR, self.SENIOR}

Хотя вы можете определить список вариантов вне класса модели, а затем ссылаться на него, определение вариантов выбора и имен для каждого варианта внутри класса модели сохраняет всю эту информацию с классом, который ее использует, и помогает ссылаться на варианты выбора (например, Student.SOPHOMORE будет работать везде, где Studentмодель была импортирована).

Вы также можете объединить доступные варианты в именованные группы, которые можно использовать в организационных целях:

MEDIA_CHOICES = [
    ('Audio', (
            ('vinyl', 'Vinyl'),
            ('cd', 'CD'),
        )
    ),
    ('Video', (
            ('vhs', 'VHS Tape'),
            ('dvd', 'DVD'),
        )
    ),
    ('unknown', 'Unknown'),
]

Первый элемент в каждом кортеже - это имя, применяемое к группе. Второй элемент представляет собой итерацию двух кортежей, каждый из которых содержит значение и удобочитаемое имя для параметра. Сгруппированные параметры могут быть объединены с несгруппированными параметрами в одном списке (например, 'unknown'параметр в этом примере).

Для каждого установленного поля модели choicesDjango добавит метод для получения удобочитаемого имени для текущего значения поля. См. get_FOO_display()Документацию по API базы данных.

Обратите внимание, что вариантами выбора может быть любой объект последовательности - не обязательно список или кортеж. Это позволяет динамически создавать варианты выбора. Но если вы обнаружите, что choicesхотите быть динамичным, вам, вероятно, лучше использовать правильную таблицу базы данных с расширением ForeignKey. choicesпредназначен для статических данных, которые не сильно меняются, если вообще когда-либо.

Если blank=Falseв поле не установлено значение вместе с, defaultто содержащаяся метка "---------"будет отображаться с полем выбора. Чтобы переопределить это поведение, добавьте кортеж к choices содержанию None; напр . В качестве альтернативы вы можете использовать пустую строку вместо того, где это имеет смысл - например, в .(None, 'Your String For Display')NoneCharField

from django.utils.translation import gettext_lazy as _

class Student(models.Model):

    class YearInSchool(models.TextChoices):
        FRESHMAN = 'FR', _('Freshman')
        SOPHOMORE = 'SO', _('Sophomore')
        JUNIOR = 'JR', _('Junior')
        SENIOR = 'SR', _('Senior')
        GRADUATE = 'GR', _('Graduate')

    year_in_school = models.CharField(
        max_length=2,
        choices=YearInSchool.choices,
        default=YearInSchool.FRESHMAN,
    )

    def is_upperclass(self):
        return self.year_in_school in {
            self.YearInSchool.JUNIOR,
            self.YearInSchool.SENIOR,
        }

>>> class Vehicle(models.TextChoices):
...     CAR = 'C'
...     TRUCK = 'T'
...     JET_SKI = 'J'
...
>>> Vehicle.JET_SKI.label
'Jet Ski'

class Card(models.Model):

    class Suit(models.IntegerChoices):
        DIAMOND = 1
        SPADE = 2
        HEART = 3
        CLUB = 4

    suit = models.IntegerField(choices=Suit.choices)

>>> MedalType = models.TextChoices('MedalType', 'GOLD SILVER BRONZE')
>>> MedalType.choices
[('GOLD', 'Gold'), ('SILVER', 'Silver'), ('BRONZE', 'Bronze')]
>>> Place = models.IntegerChoices('Place', 'FIRST SECOND THIRD')
>>> Place.choices
[(1, 'First'), (2, 'Second'), (3, 'Third')]

class MoonLandings(datetime.date, models.Choices):
    APOLLO_11 = 1969, 7, 20, 'Apollo 11 (Eagle)'
    APOLLO_12 = 1969, 11, 19, 'Apollo 12 (Intrepid)'
    APOLLO_14 = 1971, 2, 5, 'Apollo 14 (Antares)'
    APOLLO_15 = 1971, 7, 30, 'Apollo 15 (Falcon)'
    APOLLO_16 = 1972, 4, 21, 'Apollo 16 (Orion)'
    APOLLO_17 = 1972, 12, 11, 'Apollo 17 (Challenger)'

db_column¶

Field.db_column¶

Имя столбца базы данных, используемого для этого поля. Если это не указано, Django будет использовать имя поля.

Если имя столбца вашей базы данных является зарезервированным словом SQL или содержит символы, которые не разрешены в именах переменных Python, в частности дефис, - это нормально. Django цитирует имена столбцов и таблиц за кулисами.

db_index¶

Field.db_index¶

Если True, для этого поля будет создан индекс базы данных.

db_tablespace¶

Field.db_tablespace¶

Имя табличного пространства базы данных, которое будет использоваться для индекса этого поля, если это поле проиндексировано. По умолчанию используется параметр проекта DEFAULT_INDEX_TABLESPACE, если он установлен, или db_tablespaceпараметр модели, если есть. Если серверная часть не поддерживает табличные пространства для индексов, этот параметр игнорируется.

default¶

Field.default¶

Значение по умолчанию для поля. Это может быть значение или вызываемый объект. Если вызываемый, он будет вызываться каждый раз при создании нового объекта.

По умолчанию не может быть изменяемым объектом (экземпляр модели, list, setи т.д.), в качестве ссылки на тот же экземпляр этого объекта будет использоваться в качестве значения по умолчанию во всех новых экземплярах модели. Вместо этого оберните желаемое значение по умолчанию в вызываемый. Например, если вы хотите указать значение dictпо умолчанию для JSONField, используйте функцию:

def contact_default():
    return {"email": "[email protected]"}

contact_info = JSONField("ContactInfo", default=contact_default)

lambdas нельзя использовать для параметров поля, например, defaultпотому что они не могут быть сериализованы путем миграции . См. Эту документацию для получения других предупреждений.

Для таких полей, как ForeignKeyэто сопоставление с экземплярами модели, значения по умолчанию должны быть значением поля, на которое они ссылаются ( pkесли to_fieldне установлено), а не экземплярами модели.

Значение по умолчанию используется при создании новых экземпляров модели, а значение для поля не предоставляется. Когда поле является первичным ключом, значение по умолчанию также используется, когда для поля установлено значение None.

editable¶

Field.editable¶

Если False, поле не будет отображаться ни в админке, ни в каком-либо другом ModelForm. Они также пропускаются во время проверки модели . По умолчанию True.

error_messages¶

Field.error_messages¶

error_messagesАргумент позволяет переопределить сообщения по умолчанию , что поле будет поднимать. Передайте словарь с ключами, соответствующими сообщениям об ошибках, которые вы хотите переопределить.

Ключи сообщений об ошибках включают в себя null, blank, invalid, invalid_choice, unique, и unique_for_date. Дополнительные ключи сообщений об ошибках указаны для каждого поля в разделе Типы полей ниже.

Эти сообщения об ошибках часто не передаются в формы. См . Замечания относительно error_messages модели .

help_text¶

Field.help_text¶

Дополнительный текст «справки» для отображения в виджете формы. Это полезно для документации, даже если ваше поле не используется в форме.

Обратите внимание, что это значение не экранируется HTML в автоматически сгенерированных формах. Это позволяет вам включать HTML, help_textесли хотите. Например:

help_text="Please use the following format: <em>YYYY-MM-DD</em>."

В качестве альтернативы вы можете использовать обычный текст и django.utils.html.escape()экранировать любые специальные символы HTML. Убедитесь, что вы избегаете любого текста справки, который может исходить от ненадежных пользователей, чтобы избежать атаки межсайтового сценария.

primary_key¶

Field.primary_key¶

Если Trueэто поле является первичным ключом для модели.

Если вы не укажете primary_key=Trueни одно поле в своей модели, Django автоматически добавит элемент AutoFieldдля хранения первичного ключа, поэтому вам не нужно устанавливать primary_key=Trueкакие-либо поля, если вы не хотите переопределить поведение первичного ключа по умолчанию. Дополнительные сведения см. В разделе Автоматические поля первичного ключа .

primary_key=Trueподразумевает null=Falseи unique=True. Для объекта разрешен только один первичный ключ.

Поле первичного ключа доступно только для чтения. Если вы измените значение первичного ключа в существующем объекте, а затем сохраните его, новый объект будет создан рядом со старым.

unique¶

Field.unique¶

Если True, это поле должно быть уникальным во всей таблице.

Это обеспечивается на уровне базы данных и проверкой модели. Если вы попытаетесь сохранить модель с повторяющимся значением в unique поле, метод django.db.IntegrityErrorмодели поднимет a save().

Эта опция действительна для всех типов полей, кроме ManyToManyFieldи OneToOneField.

Обратите внимание, что когда uniqueесть True, указывать не нужно db_index, поскольку uniqueподразумевает создание индекса.

unique_for_date¶

Field.unique_for_date¶

Задайте для него имя DateFieldили, DateTimeFieldчтобы это поле было уникальным для значения поля даты.

Например, если у вас есть поле, в titleкотором есть unique_for_date="pub_date", то Django не разрешит ввод двух записей с одинаковыми titleи pub_date.

Обратите внимание, что если вы установите для этого параметра значение a DateTimeField, будет учитываться только часть поля даты. Кроме того, когда USE_TZесть True, проверка будет выполняться в текущем часовом поясе в момент сохранения объекта.

Это выполняется Model.validate_unique()во время проверки модели, но не на уровне базы данных. Если какое-либо unique_for_dateограничение включает поля, которые не являются частью ModelForm(например, если одно из полей указано excludeили имеет editable=False), Model.validate_unique()проверка для этого конкретного ограничения будет пропущена.

unique_for_month¶

Field.unique_for_month¶

Нравится unique_for_date, но требует, чтобы поле было уникальным по отношению к месяцу.

unique_for_year¶

Field.unique_for_year¶

Вроде unique_for_dateи unique_for_month.

verbose_name¶

Field.verbose_name¶

Удобочитаемое имя поля. Если подробное имя не указано, Django автоматически создаст его, используя имя атрибута поля, преобразовав подчеркивание в пробелы. См. Подробные имена полей .

validators¶

Field.validators¶

Список валидаторов, запускаемых для этого поля. Дополнительную информацию см. В документации по валидаторам .

AutoField¶

классAutoField ( ** варианты ) ¶

Значение, IntegerFieldкоторое автоматически увеличивается в соответствии с доступными идентификаторами. Обычно вам не нужно использовать это напрямую; поле первичного ключа будет автоматически добавлено в вашу модель, если вы не укажете иное. См. Автоматические поля первичного ключа .

BigAutoField¶

классBigAutoField ( ** варианты ) ¶

64-битное целое число, очень похожее на an, AutoFieldза исключением того, что оно гарантированно соответствует числам от 1до 9223372036854775807.

BigIntegerField¶

классBigIntegerField ( ** варианты ) ¶

64-битное целое число, очень похожее на an, IntegerFieldза исключением того, что оно гарантированно соответствует числам от -9223372036854775808до 9223372036854775807. Виджет формы по умолчанию для этого поля - NumberInput.

BinaryField¶

classBinaryField ( max_length = None , ** варианты ) ¶

Поле для хранения необработанных двоичных данных. Он может быть назначен bytes, bytearrayили memoryview.

По умолчанию BinaryFieldустанавливается editableзначение False, и в этом случае его нельзя включить в файл ModelForm.

BinaryField имеет один дополнительный необязательный аргумент:

BinaryField.max_length¶

Максимальная длина (в символах) поля. Максимальная длина принудительно устанавливается при проверке Django с использованием MaxLengthValidator.

BooleanField¶

классBooleanField ( ** варианты ) ¶

Поле истина / ложь.

Виджет формы по умолчанию для этого поля - CheckboxInput, или NullBooleanSelectесли null=True.

Значение по умолчанию BooleanField- Noneкогда Field.default не определено.

CharField¶

classCharField ( max_length = None , ** варианты ) ¶

Строковое поле для строк от маленького до большого.

Для больших объемов текста используйте TextField.

Виджет формы по умолчанию для этого поля - TextInput.

CharField имеет один дополнительный обязательный аргумент:

CharField.max_length¶

Максимальная длина (в символах) поля. Max_length применяется на уровне базы данных и при проверке Django с использованием MaxLengthValidator.

DateField¶

classDateField ( auto_now = False , auto_now_add = False , ** параметры ) ¶

Дата, представленная в Python datetime.dateэкземпляром. Имеет несколько дополнительных необязательных аргументов:

DateField.auto_now¶

Автоматически устанавливать поле сейчас каждый раз при сохранении объекта. Полезно для отметок времени «последнего изменения». Обратите внимание, что всегда используется текущая дата ; это не просто значение по умолчанию, которое вы можете изменить.

Поле обновляется автоматически только при звонке Model.save(). Поле не обновляется при обновлении других полей другими способами, например QuerySet.update(), хотя вы можете указать настраиваемое значение для поля в таком обновлении.

DateField.auto_now_add¶

Автоматически установить для поля значение «Сейчас» при первом создании объекта. Полезно для создания отметок времени. Обратите внимание, что всегда используется текущая дата ; это не просто значение по умолчанию, которое вы можете изменить. Таким образом, даже если вы установите значение для этого поля при создании объекта, оно будет проигнорировано. Если вы хотите иметь возможность изменять это поле, вместо auto_now_add=True:

• Для DateField: default=date.today- от datetime.date.today()
• Для DateTimeField: default=timezone.now- от django.utils.timezone.now()

Виджет формы по умолчанию для этого поля - DateInput. Администратор добавляет календарь JavaScript и ярлык для «Сегодня». Включает дополнительный invalid_dateключ сообщения об ошибке.

Опции auto_now_add, auto_nowи defaultявляются взаимоисключающими. Любая комбинация этих опций приведет к ошибке.

DateTimeField¶

classDateTimeField ( auto_now = False , auto_now_add = False , ** параметры ) ¶

Дата и время, представленные в Python datetime.datetimeэкземпляром. Принимает те же дополнительные аргументы, что и DateField.

Виджет формы по умолчанию для этого поля - одиночный DateTimeInput. Администратор использует два отдельных TextInputвиджета с ярлыками JavaScript.

DecimalField¶

classDecimalField ( max_digits = None , decimal_places = None , ** options ) ¶

Десятичное число с фиксированной точностью, представленное в Python Decimalэкземпляром. Он проверяет ввод с помощью DecimalValidator.

Имеет два обязательных аргумента:

DecimalField.max_digits¶

Максимально допустимое количество цифр в номере. Обратите внимание, что это число должно быть больше или равно decimal_places.

DecimalField.decimal_places¶

Количество десятичных знаков, которые нужно сохранить вместе с номером.

Например, для хранения чисел 999с разрешением до 2 знаков после запятой вы должны использовать:

models.DecimalField(..., max_digits=5, decimal_places=2)

И для хранения чисел примерно до одного миллиарда с разрешением до 10 знаков после запятой:

models.DecimalField(..., max_digits=19, decimal_places=10)

Виджет формы по умолчанию для этого поля - NumberInput когда localizeесть Falseили TextInputнет.

DurationField¶

классDurationField ( ** варианты ) ¶

Поле для хранения периодов времени - смоделировано на Python с помощью timedelta. При использовании в PostgreSQL используется тип данных, intervalа в Oracle тип данных . В противном случае используется микросекунды.INTERVAL DAY(9) TO SECOND(6)bigint

EmailField¶

classEmailField ( max_length = 254 , ** варианты ) ¶

CharField, Что проверяет , что значение является действительным адресом электронной почты , используя EmailValidator.

FileField¶

classFileField ( upload_to = None , max_length = 100 , ** options ) ¶

Поле для загрузки файла.

Имеет два необязательных аргумента:

FileField.upload_to¶

Этот атрибут обеспечивает способ установки каталога загрузки и имени файла и может быть установлен двумя способами. В обоих случаях значение передается Storage.save()методу.

Если вы укажете строковое значение или a Path, оно может содержать strftime()форматирование, которое будет заменено датой / временем загрузки файла (чтобы загруженные файлы не заполняли заданный каталог). Например:

class MyModel(models.Model):
    # file will be uploaded to MEDIA_ROOT/uploads
    upload = models.FileField(upload_to='uploads/')
    # or...
    # file will be saved to MEDIA_ROOT/uploads/2015/01/30
    upload = models.FileField(upload_to='uploads/%Y/%m/%d/')

Если вы используете значение по умолчанию FileSystemStorage, строковое значение будет добавлено к вашему MEDIA_ROOTпути, чтобы сформировать расположение в локальной файловой системе, где будут храниться загруженные файлы. Если вы используете другое хранилище, проверьте его документацию, чтобы узнать, как оно работает upload_to.

upload_toтакже может быть вызываемым, например функцией. Это будет вызвано для получения пути загрузки, включая имя файла. Этот вызываемый объект должен принимать два аргумента и возвращать путь в стиле Unix (с косой чертой) для передачи в систему хранения. Вот два аргумента:

Аргумент	Описание
instance	Экземпляр модели, в FileFieldкоторой определен. В частности, это конкретный экземпляр, к которому прикрепляется текущий файл. В большинстве случаев этот объект еще не был сохранен в базе данных, поэтому, если он использует значение по умолчанию AutoField, он может еще не иметь значения для своего поля первичного ключа .
filename	Имя файла, которое изначально было присвоено файлу. Это может или не может быть принято во внимание при определении конечного пути назначения.

Например:

def user_directory_path(instance, filename):
    # file will be uploaded to MEDIA_ROOT/user_<id>/<filename>
    return 'user_{0}/{1}'.format(instance.user.id, filename)

class MyModel(models.Model):
    upload = models.FileField(upload_to=user_directory_path)

Изменено в Django 3.0:

Поддержка pathlib.Pathбыла добавлена.

FileField.storage¶

Объект хранения или вызываемый объект, который возвращает объект хранения. Это управляет хранением и поиском ваших файлов. См. Управление файлами для получения подробной информации о том, как предоставить этот объект.

Изменено в Django 3.1:

Добавлена ​​возможность предоставления вызываемого объекта.

Виджет формы по умолчанию для этого поля - ClearableFileInput.

Использование FileFieldили ImageField(см. Ниже) в модели требует нескольких шагов:

1. В файле настроек вам необходимо указать MEDIA_ROOTполный путь к каталогу, в котором Django будет хранить загруженные файлы. (Для повышения производительности эти файлы не хранятся в базе данных.) Определите MEDIA_URLкак базовый общедоступный URL-адрес этого каталога. Убедитесь, что в этот каталог разрешена запись учетной записи пользователя веб-сервера.
2. Добавьте FileFieldили ImageFieldв свою модель, указав upload_toпараметр, чтобы указать подкаталог MEDIA_ROOTдля использования для загруженных файлов.
3. Все, что будет храниться в вашей базе данных, - это путь к файлу (относительно MEDIA_ROOT). Скорее всего, вы захотите использовать urlатрибут удобства, предоставляемый Django. Например, если ваш ImageFieldвызывается mug_shot, вы можете получить абсолютный путь к вашему изображению в шаблоне с помощью .{{ object.mug_shot.url }}

Например, скажем, ваш MEDIA_ROOTустановлен на '/home/media', и upload_toустановлен на 'photos/%Y/%m/%d'. '%Y/%m/%d' Часть upload_toIS strftime()форматирования; '%Y'- год из четырех цифр, '%m'месяц '%d'из двух цифр и день из двух цифр. Если вы загрузите файл 15 января 2007 г., он будет сохранен в каталоге /home/media/photos/2007/01/15.

Если вы хотите получить на диске имя файла загруженного файла в, или размер файла, вы можете использовать nameи sizeатрибуты соответственно; Дополнительные сведения о доступных атрибутах и ​​методах см. в Fileсправочнике по классам и в разделе « Управление файлами» .

Относительный URL загруженного файла можно получить с помощью urlатрибута. Внутри это вызывает url()метод базового Storageкласса.

Обратите внимание, что всякий раз, когда вы имеете дело с загруженными файлами, вы должны обращать пристальное внимание на то, куда вы их загружаете и какой это тип файлов, чтобы избежать дыр в безопасности. Проверьте все загруженные файлы, чтобы убедиться, что они соответствуют вашим представлениям. Например, если вы слепо позволяете кому-то загружать файлы без проверки в каталог, который находится в корневом каталоге документов вашего веб-сервера, то кто-то может загрузить сценарий CGI или PHP и выполнить этот сценарий, посетив его URL-адрес на вашем сайте. Не позволяй этого.

Также обратите внимание, что даже загруженный файл HTML, поскольку он может быть выполнен браузером (но не сервером), может представлять угрозы безопасности, эквивалентные атакам XSS или CSRF.

FileFieldэкземпляры создаются в вашей базе данных в виде varchar столбцов с максимальной длиной по умолчанию 100 символов. Как и в случае с другими полями, вы можете изменить максимальную длину с помощью max_lengthаргумента.

from django.core.files import File
# Open an existing file using Python's built-in open()
f = open('/path/to/hello.world')
myfile = File(f)

from django.core.files.base import ContentFile
myfile = ContentFile("hello world")

FilePathField¶

classFilePathField ( path = '' , match = None , recursive = False , allow_files = True , allow_folders = False , max_length = 100 , ** options ) ¶

A, CharFieldчей выбор ограничен именами файлов в определенном каталоге файловой системы. Имеет некоторые специальные аргументы, из которых требуется первый :

FilePathField.path¶

Необходимые. Абсолютный путь файловой системы к каталогу, из которого он FilePathFieldдолжен получать свои варианты выбора. Пример: "/home/images".

pathтакже может быть вызываемым, например функцией для динамической установки пути во время выполнения. Пример:

import os
from django.conf import settings
from django.db import models

def images_path():
    return os.path.join(settings.LOCAL_FILE_DIR, 'images')

class MyModel(models.Model):
    file = models.FilePathField(path=images_path)

Изменено в Django 3.0:

path теперь может быть вызываемым.

FilePathField.match¶

Необязательный. Регулярное выражение в виде строки, которое FilePathField будет использоваться для фильтрации имен файлов. Обратите внимание, что регулярное выражение будет применяться к базовому имени файла, а не к полному пути. Пример:, "foo.*\.txt$"который будет соответствовать файлу с именем, foo23.txtно не bar.txtили foo23.png.

FilePathField.recursive¶

Необязательный. Либо, Trueлибо False. По умолчанию False. Указывает, pathдолжны ли быть включены все подкаталоги

FilePathField.allow_files¶

Необязательный. Либо, Trueлибо False. По умолчанию True. Указывает, должны ли быть включены файлы в указанном месте. Либо так, либо allow_foldersдолжно быть True.

FilePathField.allow_folders¶

Необязательный. Либо, Trueлибо False. По умолчанию False. Указывает, должны ли быть включены папки в указанном месте. Либо так, либо allow_filesдолжно быть True.

Одна потенциальная проблема - это то, что matchотносится к базовому имени файла, а не к полному пути. Итак, этот пример:

FilePathField(path="/home/images", match="foo.*", recursive=True)

… Будет соответствовать, /home/images/foo.pngно не /home/images/foo/bar.png потому, что matchприменяется к базовому имени файла ( foo.pngи bar.png).

FilePathFieldэкземпляры создаются в вашей базе данных в виде varchar столбцов с максимальной длиной по умолчанию 100 символов. Как и в случае с другими полями, вы можете изменить максимальную длину с помощью max_lengthаргумента.

FloatField¶

классFloatField ( ** варианты ) ¶

Число с плавающей запятой, представленное в Python floatэкземпляром.

Виджет формы по умолчанию для этого поля - NumberInput когда localizeесть Falseили TextInputнет.

ImageField¶

classImageField ( upload_to = None , height_field = None , width_field = None , max_length = 100 , ** параметры ) ¶

Наследует все атрибуты и методы от FileField, но также проверяет, является ли загруженный объект допустимым изображением.

В дополнение к специальным атрибутам, которые доступны для FileField, ImageFieldтакже heightи widthатрибуты.

Для облегчения запросов к этим атрибутам ImageFieldесть два дополнительных необязательных аргумента:

ImageField.height_field¶

Имя поля модели, которое будет автоматически заполняться высотой изображения при каждом сохранении экземпляра модели.

ImageField.width_field¶

Имя поля модели, которое будет автоматически заполняться шириной изображения при каждом сохранении экземпляра модели.

Требуется библиотека подушек .

ImageFieldэкземпляры создаются в вашей базе данных в виде varchar столбцов с максимальной длиной по умолчанию 100 символов. Как и в случае с другими полями, вы можете изменить максимальную длину с помощью max_lengthаргумента.

Виджет формы по умолчанию для этого поля - ClearableFileInput.

IntegerField¶

классIntegerField ( ** варианты ) ¶

Целое число. Значения от -2147483648до 2147483647безопасны во всех базах данных, поддерживаемых Django.

Он использует MinValueValidatorи MaxValueValidatorдля проверки ввода на основе значений, поддерживаемых базой данных по умолчанию.

Виджет формы по умолчанию для этого поля - NumberInput когда localizeесть Falseили TextInputнет.

GenericIPAddressField¶

classGenericIPAddressField ( протокол = 'both' , unpack_ipv4 = False , ** параметры ) ¶

Адрес IPv4 или IPv6 в строковом формате (например, 192.0.2.30или 2a02:42fe::4). Виджет формы по умолчанию для этого поля - TextInput.

Нормализация адреса IPv6 следует RFC 4291 # section-2.2 раздел 2.2, включая использование формата IPv4, предложенного в параграфе 3 этого раздела, например ::ffff:192.0.2.0. Например,2001:0::0:01будет нормализовано к 2001::1и::ffff:0a0a:0a0aк::ffff:10.10.10.10. Все символы переводятся в нижний регистр.

GenericIPAddressField.protocol¶

Ограничивает допустимые входные данные указанным протоколом. Допустимые значения: 'both'(по умолчанию) 'IPv4' или 'IPv6'. При сопоставлении регистр не учитывается.

GenericIPAddressField.unpack_ipv4¶

Распаковывает сопоставленные адреса IPv4, например ::ffff:192.0.2.1. Если эта опция включена, этот адрес будет распакован 192.0.2.1. По умолчанию отключено. Может использоваться, только если для protocolнего установлено значение 'both'.

Если вы разрешаете пустые значения, вы должны разрешить и пустые значения, так как пустые значения сохраняются как пустые.

JSONField¶

классJSONField ( кодировщик = Нет , декодер = Нет , ** параметры ) ¶

Поле для хранения данных в кодировке JSON. В Python данные представлены в собственном формате Python: словари, списки, строки, числа, логические значения и None.

JSONFieldподдерживается в MariaDB 10.2.7+, MySQL 5.7.8+, Oracle, PostgreSQL и SQLite 3.9.0+ (с включенным расширением JSON1 ).

JSONField.encoder¶

Необязательный json.JSONEncoderподкласс для сериализации типов данных, не поддерживаемых стандартным сериализатором JSON (например, datetime.datetime или UUID). Например, вы можете использовать DjangoJSONEncoderкласс.

По умолчанию json.JSONEncoder.

JSONField.decoder¶

Необязательный json.JSONDecoderподкласс для десериализации значения, полученного из базы данных. Значение будет в формате, выбранном пользовательским кодировщиком (чаще всего в виде строки). При десериализации может потребоваться учитывать тот факт, что вы не можете быть уверены в типе ввода. Например, вы рискуете вернуть a, datetimeкоторый на самом деле был строкой, которая случайно оказалась в том же формате, который был выбран для datetimes.

По умолчанию json.JSONDecoder.

Если вы задаете полю a default, убедитесь, что это неизменяемый объект, например a str, или вызываемый объект, который каждый раз возвращает новый изменяемый объект, например dictили функцию. Предоставление изменяемого объекта по умолчанию, такого как один объект default={}или default=[]разделяет его между всеми экземплярами модели.

Чтобы сделать запрос JSONFieldв базе данных, см. Запрос JSONField .

NullBooleanField¶

классNullBooleanField ( ** варианты ) ¶

Вроде BooleanFieldс null=True.

PositiveBigIntegerField¶

классPositiveBigIntegerField ( ** варианты ) ¶

Подобно a PositiveIntegerField, но допускает значения только в определенной (зависящей от базы данных) точке. Значения от 0до 9223372036854775807безопасны во всех базах данных, поддерживаемых Django.

PositiveIntegerField¶

классPositiveIntegerField ( ** варианты ) ¶

Подобно IntegerField, но должно быть положительным или нулевым ( 0). Значения от 0до 2147483647безопасны во всех базах данных, поддерживаемых Django. Значение 0принято из соображений обратной совместимости.

PositiveSmallIntegerField¶

классPositiveSmallIntegerField ( ** варианты ) ¶

Подобно a PositiveIntegerField, но допускает значения только в определенной (зависящей от базы данных) точке. Значения от 0до 32767безопасны во всех базах данных, поддерживаемых Django.

SlugField¶

classSlugField ( max_length = 50 , ** варианты ) ¶

Слизняк - это газетный термин. Слаг - это короткая метка для чего-либо, содержащая только буквы, цифры, символы подчеркивания или дефисы. Обычно они используются в URL-адресах.

Как и CharField, вы можете указать max_length(прочтите примечание о переносимости базы данных и max_lengthв этом разделе). Если max_lengthне указано, Django будет использовать длину по умолчанию 50.

Подразумевает установку Field.db_indexна True.

Часто бывает полезно автоматически предварительно заполнить SlugField на основе значения некоторого другого значения. Вы можете сделать это автоматически в админке с помощью prepopulated_fields.

Он использует validate_slugили validate_unicode_slugдля проверки.

SlugField.allow_unicode¶

Если True, поле принимает буквы Юникода в дополнение к буквам ASCII. По умолчанию False.

SmallAutoField¶

классSmallAutoField ( ** варианты ) ¶

Как AutoField, но допускает значения только в пределах определенного (зависящего от базы данных) предела. Значения от 1до 32767безопасны во всех базах данных, поддерживаемых Django.

SmallIntegerField¶

классSmallIntegerField ( ** варианты ) ¶

Как IntegerField, но допускает значения только в определенной (зависящей от базы данных) точке. Значения от -32768до 32767безопасны во всех базах данных, поддерживаемых Django.

TextField¶

классTextField ( ** варианты ) ¶

Большое текстовое поле. Виджет формы по умолчанию для этого поля - Textarea.

Если вы укажете max_lengthатрибут, он будет отражен в Textareaвиджете автоматически созданного поля формы. Однако это не применяется на уровне модели или базы данных. Используйте CharFieldдля этого.

TimeField¶

classTimeField ( auto_now = False , auto_now_add = False , ** параметры ) ¶

Время, представленное в Python datetime.timeэкземпляром. Принимает те же параметры автозаполнения, что и DateField.

Виджет формы по умолчанию для этого поля - TimeInput. Администратор добавляет несколько ярлыков JavaScript.

URLField¶

classURLField ( max_length = 200 , ** варианты ) ¶

A CharFieldдля URL, подтвержденного URLValidator.

Виджет формы по умолчанию для этого поля - URLInput.

Как и все CharFieldподклассы, URLFieldпринимает необязательный max_lengthаргумент. Если не указать max_length, используется значение по умолчанию 200.

UUIDField¶

классUUIDField ( ** варианты ) ¶

Поле для хранения универсальных уникальных идентификаторов. Использует UUIDкласс Python . При использовании в PostgreSQL хранится в uuidтипе данных, в противном случае - в файле char(32).

Универсальные уникальные идентификаторы - хорошая альтернатива AutoFieldfor primary_key. База данных не будет генерировать UUID для вас, поэтому рекомендуется использовать default:

import uuid
from django.db import models

class MyUUIDModel(models.Model):
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    # other fields

Обратите внимание, что вызываемый объект (без круглых скобок) передается default, а не экземпляр UUID.

ForeignKey¶

classForeignKey ( to , on_delete , ** параметры ) ¶

Отношения "многие к одному". Требуется два позиционных аргумента: класс, к которому относится модель, и on_deleteпараметр.

Чтобы создать рекурсивную связь - объект, который имеет отношение «многие к одному» с самим собой, используйте .models.ForeignKey('self', on_delete=models.CASCADE)

Если вам нужно создать связь в модели, которая еще не была определена, вы можете использовать имя модели, а не сам объект модели:

from django.db import models

class Car(models.Model):
    manufacturer = models.ForeignKey(
        'Manufacturer',
        on_delete=models.CASCADE,
    )
    # ...

class Manufacturer(models.Model):
    # ...
    pass

Взаимосвязи, определенные таким образом в абстрактных моделях , разрешаются, когда модель подклассифицируется как конкретная модель, а не относительно абстрактной модели app_label:

from django.db import models

class AbstractCar(models.Model):
    manufacturer = models.ForeignKey('Manufacturer', on_delete=models.CASCADE)

    class Meta:
        abstract = True

from django.db import models
from products.models import AbstractCar

class Manufacturer(models.Model):
    pass

class Car(AbstractCar):
    pass

# Car.manufacturer will point to `production.Manufacturer` here.

Чтобы ссылаться на модели, определенные в другом приложении, вы можете явно указать модель с полной меткой приложения. Например, если Manufacturer указанная выше модель определена в другом названном приложении production, вам нужно будет использовать:

class Car(models.Model):
    manufacturer = models.ForeignKey(
        'production.Manufacturer',
        on_delete=models.CASCADE,
    )

Такая ссылка, называемая ленивыми отношениями, может быть полезна при разрешении зависимостей циклического импорта между двумя приложениями.

Индекс базы данных автоматически создается на платформе ForeignKey. Вы можете отключить это, установив db_indexна False. Вы можете избежать накладных расходов на индекс, если вы создаете внешний ключ для согласованности, а не для объединений, или если вы будете создавать альтернативный индекс, такой как частичный или многостолбцовый индекс.

ManyToManyField¶

классManyToManyField ( к , ** варианты ) ¶

Отношения "многие ко многим". Требуется позиционный аргумент: класс, к которому относится модель, который работает точно так же, как и для ForeignKey, включая рекурсивные и ленивые отношения.

Связанные объекты могут быть добавлены, удалены или созданы с помощью поля RelatedManager.

OneToOneField¶

classOneToOneField ( to , on_delete , parent_link = False , ** параметры ) ¶

Отношения один на один. Концептуально это похоже на ForeignKeywith unique=True, но «обратная» сторона отношения будет напрямую возвращать один объект.

Это наиболее полезно в качестве первичного ключа модели, который каким-то образом «расширяет» другую модель; Наследование нескольких таблиц реализуется, например, путем добавления неявного однозначного отношения от дочерней модели к родительской модели.

Требуется один позиционный аргумент: класс, к которому будет относиться модель. Это работает точно так же, как и для ForeignKey, включая все параметры, касающиеся рекурсивных и ленивых отношений.

Если вы не укажете related_nameаргумент для OneToOneField, Django будет использовать имя текущей модели в нижнем регистре в качестве значения по умолчанию.

В следующем примере:

from django.conf import settings
from django.db import models

class MySpecialUser(models.Model):
    user = models.OneToOneField(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )
    supervisor = models.OneToOneField(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
        related_name='supervisor_of',
    )

ваша результирующая Userмодель будет иметь следующие атрибуты:

>>> user = User.objects.get(pk=1)
>>> hasattr(user, 'myspecialuser')
True
>>> hasattr(user, 'supervisor_of')
True

RelatedObjectDoesNotExistВозбуждается исключение при доступе к обратной связи , если запись в связанной таблице не существует. Это подкласс Model.DoesNotExistисключения целевой модели . Например, если у пользователя нет супервизора, назначенного MySpecialUser:

>>> user.supervisor_of
Traceback (most recent call last):
    ...
RelatedObjectDoesNotExist: User has no supervisor_of.

Кроме того, OneToOneFieldпринимает все дополнительные аргументы, которые принимает ForeignKey, плюс один дополнительный аргумент:

OneToOneField.parent_link¶

Когда Trueи используется в модели, которая наследуется от другой конкретной модели , указывает, что это поле должно использоваться как обратная ссылка на родительский класс, а не как дополнительное, OneToOneFieldкоторое обычно неявно создается путем создания подклассов.

См отношения один-к-одному для примеров использования OneToOneField.