• 3.2
  • 5.0
  • 6.1
  • Версия документации: 3.1

Справочник по полям модели

Этот раздел содержит все существующие подробности о всех параметрах поля и типах полей в Django.

См.также

If the built-in fields don’t do the trick, you can try django-localflavor (documentation), which contains assorted pieces of code that are useful for particular countries and cultures.

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

Примечание

Technically, these models are defined in django.db.models.fields, but for convenience they’re imported into django.db.models; the standard convention is to use from django.db import models and refer to fields as models.<Foo>Field.

Параметры поля

Приведенные аргументы доступны для всех полей. Все они не обязательны.

null

Field.null

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

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

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

Примечание

При использовании Oracle, NULL будет использоваться для пустой строки независимо от значения этого параметра.

blank

Field.blank

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

Заметим что этот параметр отличается от null. null указывается для базы данных, в то время как blank – для проверки данных. При blank=True, проверка данных в форме позволит сохранять пустое значение в поле. При blank=False поле будет обязательным.

choices

Field.choices

A sequence consisting itself of iterables of exactly two items (e.g. [(A, B), (A, B) ...]) to use as choices for this field. If choices are given, they’re enforced by model validation and the default form widget will be a select box with these choices instead of the standard text field.

The first element in each tuple is the actual value to be set on the model, and the second element is the human-readable name. For example:

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'),
]

The first element in each tuple is the name to apply to the group. The second element is an iterable of 2-tuples, with each 2-tuple containing a value and a human-readable name for an option. Grouped options may be combined with ungrouped options within a single list (such as the 'unknown' option in this example).

For each model field that has choices set, Django will add a method to retrieve the human-readable name for the field’s current value. See get_FOO_display() in the database API documentation.

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

Примечание

Новая миграция создается каждый раз, когда меняется порядок «выборов».

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

Типы перечислений

Кроме того, Django предоставляет типы перечислений, которые вы можете подклассифицировать для краткого определения выбора:

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,
        }

Они работают аналогично enum из стандартной библиотеки Python, но с некоторыми изменениями:

  • Enum member values are a tuple of arguments to use when constructing the concrete data type. Django supports adding an extra string value to the end of this tuple to be used as the human-readable name, or label. The label can be a lazy translatable string. Thus, in most cases, the member value will be a (value, label) two-tuple. See below for an example of subclassing choices using a more complex data type. If a tuple is not provided, or the last item is not a (lazy) string, the label is automatically generated from the member name.

  • К значениям добавляется свойство .label для возврата удобочитаемого имени.

  • A number of custom properties are added to the enumeration classes – .choices, .labels, .values, and .names – to make it easier to access lists of those separate parts of the enumeration. Use .choices as a suitable value to pass to choices in a field definition.

  • Использование enum.unique() принудительно гарантирует, что значения не могут быть определены несколько раз. Этого вряд ли можно ожидать при выборе поля.

Обратите внимание, что использование YearInSchool.SENIOR, YearInSchool['SENIOR'] или YearInSchool('SR') для доступа или поиска членов перечисления работает должным образом, как и свойства .name и .value для этих членов.

If you don’t need to have the human-readable names translated, you can have them inferred from the member name (replacing underscores with spaces and using title-case):

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

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

class Card(models.Model):

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

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

It is also possible to make use of the Enum Functional API with the caveat that labels are automatically generated as highlighted above:

>>> 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')]

Если вам требуется поддержка конкретного типа данных, отличного от int или str, вы можете создать подкласс Choices и требуемый конкретный тип данных, например date для использования с DateField:

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)'

Есть несколько дополнительных предостережений, о которых следует знать:

  • Типы перечислений не поддерживают именованные группы.

  • Поскольку перечисление с конкретным типом данных требует, чтобы все значения соответствовали типу, переопределение пустой метки не может быть достигнуто путем создания элемента со значением None. Вместо этого установите атрибут __empty__ для класса:

    class Answer(models.IntegerChoices):
        NO = 0, _('No')
        YES = 1, _('Yes')
    
        __empty__ = _('(Unknown)')
    
New in Django 3.0:

The TextChoices, IntegerChoices, and Choices classes were added.

db_column

Field.db_column

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

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

db_index

Field.db_index

При True для поля будет создан индекс в базе данных.

db_tablespace

Field.db_tablespace

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

default

Field.default

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

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

def contact_default():
    return {"email": "to1@example.com"}

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

Обратите внимание, lambda нельзя использовать в качестве значения для default т.к. она не может быть сериализована для миграций. Подробности смотрите в соответствующем разделе.

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

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

editable

Field.editable

If False, the field will not be displayed in the admin or any other ModelForm. They are also skipped during model validation. Default is True.

error_messages

Field.error_messages

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

