Этот раздел содержит все существующие подробности о всех параметрах поля и типах полей в Django.
См.также
Если существующие поля не предоставляют необходимого функционала, вы можете поискать в localflavor, который содержит дополнительный функционал полезный для различных стран. Также вы можете легко создать собственное поле для модели.
Примечание
Технически, эти поля определенны в django.db.models.fields, но для удобства они импортированы в django.db.models; по неписанному соглашению принято использовать from django.db import models и обращаться к полям, как models.<Foo>Field.
Приведенные аргументы доступны для всех полей. Все они не обязательны.
При True Django сохранит пустое значение как NULL в базе данных. Значение по умолчанию – False.
Заметим, что пустая строка всегда сохраняется как пустая строка, а не как NULL. Используйте null=True только для не строковых полей, таких как числовые, булевы и даты. Для всех типов полей, вы также должны указать blank=True если вы хотите разрешить пустые значения в формах, т.к. параметр null влияет только на сохранение в базе данных (смотрите blank).
Избегайте использования null для строковых полей таких, как CharField и TextField, если только у вас нет причин для этого. Если строковое поле содержит null=True, это означает, что оно может содержать два возможных “пустых” значения: NULL и пустую строку. В большинстве случаев избыточно иметь два варианты “пустых” значений. Правило Django использовать пустую строку, вместо NULL.
Примечание
При использовании Oracle, NULL будет использоваться для пустой строки независимо от значения этого параметра.
Если хотите использовать null для BooleanField, используйте NullBooleanField вместо этого.
При True поле может быть пустым. Значение по умолчанию – False.
Заметим что этот параметр отличается от null. null указывается для базы данных, в то время как blank – для проверки данных. При blank=True, проверка данных в форме позволит сохранять пустое значение в поле. При blank=False поле будет обязательным.
Итератор (например, список или кортеж) двухэлементных кортежей(например, [(A, B), (A, B) ...]), который будет использоваться как варианты значений для поля. Если этот параметр указан, в форме будет использоваться select для этого поля.
Первый элемент – это значение, которое будет сохранено в базе данных. Второй элемент – название, которое будет отображаться для пользователей. Например:
YEAR_IN_SCHOOL_CHOICES = (
('FR', 'Freshman'),
('SO', 'Sophomore'),
('JR', 'Junior'),
('SR', 'Senior'),
)
Значения лучше указать в константах внутри модели:
from django.db import models
class Student(models.Model):
FRESHMAN = 'FR'
SOPHOMORE = 'SO'
JUNIOR = 'JR'
SENIOR = 'SR'
YEAR_IN_SCHOOL_CHOICES = (
(FRESHMAN, 'Freshman'),
(SOPHOMORE, 'Sophomore'),
(JUNIOR, 'Junior'),
(SENIOR, 'Senior'),
)
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 в примере выше).
Для каждой модели с полем содержащим choices, Django добавляет метод для получения названия текущего значения поля. Смотрите get_FOO_display() в документации про API для работы с базой данных.
Отметим что в качестве списка вариантов значений может быть любой итератор – не обязательно список или кортеж. Это позволяет определять варианты значений динамически. Но, если вам необходимо использовать динамический choices, возможно вам следует использовать правильную структуру таблицы базы данных с ForeignKey. choices предназначен для статических данных, которые почти или вообще не изменяются.
Имя колонки в базе данных для хранения данных этого поля. Если этот параметр не указан, Django будет использовать название поля.
Если имя колонки это зарезервированное SQL слово, или содержит символы запрещенные в названиях переменной в Python – в частности, дефис – все нормально. Django автоматически экранирует название колонок и таблиц.
Имя “tablespace” базы данных используемое для индекса поля, если поле имеет индекс. По-умолчанию используется значение настройки DEFAULT_INDEX_TABLESPACE проекта, если оно указано, иначе db_tablespace модели. Если база данных не поддерживает “tablespace” для индексов, этот параметр будет проигнорирован.
Значение по умолчанию для поля. Это может быть значение или вызываемый(callable) объект. Если это вызываемый объект, он будет вызван при создании нового объекта.
Значение по умолчанию не может быть изменяемым значением (экземпляр модели, список и т.д.), т.к. все объекты модели будут ссылаться на этот объект. Вместо этого укажите функцию, которая возвращает нужное значение. Например, если у вас есть собственное поле JSONField и вы хотите указать словарь как значение по умолчанию, используйте lambda следующим образом:
contact_info = JSONField("ContactInfo", default=lambda:{"email": "to1@example.com"})
При False, поле будет не редактируемое в ModelForm для модели. Значение по умолчанию – True.
error_messages позволяет переопределить сообщения ошибок возвращаемых полем. Используйте словарь с ключами соответствующими необходимым ошибкам.
Ключи ошибок такие: null, blank, invalid, invalid_choice и unique. Дополнительные ошибки указаны для каждого типа поля ниже.
Подсказка, отображаемая под полем в интерфейсе администратора. Это полезно для описания поля, даже если модель не используется в форме.
Заметим, что, при отображении в форме, HTML-символы не экранируются. Это позволяет использовать HTML в help_text если вам необходимо. Например:
help_text="Please use the following format: <em>YYYY-MM-DD</em>."
Также вы можете использовать обычный текст и django.utils.html.escape(), чтобы экранировать HTML.
При True это поле будет первичным ключом.
Если вы не укажите primary_key=True для какого-либо поля в модели, Django самостоятельно добавит AutoField для хранения первичного ключа, вы не обязаны указывать primary_key=True, если не хотите переопределить первичный ключ по умолчанию. Подробнее смотрите Первичный ключ по умолчанию.
primary_key=True подразумевает null=False и unique=True. Модель может содержать только один первичный ключ.
При True значение поля должно быть уникальным.
Этот параметр учитывается при сохранении в базу данных и при проверке данных в модели. Если вы попытаетесь сохранить повторное значение в поле с unique, будет вызвана ошибка django.db.IntegrityError методом save().
Этот параметр можно использовать для любого типа поля кроме ManyToManyField, OneToOneField и FileField.
Заметим что, при unique равном True, не нужно указывать db_index, т.к. unique создает индекс.
Этот параметр должен быть равен названию 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_date, но значение будет уникально для месяца.
Отображаемое имя поля. Если параметр не указан, Django самостоятельно создаст его используя имя атрибута поля, заменяя нижнее подчеркивание на пробелы. Смотрите раздел про отображаемые имена полей.
Список проверок(“валидаторов”) выполняемых для этого поля. Смотрите раздел о “валидаторах” для подробной информации.
Автоинкрементное поле IntegerField. Используется для хранения ID. Скорее всего вам не придется использовать это поле, первичный ключ будет автоматически добавлен к модели. Смотрите Первичный ключ по умолчанию.
64-битное целочисленное, аналогично IntegerField но позволяет хранить числа от -9223372036854775808 до 9223372036854775807. Форма будет использовать <input type="text"> (одно строчное поле ввода) для отображения.
Поля для хранения бинарных данных. Принимает значение типа bytes. Это поле имеет ограниченный функционал. Например, QuerySet нельзя фильтровать по значению BinaryField.
Abusing BinaryField
Помните, хранение файлов в базе данных в 99% случаях - это плохой подход. Это поле не замена статическим файлам.
Поле хранящее значение true/false.
Виджет по умолчанию для этого поля CheckboxInput.
Если вам нужен параметр null, используйте поле NullBooleanField.
The default value of BooleanField was changed from False to None when Field.default isn’t defined.
Строковое поле для хранения коротких или длинных строк.
Для большого количества текстовой информации используйте TextField.
Виджет по умолчанию для этого поля TextInput.
CharField принимает один дополнительный аргумент:
Максимальная длинна(в символах) этого поля. max_length используется для проверки данных на уровне базы данных и форм Django.
Примечание
Если вы создаете независимое приложение, которое должно работать на различных базах данных, помните что существуют некоторые ограничения использования max_length для некоторых типов баз данных. Смотрите раздел про использование различных типов баз данных.
MySQL users
Если вы используете это поле с MySQLdb 1.2.2 и utf8_bin “collation” (которое не является значением по умолчанию), могут быть некоторые проблемы. Смотрите советы при работе с MySQL для подробностей.
Поле содержащее целые числа разделенные запятыми. Как и в CharField, необходим параметр max_length. Упомянутые особенности работы с различными типами баз данных актуальны.
Дата, представленная в виде объекта datetime.date Python. Принимает несколько дополнительных параметров:
Значение поля будет автоматически установлено в текущую дату при каждом сохранении объекта. Полезно для хранения времени последнего изменения. Заметим, что текущее время будет использовано всегда; это не просто значение по умолчанию, которое вы можете переопределить.
Значение поля будет автоматически установлено в текущую дату при создании(первом сохранении) объекта. Полезно для хранения времени создания. Заметим, что текущее время будет использовано всегда; это не просто значение по-умолчанию, которое вы можете переопределить.
В форме поле будет представлено как :class:`~django.forms.TextInput с JavaScript календарем, и кнопкой “Сегодня”. Содержит дополнительную ошибку invalid_date.
Примечание
При использовании auto_now или auto_now_add со значением True будут установлены параметры editable=False и blank=True.
Дата и время, представленные объектом datetime.datetime Python. Принимает аналогичные параметры что и DateField.
Виджет по умолчанию в форме для этого поля - TextInput. Интерфейс администратора использует два виджета TextInput и JavaScript.
Десятичное число с фиксированной точностью, представленное объектом Decimal Python. Принимает два обязательных параметра:
Максимальное количество цифр в числе. Заметим, что это число должно быть больше или равно decimal_places.
Количество знаков после запятой.
Например, для хранения числа до 999 с двумя знаками после запятой, используйте:
models.DecimalField(..., max_digits=5, decimal_places=2)
Для хранения числа до миллиарда и 10 знаков после запятой:
models.DecimalField(..., max_digits=19, decimal_places=10)
Виджет по умолчанию для этого поля TextInput.
Примечание
Для дополнительной информации о разнице между FloatField и DecimalField, смотрите раздел FloatField vs. DecimalField.
Поле CharField для хранения правильного email-адреса.
Incompliance to RFCs
Значение max_length в 75 символов не достаточно для хранения всех возможных значений в соответствии RFC3696/5321. Для хранения всех возможных вариантов необходимо значение max_length в 254. Значение в 75 символов сложилось исторически и не изменяется для обратной совместимости.
Поле для загрузки файла.
Примечание
primary_key и unique не принимаются, и вызовут исключение TypeError при использовании.
Принимает один обязательный параметр:
Путь в файловой системе относительный настройке MEDIA_ROOT для определения url.
Поддерживает форматирование strftime(), которое будет заменено на дату/время загруженного файла (и загружаемые файлы не заполнят один каталог).
Также принимается вызываемый объект, такой как функция, который будет вызван для получения пути к загруженному файлу, включая имя файла. Вызываемый объект должен принимать два обязательных аргумента, и возвращать путь в стиле Unix (с прямыми слэшами), который будет передан в систему хранения файлов(storage). Два аргумента это:
Аргумент |
Описание |
|---|---|
| instance | Экземпляр модели, для которой определено поле FileField. Точнее, это объект для которого сохраняется текущий файл. В большинстве случаев объект еще не будет сохранен в базу данных, и при использовании AutoField, первичный ключ объекта может быть пустым. |
| filename | Оригинальное имя файла. Вы можете его учитывать, или проигнорировать, при определении окончательного пути к файлу. |
Также принимается один дополнительный параметр:
Необязателен. Объект “storage”, который отвечает за хранение и получение файлов. Смотрите Управление файлами для подробной информации.
Виджет форма для этого поля - FileInput.
Использование FileField или ImageField (смотрите ниже) требует некоторых дополнительных действий:
В файле настроек необходимо определить MEDIA_ROOT, как полный путь к каталогу, куда Django должен сохранять файлы. (Для повышения производительности файлы не хранятся в базе данных.) Определить MEDIA_URL, который является URL-ом к этому каталогу и используется для создания URL-а к файлу. Убедитесь, что пользователь, от которого работает сервер, имеет права записи в этот каталог.
Добавьте FileField или ImageField к модели, убедитесь что определили upload_to, чтобы указать DJango в каком под-каталоге в MEDIA_ROOT должны быть сохранены файлы.
Все, что будет сохранено в базе данных, это путь к файлу (относительно 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(100) в базе данных. Как и с другими полями, вы можете изменить максимальную длину, используя аргумент max_length.
При доступе к FileField модели, вы получаете экземпляр FieldFile как “proxy” для работы с файлом. Этот класс содержит несколько методов для работы с файлом:
read-only свойство для получения URL вызовом метода url() класса Storage.
Работает так же как и родной метод Python open(), открывает файл связанный с объектом в режиме определенном аргументом mode.
Работает так же как и метод file.close() в Python и закрывает файл связанный с объектом.
Этот метод принимает имя файла и содержимое и передает его в экземпляр класса “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('/tmp/hello.world')
myfile = File(f)
Или же создать из строки с содержимым файла:
from django.core.files.base import ContentFile
myfile = ContentFile("hello world")
Подробности в Управление файлами.
Удаляет файл связанный с объектом и очищает все атрибуты поля. Заметка: этот метод закрывает файл, если он был открыт во время вызова delete().
Дополнительный аргумент save указывает сохранять ли модель после удаления файла. По-умолчанию – True.
Обратите внимание, когда объект модели удаляется, связанные файлы не удаляются. Если вам необходимо удалять их, делайте это самостоятельно (например, используя команду запущенную через cron).
Поле CharField значение которого ограничено именем файла из определенного каталога. Принимает три дополнительных аргумента, первый из них обязателен:
Обязательно. Абсолютный путь к каталогу, из которого FilePathField принимает значение. Например: "/home/images".
Необязательный. Регулярное выражение как строка, которое FilePathField использует как фильтр названий. Регулярное выражение применяется к названию файла, а не к полному пути. Например: "foo.*\.txt$", соответствует foo23.txt но отфильтрует bar.txt или foo23.gif.
Необязательный. Принимает True или False. По-умолчанию False. Определяет должны ли быть включены подкаталоги path.
Необязательный. Принимает True или False. По-умолчанию True. Определяет должны ли быть включены указанные подкаталоги. Этот параметр или allow_folders должен быть True.
Необязательный. Принимает 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.
Число с плавающей точкой представленное объектом float.
Виджет по умолчанию для этого поля TextInput.
FloatField vs. DecimalField
FloatField иногда путают с DecimalField. Хоть оба и представляют вещественные числа, они делают это по разному. FloatField использует тип float в Python, в то время как DecimalField использует тип Decimal. Подробности смотрите в документации Python модуля decimal.
Наследует все атрибуты и методы поля FileField, но также проверяет является ли загруженный файл изображением.
В дополнение к атрибутам поля FileField ImageField содержит также height и width.
Для определения этих аргументов ImageField принимает дополнительные аргументы:
Имя поля, которому автоматически будет присвоено значение высоты изображения при каждом сохранении объекта.
Имя поля, которому автоматически будет присвоено значение ширины изображения при каждом сохранении объекта.
Требуется Python Imaging Library.
По-умолчанию, экземпляр ImageField создается как колонка varchar(100) в базе данных. Как и с другими полями вы можете изменить максимальную длину используя аргумент max_length.
IP адрес в виде строки(например, “192.0.2.30”). Форма использует виджет TextInput.
Адрес IPv4 или IPv6 в виде строки (например, 192.0.2.30 или 2a02:42fe::4). Форма использует виджет TextInput.
Преобразование адреса IPv6 происходит в соответствии с RFC 4291 раздел 2.2, включая рекомендации по форматированию IPv4 в параграфа 3 этого раздела, таких как ::ffff:192.0.2.0. Например, 2001:0::0:01 будет преобразован 2001::1, а ::ffff:0a0a:0a0a в ::ffff:10.10.10.10. Все символы будут преобразованы в нижний регистр.
Определяет формат IP адреса. Принимает значение 'both' (по умолчанию), 'IPv4' или 'IPv6'. Значение не чувствительно регистру.
Преобразует адрес IPv4. Если эта опция установлена, адрес ::ffff::192.0.2.1 будет преобразован в 192.0.2.1. По-умолчанию отключена. Может быть использовано, если protocol установлен в 'both'.
Если вы разрешили пустые значение, необходимо также разрешить null т.к. пустые значения сохраняются как null.
Как и BooleanField, но принимает значение NULL. Используете его вместо BooleanField с null=True. Форма использует виджет NullBooleanSelect.
Как и поле IntegerField, но значение должно быть больше или равно нулю (0). Значение 0 принимается для обратной совместимости.
Как и поле PositiveIntegerField, но принимает значения в определенном диапазоне(зависит от типа базы данных). Для баз данных поддерживаемых Django можно использовать значения до 32767.
Slug – газетный термин. “Slug” – это короткое название-метка, которое содержит только буквы, числа, нижнее подчеркивание или дефис. В основном используются в URL.
Как и для CharField, можно указать max_length (упомянутые особенности работы с различными типами баз данных актуальны). Если max_length не указан, Django будет использовать значение 50.
Устанавливает Field.db_index в True, если аргумент явно не указан.
Обычно значение SlugField создается на основе какого-то другого значения(например, название статьи). Это может работать автоматически в интерфейсе администрации благодаря параметру prepopulated_fields.
Как и поле IntegerField, но принимает значения в определенном диапазоне(зависит от типа базы данных). Для баз данных поддерживаемых Django можно использовать значения от -32768 до 32767.
Большое текстовое поле. Форма использует виджет Textarea.
MySQL users
Если вы используете это поле с MySQLdb 1.2.1p2 и utf8_bin “collation” (которое не является значением по умолчанию), могут быть некоторые проблемы. Смотрите советы при работе с MySQL для подробностей.
Время, представленное объектом datetime.time Python. Принимает те же аргументы, что и DateField.
Форма использует виджет TextInput. Интерфейс администратора также использует немного JavaScript.
Поле CharField для URL.
Виджет по умолчанию для этого поля TextInput.
Как подкласс CharField URLField принимает необязательный аргумент max_length. Если вы не укажите max_length, будет использовано значение – 200.
The current value of the field will be displayed as a clickable link above the input widget.
Mar 30, 2016