Ключи ошибок такие: null, blank, invalid, invalid_choice, unique и ``unique_for_date`. Дополнительные ошибки указаны для каждого типа поля ниже.

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

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. Убедитесь, что вы экранируете все подсказки, которые могут определять непроверенные пользователи, чтобы избежать XSS атак.

primary_key

Field.primary_key

При True это поле будет первичным ключом.

If you don’t specify primary_key=True for any field in your model, Django will automatically add an AutoField to hold the primary key, so you don’t need to set primary_key=True on any of your fields unless you want to override the default primary-key behavior. For more, see Первичный ключ по умолчанию.

primary_key=True подразумевает null=False и unique=True. Модель может содержать только один первичный ключ.

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

unique

Field.unique

При True значение поля должно быть уникальным.

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

Этот параметр можно использовать для любого типа поля кроме ManyToManyField, OneToOneField и FileField.

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

unique_for_date

Field.unique_for_date

Этот параметр должен быть равен названию DateField или DateTimeField поля, для которого значение должно быть уникальным.

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

Если указать этот параметр для 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

Список проверок(«валидаторов») выполняемых для этого поля. Смотрите раздел о «валидаторах» для подробной информации.

Регистрация и загрузка операторов для фильтрации

Field implements the lookup registration API. The API can be used to customize which lookups are available for a field class, and how lookups are fetched from a field.

Типы полей

AutoField

class AutoField(**options)

Автоинкрементное поле IntegerField. Используется для хранения ID. Скорее всего вам не придется использовать это поле, первичный ключ будет автоматически добавлен к модели. Смотрите Первичный ключ по умолчанию.

AutoField

class BigAutoField(**options)

64-битное целочисленное, аналогично IntegerField но позволяет хранить числа от -9223372036854775808 до 9223372036854775807. Форма будет использовать TextInput для отображения.

BigIntegerField

class BigIntegerField(**options)

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

BinaryField

class BinaryField(max_length=None, **options)

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

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

BinaryField has one extra optional argument:

BinaryField.max_length

The maximum length (in characters) of the field. The maximum length is enforced in Django’s validation using MaxLengthValidator.

Злоупотребление BinaryField

Помните, хранение файлов в базе данных в 99% случаях - это плохой подход. Это поле не замена статическим файлам.

BooleanField

class BooleanField(**options)

Поле хранящее значение true/false.

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

Значение по умолчанию для BooleanField None, если Field.default не указан.

CharField

class CharField(max_length=None, **options)

Строковое поле для хранения коротких или длинных строк.

Для большого количества текстовой информации используйте TextField.

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

CharField has one extra required argument:

CharField.max_length

The maximum length (in characters) of the field. The max_length is enforced at the database level and in Django’s validation using MaxLengthValidator.

Примечание

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

DateField

class DateField(auto_now=False, auto_now_add=False, **options)

Дата, представленная в виде объекта datetime.date Python. Принимает несколько дополнительных параметров:

DateField.auto_now

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

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

DateField.auto_now_add

Значение поля будет автоматически установлено в текущую дату при создании(первом сохранении) объекта. Полезно для хранения времени создания. Заметим, что текущее время будет использовано всегда; это не просто значение по-умолчанию, которое вы можете переопределить. По этому, даже если вы укажите значение для этого поля, оно будет проигнорировано. Если вы хотите изменять значения этого поля, используйте следующее вместо auto_now_add=True:

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

Опции auto_now_add, auto_now и default взаимоисключающие. Использование их вместе вызовет ошибку.

Примечание

При использовании auto_now или auto_now_add со значением True будут установлены параметры editable=False и blank=True.

Примечание

Опции``auto_now`` и auto_now_add всегда используют дату в часовом поясе по умолчанию в момент создания или изменения объекта. Если такое поведение вам не подходит, вы можете указать свою функцию как значение по умолчанию, или переопределить метод save(), вместо использования auto_now или auto_now_add. Или использовать DateTimeField вместо DateField и выполнять преобразование в дату при выводе значения.

DateTimeField

class DateTimeField(auto_now=False, auto_now_add=False, **options)

Дата и время, представленные объектом datetime.datetime Python. Принимает аналогичные параметры что и DateField.

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

DecimalField

class DecimalField(max_digits=None, decimal_places=None, **options)

Десятичное число с фиксированной точностью, представленное объектом Decimal Python. Принимает два обязательных параметра:

Has two required arguments:

DecimalField.max_digits

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

DecimalField.decimal_places

Количество знаков после запятой.

For example, to store numbers up to 999 with a resolution of 2 decimal places, you’d use:

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

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

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

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

Примечание

Для дополнительной информации о разнице между FloatField и DecimalField, смотрите раздел FloatField vs. DecimalField.

DurationField

class DurationField(**options)

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

Примечание

Арифметика над DurationField работает в большинстве случаев. Однако, для всех баз данных, кроме PostgreSQL, арифметическое сравнение DurationField и DateTimeField работает не как ожидается.

EmailField

class EmailField(max_length=254, **options)

Поле CharField для хранения правильного email-адреса. Использует EmailValidator для проверки значения.

FileField

class FileField(upload_to=None, max_length=100, **options)

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

Примечание

primary_key и unique не принимаются, и вызовут исключение TypeError при использовании.

Has two optional arguments:

FileField.upload_to

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

Поддерживает форматирование 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 (с прямыми слэшами), который будет передан в систему хранения файлов(storage). Два аргумента это:

Аргумент

Описание

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)
Changed in Django 3.0:

Support for pathlib.Path was added.

FileField.storage

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

Changed in Django 3.1:

The ability to provide a callable was added.

Виджет форма для этого поля - ClearableFileInput.

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

  1. В вашем файле настроек вам необходимо определить MEDIA_ROOT как полный путь к каталогу, в котором вы хотите, чтобы Django хранил загруженные файлы. (Для повышения производительности эти файлы не сохраняются в базе данных.) Определите MEDIA_URL в качестве базового общедоступного URL-адреса этого каталога. Убедитесь, что этот каталог доступен для записи учетной записи пользователя веб-сервера.

  2. Добавьте FileField или ImageField к модели, определите upload_to, чтобы указать Django в каком подкаталоге в MEDIA_ROOT должны быть сохранены файлы.

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

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

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

Примечание

Процесс сохранения файла – часть процесса сохранения объекта, таким образом имя файла, сохраненного на диске, не будет доступно, пока объект не будет сохранен.

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

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

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

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

FileField и FieldFile

class FieldFile

При доступе к FileField модели, вы получаете экземпляр FieldFile как «proxy» для работы с файлом. Этот класс содержит несколько дополнительных атрибутов и методов для работы с файлом, кроме унаследованных от django.core.files.File:

API FieldFile повторяет API File, с одним ключевым отличием: Объект, обернутый классом, не обязательно является оболочкой встроенного в Python файлового объекта. Вместо этого это оболочка результата метода Storage.open(), который может быть File, или это может быть реализация API File в пользовательском хранилище.

В дополнение к API, унаследованному от File, такому как read() и write(), FieldFile включает в себя несколько методов, которые можно использовать для взаимодействия с базовым файлом:

Предупреждение

Два метода этого класса, save() и delete(), по умолчанию сохраняют объект модели связанного FieldFile в базе данных.

FieldFile.name

Имя файла, включая относительный путь от корня Storage связанного FileField.

FieldFile.path

Свойство, доступное только для чтения, для доступа к пути к локальной файловой системе файла путем вызова метода path() базового Storage класса.

FieldFile.size

Результат базового метода Storage.size().

FieldFile.url

read-only свойство для получения URL вызовом метода url() класса Storage.

FieldFile.open(mode='rb')

Открывает или повторно открывает файл, связанный с этим экземпляром, в указанном режиме. В отличие от стандартного метода Python open(), он не возвращает дескриптор файла.

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

FieldFile.close()

Работает так же как и метод file.close() в Python и закрывает файл связанный с объектом.

FieldFile.save(name, content, save=True)

Этот метод принимает имя файла и содержимое и передает его в экземпляр класса «storage» этого поля, потом добавляет файл в модель. Если вы хотите самостоятельно добавить содержимое файла в поле FileField вашей модели, метод save() то, что вам нужно.

Принимает два аргумента: name – название файла, и content – содержимое файла. Дополнительный аргумент save указывает сохранять ли объект после изменения поля. По-умолчанию True.

Заметим, что аргумент content должен быть экземпляром django.core.files.File, а не встроенный объект файла в Python. Вы можете создать объект File из существующего объекта файла Python:

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")

Подробности в Управление файлами.

FieldFile.delete(save=True)

Удаляет файл связанный с объектом и очищает все атрибуты поля. Заметка: этот метод закрывает файл, если он был открыт во время вызова delete().

Дополнительный аргумент save указывает сохранять ли модель после удаления файла. По-умолчанию True.

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

FilePathField

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

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)
Changed in Django 3.0:

path can now be a callable.

FilePathField.match

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

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

class FloatField(**options)

Число с плавающей точкой представленное объектом float.

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

FloatField или DecimalField

FloatField иногда путают с DecimalField. Хоть оба и представляют вещественные числа, они делают это по разному. FloatField использует тип float в Python, в то время как DecimalField использует тип Decimal. Подробности смотрите в документации Python модуля decimal.

ImageField

class ImageField(upload_to=None, height_field=None, width_field=None, max_length=100, **options)

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

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

To facilitate querying on those attributes, ImageField has two extra optional arguments:

ImageField.height_field

Name of a model field which will be auto-populated with the height of the image each time the model instance is saved.

ImageField.width_field

Name of a model field which will be auto-populated with the width of the image each time the model instance is saved.

Requires the Pillow library.

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

Виджет форма для этого поля - ClearableFileInput.

IntegerField

class IntegerField(**options)

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

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

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

GenericIPAddressField

class GenericIPAddressField(protocol='both', unpack_ipv4=False, **options)

Адрес 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

Определяет формат IP адреса. Принимает значение 'both' (по умолчанию), 'IPv4' или 'IPv6'. Значение не чувствительно регистру.

GenericIPAddressField.unpack_ipv4

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

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

JSONField

class JSONField(encoder=None, decoder=None, **options)
New in Django 3.1.

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

JSONField is supported on MariaDB 10.2.7+, MySQL 5.7.8+, Oracle, PostgreSQL, and SQLite 3.9.0+ (with the JSON1 extension enabled).

JSONField.encoder

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

По умолчанию используется json.JSONEncoder.

JSONField.decoder

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

По умолчанию используется json.JSONDecoder.

If you give the field a default, ensure it’s an immutable object, such as a str, or a callable object that returns a fresh mutable object each time, such as dict or a function. Providing a mutable default object like default={} or default=[] shares the one object between all model instances.

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

Индексирование

Index и Field.db_index оба создают индекс B-дерева, что не особенно полезно при запросе JSONField. Только в PostgreSQL вы можете использовать GinIndex, который лучше подходит.

Пользователи PostgreSQL

PostgreSQL имеет два собственных типа данных на основе JSON: json и jsonb. Основное различие между ними заключается в том, как они хранятся и как их можно запрашивать. Поле json в PostgreSQL хранится как исходное строковое представление JSON и должно декодироваться на лету при запросе на основе ключей. Поле jsonb хранится на основе фактической структуры JSON, что позволяет индексировать. Компромиссом являются небольшие дополнительные затраты на запись в поле jsonb. JSONField использует jsonb.

Пользователи Oracle

База данных Oracle не поддерживает хранение скалярных значений JSON. Поддерживаются только объекты и массивы JSON (представленные в Python с помощью dict и list).

NullBooleanField

class NullBooleanField(**options)

Like BooleanField with null=True.

Не рекомендуется, начиная с версии 3.1: NullBooleanField is deprecated in favor of BooleanField(null=True).

PositiveBigIntegerField

class PositiveBigIntegerField(**options)
New in Django 3.1.

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

PositiveIntegerField

class PositiveIntegerField(**options)

Как и поле IntegerField, но значение должно быть больше или равно нулю (0). Можно использовать значение от 0 до 2147483647. Значение 0 принимается для обратной совместимости.

PositiveSmallIntegerField

class PositiveSmallIntegerField(**options)

Как и поле PositiveIntegerField, но принимает значения в определенном диапазоне(зависит от типа базы данных). Для баз данных поддерживаемых Django можно использовать значения от 0 до 32767.

SlugField

class SlugField(max_length=50, **options)

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

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

Устанавливает Field.db_index в True, если аргумент явно не указан.

Обычно значение SlugField создается на основе какого-то другого значения(например, название статьи). Это может работать автоматически в интерфейсе администрации благодаря параметру prepopulated_fields.

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

SlugField.allow_unicode

При True поле может принимать Unicode символы кроме ASCII. Значение по умолчанию – False.

AutoField

class SmallAutoField(**options)
New in Django 3.0.

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

SmallIntegerField

class SmallIntegerField(**options)

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

TextField

class TextField(**options)

Большое текстовое поле. Форма использует виджет Textarea.

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

TimeField

class TimeField(auto_now=False, auto_now_add=False, **options)

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

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

URLField

class URLField(max_length=200, **options)

Поле CharField для хранения правильного email-адреса. Использует EmailValidator для проверки значения.

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

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

UUIDField

class UUIDField(**options)

A field for storing universally unique identifiers. Uses Python’s UUID class. When used on PostgreSQL, this stores in a uuid datatype, otherwise in a char(32).

UUID является хорошей альтернативой AutoField с 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.

Lookups on PostgreSQL

Using iexact, contains, icontains, startswith, istartswith, endswith, or iendswith lookups on PostgreSQL don’t work for values without hyphens, because PostgreSQL stores them in a hyphenated uuid datatype type.

Поля отношений

Django предоставляет набор полей для определения связей между моделями.

ForeignKey

class ForeignKey(to, on_delete, **options)

A many-to-one relationship. Requires two positional arguments: the class to which the model is related and the on_delete option.

To create a recursive relationship – an object that has a many-to-one relationship with itself – use models.ForeignKey('self', on_delete=models.CASCADE).

If you need to create a relationship on a model that has not yet been defined, you can use the name of the model, rather than the model object itself:

from django.db import models

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

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

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

products/models.py
from django.db import models

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

    class Meta:
        abstract = True
production/models.py
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.

To refer to models defined in another application, you can explicitly specify a model with the full application label. For example, if the Manufacturer model above is defined in another application called production, you’d need to use:

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

This sort of reference, called a lazy relationship, can be useful when resolving circular import dependencies between two applications.

В базе данных автоматом создается индекс для ForeignKey. Можно указать для db_index False, чтобы отключить такое поведение. Это может пригодиться, если внешний ключ используется для согласованности данных, а не объединения(join) в запросах, или вы хотите самостоятельно создать альтернативный индекс или индекс на несколько колонок.

Представление в базе данных

Behind the scenes, Django appends "_id" to the field name to create its database column name. In the above example, the database table for the Car model will have a manufacturer_id column. (You can change this explicitly by specifying db_column) However, your code should never have to deal with the database column name, unless you write custom SQL. You’ll always deal with the field names of your model object.

Параметры

ForeignKey принимает дополнительные аргументы, которые определяют, как должна работать связь.

ForeignKey.on_delete

Когда объект, на который ссылается ForeignKey, удаляется, Django эмулирует поведение SQL правил, указанных в аргументе on_delete. Например, если ваше поле ForeignKey может содержать NULL и вы хотите, чтобы оно устанавливалось в NULL после удаления связанного объекта:

user = models.ForeignKey(
    User,
    models.SET_NULL,
    blank=True,
    null=True,
)

on_delete не создает ограничение SQL в базе данных. Поддержка параметров каскада на уровне базы данных может быть реализована позже.

Возможные значения для on_delete находятся в django.db.models:

  • CASCADE

    Каскадное удаление. Django эмулирует поведение SQL правила ON DELETE CASCADE и так же удаляет объекты, связанные через ForeignKey.

    Model.delete() не вызывается для связанных моделей, но сигналы pre_delete и post_delete отправляются для всех удаленных объектов.

  • PROTECT

    Препятствует удалению связанного объекта вызывая исключение django.db.models.ProtectedError`(подкласс :exc:`django.db.IntegrityError).

  • RESTRICT
    New in Django 3.1.

    Предотвратите удаление объекта, на который указывает ссылка, вызвав RestrictedError (подкласс django.db.IntegrityError). В отличие от PROTECT, удаление объекта, на который указывает ссылка, разрешено, если он также ссылается на другой объект, который удаляется в той же операции, но через отношение CASCADE.

    Рассмотрим этот набор моделей:

    class Artist(models.Model):
        name = models.CharField(max_length=10)
    
    class Album(models.Model):
        artist = models.ForeignKey(Artist, on_delete=models.CASCADE)
    
    class Song(models.Model):
        artist = models.ForeignKey(Artist, on_delete=models.CASCADE)
        album = models.ForeignKey(Album, on_delete=models.RESTRICT)
    

    Artist can be deleted even if that implies deleting an Album which is referenced by a Song, because Song also references Artist itself through a cascading relationship. For example:

    >>> artist_one = Artist.objects.create(name='artist one')
    >>> artist_two = Artist.objects.create(name='artist two')
    >>> album_one = Album.objects.create(artist=artist_one)
    >>> album_two = Album.objects.create(artist=artist_two)
    >>> song_one = Song.objects.create(artist=artist_one, album=album_one)
    >>> song_two = Song.objects.create(artist=artist_one, album=album_two)
    >>> album_one.delete()
    # Raises RestrictedError.
    >>> artist_two.delete()
    # Raises RestrictedError.
    >>> artist_one.delete()
    (4, {'Song': 2, 'Album': 1, 'Artist': 1})
    
  • SET_NULL

    Устанавливает ForeignKey в NULL; возможно только если null равен True.

  • SET_DEFAULT

    Устанавливает ForeignKey в значение по умолчанию; значение по-умолчанию должно быть указано для ForeignKey.

  • SET()

    Set the ForeignKey to the value passed to SET(), or if a callable is passed in, the result of calling it. In most cases, passing a callable will be necessary to avoid executing queries at the time your models.py is imported:

    from django.conf import settings
    from django.contrib.auth import get_user_model
    from django.db import models
    
    def get_sentinel_user():
        return get_user_model().objects.get_or_create(username='deleted')[0]
    
    class MyModel(models.Model):
        user = models.ForeignKey(
            settings.AUTH_USER_MODEL,
            on_delete=models.SET(get_sentinel_user),
        )
    
  • DO_NOTHING

    Ничего не делать. Если используемый тип базы данных следит за целостностью связей, будет вызвано исключение IntegrityError, за исключением, когда вы самостоятельно добавите SQL правило ON DELETE для поля таблицы.

ForeignKey.limit_choices_to

Ограничивает доступные значения для поля при создании ModelForm или в админке (по умолчанию можно выбрать любой объект связанной модели). Можно передать словарь, объект Q или функцию, которая возвращает словарь или объект Q.

Например:

staff_member = models.ForeignKey(
    User,
    on_delete=models.CASCADE,
    limit_choices_to={'is_staff': True},
)

указывает полю ModelForm показывать только объекты Users, которые соответствуют is_staff=True. Может быть полезно в админке.

Указание функции может быть полезно, если используется объект Python datetime для фильтрации. Например:

def limit_pub_date_choices():
    return {'pub_date__lte': datetime.date.utcnow()}

limit_choices_to = limit_pub_date_choices

Вместо словаря можете использовать объект Q или функцию, которая возвращает такой объект, для создания сложных запросов. Однако, если limit_choices_to объект Q, он будет использован в интерфейсе администратора, только если поле не находится в raw_id_fields класса ModelAdmin для этой модели.

Примечание

Если используется функция для limit_choices_to, она будет вызываться при каждом создании формы. Также она может быть вызвана при валидации модели, например, командой или админкой. Админка может вызывать эту функцию несколько раз при проверке данных.

ForeignKey.related_name

Название, используемое для обратной связи от связанной модели. Также значение по умолчанию для related_query_name (название обратной связи используемое при фильтрации результата запроса). Ищите подробности и примеры в разделе о связанных объектах. Заметим, что вы должны определить этот параметр для поля в абстрактной модели; при этом можно использовать некоторые дополнительные возможности.

Если вы не хотите, чтобы Django создавал обратную связь, установите related_name в '+' или добавьте в конце '+'. Например, такой код создаст связь, но не добавит обратную связь в модель User:

user = models.ForeignKey(
    User,
    on_delete=models.CASCADE,
    related_name='+',
)
ForeignKey.related_query_name

Название обратной связи используемое при фильтрации результата запроса. По умолчанию используется related_name, или название модели:

# Declare the ForeignKey with related_query_name
class Tag(models.Model):
    article = models.ForeignKey(
        Article,
        on_delete=models.CASCADE,
        related_name="tags",
        related_query_name="tag",
    )
    name = models.CharField(max_length=255)

# That's now the name of the reverse filter
Article.objects.filter(tag__name="important")

Как и related_name, `` linked_query_name`` поддерживает интерполяцию меток приложения и классов с помощью некоторого специального синтаксиса.

ForeignKey.to_field

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

ForeignKey.db_constraint

Указывает создавать ли «constraint» для внешнего ключа в базе данных. По умолчанию True и в большинстве случает это то, что вам нужно. Указав False вы рискуете целостностью данных. Некоторые ситуации, когда вам может быть это необходимо:

  • Вам досталась в наследство нецелостная база данных

  • Вы используете шардинг базы данных.

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

ForeignKey.swappable

Управляет поведением миграций, если ForeignKey ссылается на подменяемую(swappable) модель. При True - значение по умолчанию - если ForeignKey ссылается на модель, указанную через settings.AUTH_USER_MODEL (или другую настройку, определяющую какую модель использовать), связь в миграции будет использовать настройку, а не саму модель.

You only want to override this to be False if you are sure your model should always point towards the swapped-in model - for example, if it is a profile model designed specifically for your custom user model.

Указав False, вы не сможете ссылаться на подменяемую модель даже после того, как её подменили. False означает, что миграция, содержащая этот ForeignKey, будет указывать на конкретную модель, которую вы укажите (и пользователь вашего приложения получит ошибку, если попытается выполнить с моделью User, которую вы не поддерживаете, например).

Если вы не уверены какое значение выбрать, используйте значение по умолчанию True.

ManyToManyField

class ManyToManyField(to, **options)

Связь многие-ко-многим. Принимает позиционный аргумент: класс связанной модели. Работает так же как и ForeignKey, включая рекурсивную и ленивую связь.

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

Представление в базе данных

Django самостоятельно создаст промежуточную таблицу для хранения связи многое-ко-многим. По-умолчанию, название этой таблицы создается из названия поля и связанной модели. Так как некоторые базы данных не поддерживают длинные названия таблиц, оно будет обрезано до 64 символов и будет добавлен уникальный хеш. Это означает что вы можете увидеть такие названия таблиц author_books_9cdf4; это нормально. Вы можете указать название промежуточной таблицы, используя параметр db_table.

Параметры

ManyToManyField принимает дополнительные аргументы – все не обязательны – которые определяют как должна работать связь.

ManyToManyField.related_name

Аналогично ForeignKey.related_name.

ManyToManyField.related_query_name

Аналогично ForeignKey.related_query_name.

ManyToManyField.limit_choices_to

Аналогично ForeignKey.limit_choices_to.

limit_choices_to has no effect when used on a ManyToManyField with a custom intermediate table specified using the through parameter.

ManyToManyField.symmetrical

Используется только при рекурсивной связи. Например, есть модель:

from django.db import models

class Person(models.Model):
    friends = models.ManyToManyField("self")

Загружая эту модель Django определяет, что она содержит ManyToManyField указывающее на себя, и не добавляет атрибут person_set классу модели Person. Вместо этого подразумевается, что :class:`ManyToManyField`симметрично – то есть, если я твой друг, то и ты мне друг.

Если вам не нужна симметричность для связи многое-ко-многим к self, установите symmetrical в False. Это заставит Django добавить дескриптор для обратной связи, позволяя ManyToManyField быть не симметричным.

Changed in Django 3.0:

Specifying symmetrical=True for recursive many-to-many relationships using an intermediary model was allowed.

ManyToManyField.through

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

Обычно используют для хранения дополнительных данных.

Примечание

Если вы не хотите иметь несколько ассоциаций между одними и теми же экземплярами, добавьте UniqueConstraint, включая поля from и to. Автоматически генерируемые Django таблицы «многие-ко-многим» включают такое ограничение.

Примечание

Рекурсивные отношения, использующие промежуточную модель, не могут определять имена обратных методов доступа, поскольку они будут одинаковыми. Вам необходимо установить related_name хотя бы для одного из них. Если вы предпочитаете, чтобы Django не создавал обратное отношение, установите для параметра linked_name значение '+'.

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

Если связанные модели разные, создаются следующие поля:

  • id: первичный ключ для связи.

  • <containing_model>_id: id модели, которая содержит поле ManyToManyField.

  • <other_model>_id: id модели, на которую ссылается ManyToManyField.

Если ManyToManyField ссылается на одну и ту же модель, будут созданы поля:

  • id: первичный ключ для связи.

  • from_<model>_id: id объекта основной модели (исходный объект).

  • to_<model>_id: id объекта, на который указывает связь (целевой объект).

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

Model.m2mfield.through.objects.all()
ManyToManyField.through_fields

Используется, если явно указана промежуточная модель для связи многое-ко-многим. Обычно Django самостоятельно определяется какие поля использовать для создания связи. Однако, возьмем такой пример:

from django.db import models

class Person(models.Model):
    name = models.CharField(max_length=50)

class Group(models.Model):
    name = models.CharField(max_length=128)
    members = models.ManyToManyField(
        Person,
        through='Membership',
        through_fields=('group', 'person'),
    )

class Membership(models.Model):
    group = models.ForeignKey(Group, on_delete=models.CASCADE)
    person = models.ForeignKey(Person, on_delete=models.CASCADE)
    inviter = models.ForeignKey(
        Person,
        on_delete=models.CASCADE,
        related_name="membership_invites",
    )
    invite_reason = models.CharField(max_length=64)

Membership содержит два внешних ключа на Person (person и inviter). В таком случае Django не знает какой ключ использовать для создания связи. В таком случае необходимо явно указать Django, какой внешний ключ правильный, используя параметр through_fields, как в примере выше.

through_fields принимает двух-элементный кортеж ('field1', 'field2'), где field1 – название внешнего ключа, который ссылается на модель, которая содержит ManyToManyField (в нашем примере group), а field2 – внешний ключ, который ссылается на целевую модель (в нашем примере person).

Если промежуточная модель содержит несколько внешний ключей на одну из моделей связи (или обе модели), вы должны указать through_fields. Это также относится и к рекурсивной связи, если используется своя промежуточная модель, в которой больше двух связей на модель, или вы хотите явно указать Django, какие внешние ключи использовать.

ManyToManyField.db_table

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

ManyToManyField.db_constraint

Указывает создавать ли «constraint» для внешних ключей в промежуточной таблице в базе данных. По умолчанию True и в большинстве случает это то, что вам нужно. Указав False вы рискуете целостностью данных. Некоторые ситуации, когда вам может быть это необходимо:

  • Вам досталась в наследство нецелостная база данных

  • Вы используете шардинг базы данных.

Нельзя указать db_constraint и through одновременно.

ManyToManyField.swappable

Управляет поведением миграций, если ManyToManyField ссылается на подменяемую(swappable) модель. При True - значение по умолчанию - если ManyToManyField ссылается на модель, указанную через settings.AUTH_USER_MODEL (или другую настройку, определяющую какую модель использовать), связь в миграции будет использовать настройку, а не саму модель.

You only want to override this to be False if you are sure your model should always point towards the swapped-in model - for example, if it is a profile model designed specifically for your custom user model.

Если вы не уверены какое значение выбрать, используйте значение по умолчанию True.

ManyToManyField не поддерживает validators.

null не влияет на работу поля т.к. нет способа сделать связь обязательной на уровне базы данных.

OneToOneField

class OneToOneField(to, on_delete, parent_link=False, **options)

Связь один-к-одному. Работает так же, как и ForeignKey с unique=True, но «обратная» связь возвращает один объект.

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

Принимает обязательный позиционный аргумент: класс связанной модели. Работает так же как и 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',
    )

your resulting User model will have the following attributes:

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

A RelatedObjectDoesNotExist exception is raised when accessing the reverse relationship if an entry in the related table doesn’t exist. This is a subclass of the target model’s Model.DoesNotExist exception. For example, if a user doesn’t have a supervisor designated by MySpecialUser:

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

Также OneToOneField принимает все дополнительные параметры принимаемые ForeignKey, и еще один дополнительный:

При True и связанной модели, которая наследуется от другой модели, определяет, что должна сохраняться связь на родительскую модель, а не поле OneToOneField дочерней модели, которое используется для организации наследования моделей.

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

Справочник по полям модели

class Field

Field – абстрактный класс, отображающий колонку в таблице в базе данных. Django используется поля для создания таблицы в базе данных (db_type()), для преобразования типов Python в типа в базе данных (get_prep_value()) и наоборот (from_db_value()), и для применения Справочник по API поиска (get_prep_lookup()).

Таким образом поле является фундаментальной частью различных API Django, в частности, models и querysets.

В модели экземпляр поля добавляется как атрибут класса и представляет определенное поле таблицы, смотрите Модели. Оно содержит атрибуты, такие как null и unique, и методы, которые Django используется для преобразования значения поля в значение в базе данных.

Field – дочерний класс RegisterLookupMixin, что позволяет регистрировать Transform и Lookup, чтобы использовать в QuerySet (например, field_name__exact="foo"). Все встроенные фильтры зарегистрированы по умолчанию.

Все встроенные поля Django, например CharField, наследуются от Field. Если вы хотите создать свое поле, можно унаследоваться от любого встроенного поля, или от Field. Подробности смотрите в Writing custom model fields.

description

Читабельное описание поля, например, для приложения django.contrib.admindocs.

Может использовать форматирование:

description = _("String (up to %(max_length)s)")

Аргументы будут подставляется из значений __dict__ поля.

descriptor_class
New in Django 3.0.

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

Для преобразования типа Field в тип базы данных Django используется два метода:

get_internal_type()

Возвращает текстовое название типа поля для использования в бэкендах баз данных. По умолчанию возвращает название класса.

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

db_type(connection)

Возвращает тип поля в базе данных Field, учитывая connection.

Смотрите Кастомные типы полей базы данных, как использовать в собственных полях модели.

rel_db_type(connection)

Возвращает тип поля в базе данных Field, учитывая connection.

Смотрите Кастомные типы полей базы данных, как использовать в собственных полях модели.

Существует три основных ситуации, когда Django используется преобразование типа поля:

  • при запросе как базе данных (значение Python -> значение бэкенда базы данных)

  • при загрузке данных из базы данных (значение бэкенда базы данных -> значение Python)

  • при сохранении в базу данных (значение Python -> значение бэкенда базы данных)

При запросе используются методы get_db_prep_value() и get_prep_value():

get_prep_value(value)

value – значение атрибута поля модели. Метод должен вернуть значение, которое можно использовать как параметр в запросе.

Смотрите Преобразование объектов Python в значения в запросе.

get_db_prep_value(value, connection, prepared=False)

Преобразует value в значение для бэкенда базы данных. По умолчанию возвращает value, если prepared=True, иначе – результат get_prep_value().

Смотрите Преобразование значения из запроса в значение базы данных.

При загрузке данных используется from_db_value():

from_db_value(value, expression, connection)

Преобразует значение из базы данных в объект Python. Метод обратный get_prep_value().

Для большинства встроенных полей этот метод не используется т.к. бэкенд базы данных возвращает уже правильный объект Python, или же бэкенд сам выполняет необходимые преобразования.

выражение — то же самое, что и self.

Смотрите Преобразование значений базы данных в объекты Python.

Примечание

Для повышения производительности поля, которые не используют from_db_value, не содержат пустую реализацию этого метода (все поля Django). По этому нет необходимости вызывать super в вашем методе.

При сохранении используются методы pre_save() и get_db_prep_save():

get_db_prep_save(value, connection)

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

pre_save(model_instance, add)

Метод вызывается перед get_db_prep_save(), чтобы подготовить значение перед сохранением (например, при DateField.auto_now).

model_instance – объект модели, к которому принадлежит поле, add – указывает сохраняется ли объект первый раз в базу данных.

Должен вернуть значение соответствующего этому полю атрибута model_instance. Название атрибута можно получить из self.attname (устанавливается Field).

Смотрите Обработка данных перед сохранением.

Поля часто принимает значения разных типов из сериализатора, или формы

to_python(value)

Преобразует значение в правильный объект Python. Выполняет действия обратные value_to_string(), и вызывается в clean().

Смотрите Преобразование значений базы данных в объекты Python.

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

value_from_object(obj)

Возвращает значение поля для данного экземпляра модели.

Этот метод часто используется value_to_string().

value_to_string(obj)

Преобразует obj в строку. Используется при сериализации значения поля.

Смотрите Преобразование значения поля для сериалайзера.

При использовании django.forms.ModelForm Field должно указать, какое поле формы необходимо использовать для его представления в форме:

formfield(form_class=None, choices_form_class=None, **kwargs)

Возвращает django.forms.Field поля модели для ModelForm.

По умолчанию, если form_class и choices_form_class равны None, возвращает CharField. Если указан choices_form_class, вернет TypedChoiceField.

Смотрите Определение поля формы для поля модели.

deconstruct()

Возвращает 4-х элементный кортеж с информацией, как воссоздать поле:

  1. Название поля в модели.

  2. Путь для импорта класса поля (например, "django.db.models.IntegerField"). Должен возвращаться максимально переносимый между платформами и версиями вариант.

  3. Список позиционных аргументов.

  4. Словарь именованных аргументов.

Этот метод должен быть добавлен полям, созданным до 1.7, для использования Миграции.

Атрибуты поля

Каждый экземпляр Field содержит атрибуты, определяющие поведение поля. Используйте эти атрибуты вместо проверки isinstance, если вам необходимо написать код, который зависит от поведения поля. Эти атрибуты можно использовать совместно с Model._meta API, чтобы проверять поля конкретного типа. Собственные поля модели должны определять эти атрибуты.

Атрибуты поля

Field.auto_created

Флаг, который указывает было ли поле создано автоматически, например OneToOneField при наследовании моделей.

Field.concrete

Флаг, который указывает представлено ли поле колонкой в таблице в базе данных.

Field.hidden

Boolean flag that indicates if a field is used to back another non-hidden field’s functionality (e.g. the content_type and object_id fields that make up a GenericForeignKey). The hidden flag is used to distinguish what constitutes the public subset of fields on the model from all the fields on the model.

Примечание

Options.get_fields() excludes hidden fields by default. Pass in include_hidden=True to return hidden fields in the results.

Field.is_relation

Флаг, который указывает, ссылается ли поле на другие модели (например, ForeignKey, ManyToManyField, OneToOneField, и т.д.).

Field.model

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

Атрибуты связывающих полей

Атрибуты, определяющие связь поля. Эти атрибуты присутствуют во всех полях, однако, только для связывающих полей(Field.is_relation=True) они содержат булевы значения(а не None).

Field.many_to_many

Флаг, который содержит True, если поле содержит связь многие-ко-многим, иначе False. Единственное поле Django, которое содержит True – это ManyToManyField.

Field.many_to_one

Флаг, который содержит True, если поле содержит связь многие-к-одному, такие как ForeignKey, иначе False.

Field.one_to_many

Флаг, который содержит True, если поле содержит связь один-ко-многим, такие как GenericRelation или обратная связь ForeignKey, иначе False.

Field.one_to_one

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

Field.related_model

Указывает на модель, на которую ссылается поле. Например, Author в ForeignKey(Author, on_delete=models.CASCADE). Если поле содержит связь с несколькими объектами (такие как GenericForeignKey или GenericRelation) тогда related_model будет None.

Back to Top