Создание пользовательских полей модели

Введение

Документация справочника по моделям объясняет, как использовать стандартные классы полей Django — CharField, DateField и т. д. Для многих целей этих классов достаточно. Однако иногда версии Django не удовлетворяют вашим точным требованиям, или вам нужно использовать поле, которое полностью отличается от полей, поставляемых с Django.

Встроенные типы полей Django не охватывают все возможные типы столбцов базы данных — только распространённые типы, такие как VARCHAR и INTEGER. Для более редких типов столбцов, таких как геометрические полигоны или даже пользовательские типы, такие как пользовательские типы PostgreSQL, вы можете определить свои собственные подклассы полей Django Field.

В качестве альтернативы у вас может быть сложный объект Python, который каким-то образом можно сериализовать для размещения в стандартном типе столбца базы данных. Это ещё один случай, когда подкласс Field поможет вам использовать ваш объект в ваших моделях.

Наш пример объекта

Создание пользовательских полей требует некоторого внимания к деталям. Чтобы упростить понимание, мы будем использовать последовательный пример на протяжении всего документа: обертка объекта Python, представляющего раздачу карт в партии бриджа. Не беспокойтесь, вам не нужно знать правила бриджа, чтобы понять этот пример. Вам нужно знать только то, что 52 карты равномерно раздаются четырём игрокам, которых традиционно называют север, восток, юг и запад. Наш класс выглядит примерно так:

class Hand:
    """A hand of cards (bridge style)"""

    def __init__(self, north, east, south, west):
        # Input parameters are lists of cards ('Ah', '9s', etc.)
        self.north = north
        self.east = east
        self.south = south
        self.west = west

    # ... (other possibly useful methods omitted) ...

Это обычный класс Python, в котором нет ничего специфичного для Django. Мы хотели бы иметь возможность делать такие вещи в наших моделях (мы предполагаем, что атрибут hand в модели является экземпляром Hand):

example = MyModel.objects.get(pk=1)
print(example.hand.north)

new_hand = Hand(north, east, south, west)
example.hand = new_hand
example.save()

Мы присваиваем и извлекаем значения из атрибута hand в нашей модели, как и любой другой класс Python. Секрет в том, чтобы рассказать Django, как обращаться с таким объектом.

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

Теоретические основы

Хранение в базе данных

Начнём с полей модели. Если разобрать это, поле модели предоставляет способ взять обычный объект Python — строку, булево значение, datetime, или что-то более сложное, например Hand — и преобразовать его в формат, полезный при работе с базой данных. (Такой формат также полезен для сериализации, но, как мы увидим позже, это проще, когда вы контролируете базу данных).

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

Обычно вы либо создаёте поле Django, соответствующее определённому типу столбца базы данных, либо вам понадобится способ преобразования ваших данных, например, в строку.

В нашем примере Hand мы могли бы преобразовать данные карт в строку из 104 символов, объединив все карты в заранее определённом порядке — скажем, сначала все карты север, затем восток, юг и запад. Таким образом, объекты Hand могут быть сохранены в текстовых или символьных столбцах базы данных.

Что делает класс поля?

Все поля Django (и когда мы говорим «поля» в этом документе, мы всегда подразумеваем поля модели, а не поля формы) являются подклассами django.db.models.Field. Большая часть информации, которую Django записывает о поле, общая для всех полей — имя, подсказка, уникальность и так далее. Хранение всей этой информации обрабатывается Field. Мы рассмотрим точные подробности того, что Field может делать позже; пока достаточно сказать, что всё происходит от Field и затем настраивает ключевые части поведения класса.

Важно понимать, что класс поля Django не хранится в атрибутах вашей модели. Атрибуты модели содержат обычные объекты Python. Классы полей, которые вы определяете в модели, фактически хранятся в классе Meta при создании класса модели (точные детали того, как это делается, здесь не важны). Это связано с тем, что классы полей не нужны, когда вы просто создаёте и изменяете атрибуты. Вместо этого они обеспечивают механизм преобразования между значением атрибута и тем, что хранится в базе данных или отправляется в сериализатор.

Помните об этом, когда создаёте собственные пользовательские поля. Подкласс Django Field, который вы пишете, предоставляет механизм преобразования между вашими экземплярами Python и значениями базы данных/сериализатора различными способами (например, есть различия между хранением значения и использованием значения для поиска).

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

• Первый класс — это объект Python, с которым будут взаимодействовать ваши пользователи. Они будут назначать его в атрибут модели, они будут считывать его для отображения и т. д. Это класс Hand в нашем примере.
• Второй класс — это подкласс Field. Это класс, который знает, как преобразовать ваш первый класс в его постоянную форму хранения и форму Python.

Создание подкласса поля

При планировании подкласса Field сначала подумайте, какому существующему классу Field ваш новое поле наиболее похоже. Можете ли вы создать подкласс существующего поля Django и сэкономить время? Если нет, вам следует создать подкласс класса Field, от которого всё происходит.

Инициализация нового поля сводится к отделению аргументов, специфичных для вашего случая, от общих аргументов и передаче последних методу __init__() класса Field (или родительского класса).

В нашем примере мы назовём наше поле HandField. (Хорошая идея — назвать ваш подкласс Field <Something>Field, чтобы его легко было распознать как подкласс Field).

Он не ведет себя как какое-либо существующее поле, поэтому мы создадим подкласс напрямую от Field:

from django.db import models

class HandField(models.Field):

    description = "A hand of cards (bridge style)"

    def __init__(self, *args, **kwargs):
        kwargs['max_length'] = 104
        super().__init__(*args, **kwargs)

Наш класс HandField принимает большинство стандартных параметров поля (см. список ниже), но мы гарантируем, что он имеет фиксированную длину, так как ему нужно хранить только 52 значения карт плюс их масти; 104 символа в общей сложности.

Метод Field.__init__() принимает следующие параметры:

• verbose_name
• name
• primary_key
• max_length
• unique
• blank
• null
• db_index
• rel: Используется для связанных полей (например, ForeignKey). Только для расширенного использования.
• default
• editable
• serialize: Если False, поле не будет сериализовано, когда модель передаётся в сериализаторы Django сериализаторов. По умолчанию True.
• unique_for_date
• unique_for_month
• unique_for_year
• choices
• help_text
• db_column
• db_tablespace: Только для создания индексов, если бэкэнд поддерживает пространства имен таблиц. Обычно этот параметр можно игнорировать.
• auto_created: True если поле было создано автоматически, как для OneToOneField, используемого наследованием модели. Только для расширенного использования.

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

Деконструкция полей

Противоположностью написанию метода __init__() является написание метода deconstruct(). Он используется во время миграций моделей, чтобы сообщить Django, как преобразовать экземпляр вашего нового поля в сериализованную форму — в частности, какие аргументы передать методу __init__() для его повторного создания.

Если вы не добавили никаких дополнительных параметров помимо унаследованного поля, то нет необходимости писать новый метод deconstruct(). Однако, если вы изменяете аргументы, передаваемые в __init__() (как мы делаем в HandField), вам нужно дополнить передаваемые значения.

deconstruct() возвращает кортеж из четырёх элементов: имя атрибута поля, полное имя импорта класса поля, позиционные аргументы (как список) и именованные аргументы (как словарь). Обратите внимание, что это отличается от метода deconstruct() для пользовательских классов, который возвращает кортеж из трёх элементов.

Как автору пользовательского поля, вам не нужно беспокоиться о первых двух значениях; базовый класс Field содержит весь код для определения имени атрибута поля и пути импорта. Вам, однако, нужно беспокоиться о позиционных и именованных аргументах, так как, скорее всего, именно их вы изменяете.

Например, в нашем классе HandField мы всегда принудительно устанавливаем max_length в __init__(). Метод deconstruct() в базовом классе Field увидит это и попытается вернуть его в именованные аргументы; таким образом, мы можем удалить его из именованных аргументов для повышения читаемости:

from django.db import models

class HandField(models.Field):

    def __init__(self, *args, **kwargs):
        kwargs['max_length'] = 104
        super().__init__(*args, **kwargs)

    def deconstruct(self):
        name, path, args, kwargs = super().deconstruct()
        del kwargs["max_length"]
        return name, path, args, kwargs

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

from django.db import models

class CommaSepField(models.Field):
    "Implements comma-separated storage of lists"

    def __init__(self, separator=",", *args, **kwargs):
        self.separator = separator
        super().__init__(*args, **kwargs)

    def deconstruct(self):
        name, path, args, kwargs = super().deconstruct()
        # Only include kwarg if it's not the default
        if self.separator != ",":
            kwargs['separator'] = self.separator
        return name, path, args, kwargs

Более сложные примеры выходят за рамки данного документа, но помните — для любой конфигурации экземпляра вашего поля deconstruct() должен возвращать аргументы, которые вы можете передать в __init__ для реконструкции этого состояния.

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

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

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

name, path, args, kwargs = my_field_instance.deconstruct()
new_instance = MyField(*args, **kwargs)
self.assertEqual(my_field_instance.some_attribute, new_instance.some_attribute)

Изменение базового класса пользовательского поля

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

class CustomCharField(models.CharField):
    ...

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

class CustomCharField(models.TextField):
    ...

Вместо этого, необходимо создать новый класс пользовательского поля и обновить ваши модели, чтобы они ссылались на него:

class CustomCharField(models.CharField):
    ...

class CustomTextField(models.TextField):
    ...

Как обсуждалось в удалении полей, необходимо сохранить исходный класс CustomCharField до тех пор, пока у вас есть миграции, которые на него ссылаются.

Документирование вашего пользовательского поля

Как всегда, вам следует документировать тип поля, чтобы пользователи знали, что это такое. Помимо предоставления для него docstring, что полезно для разработчиков, вы также можете позволить пользователям приложения администрирования видеть краткое описание типа поля через приложение django.contrib.admindocs. Для этого предоставьте описательный текст в атрибуте класса description вашего пользовательского поля. В приведенном выше примере описание, отображаемое приложением admindocs для HandField будет «Колода карт (по системе бриджа)».

В отображении django.contrib.admindocs описание поля интерполируется с помощью field.__dict__, что позволяет описанию включать аргументы поля. Например, описание для CharField:

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

Полезные методы

После создания вашего подкласса Field, вы можете рассмотреть возможность переопределения нескольких стандартных методов, в зависимости от поведения вашего поля. Список методов ниже приблизительно в порядке убывания важности, поэтому начните сверху.

Пользовательские типы баз данных

Предположим, вы создали пользовательский тип PostgreSQL под названием mytype. Вы можете создать подкласс Field и реализовать метод db_type(), как показано ниже:

from django.db import models

class MytypeField(models.Field):
    def db_type(self, connection):
        return 'mytype'

После создания MytypeField, вы можете использовать его в любой модели, как и любой другой тип Field:

class Person(models.Model):
    name = models.CharField(max_length=80)
    something_else = MytypeField()

Если вы стремитесь создать базу данных, не зависящую от базы данных, вы должны учитывать различия в типах столбцов базы данных. Например, тип столбца даты/времени в PostgreSQL называется timestamp, в то время как тот же столбец в MySQL называется datetime. Вы можете справиться с этим в методе db_type(), проверив атрибут connection.settings_dict['ENGINE'].

Например:

class MyDateField(models.Field):
    def db_type(self, connection):
        if connection.settings_dict['ENGINE'] == 'django.db.backends.mysql':
            return 'datetime'
        else:
            return 'timestamp'

Методы db_type() и rel_db_type() вызываются Django при построении инструкций CREATE TABLE для вашего приложения — то есть, при первом создании таблиц. Методы также вызываются при построении WHERE предложения, включающего поле модели — то есть, при получении данных с помощью методов QuerySet, таких как get(), filter(), и exclude(), с полем модели в качестве аргумента. Они не вызываются в других случаях, поэтому могут позволить себе выполнять несколько сложный код, например, проверку connection.settings_dict в приведённом выше примере.

Некоторые типы столбцов баз данных принимают параметры, например CHAR(25), где параметр 25 представляет максимальную длину столбца. В таких случаях, гибче задавать параметр в модели, вместо его жёсткого кодирования в методе db_type(). Например, не имеет смысла использовать CharMaxlength25Field, показанный здесь:

# This is a silly example of hard-coded parameters.
class CharMaxlength25Field(models.Field):
    def db_type(self, connection):
        return 'char(25)'

# In the model:
class MyModel(models.Model):
    # ...
    my_field = CharMaxlength25Field()

Лучший способ сделать это — сделать параметр изменяемым во время выполнения — т.е., при создании экземпляра класса. Для этого реализуйте метод Field.__init__(), как показано ниже:

# This is a much more flexible example.
class BetterCharField(models.Field):
    def __init__(self, max_length, *args, **kwargs):
        self.max_length = max_length
        super().__init__(*args, **kwargs)

    def db_type(self, connection):
        return 'char(%s)' % self.max_length

# In the model:
class MyModel(models.Model):
    # ...
    my_field = BetterCharField(25)

Наконец, если ваш столбец требует действительно сложной настройки SQL, верните None из db_type(). Это заставит код создания SQL Django пропустить это поле. Вы затем будете отвечать за создание столбца в нужной таблице каким-либо другим способом, но это даёт вам возможность указать Django «выйти из игры».

Метод rel_db_type() вызывается полями, такими как ForeignKey и OneToOneField, которые ссылаются на другое поле, чтобы определить типы данных столбцов базы данных. Например, если у вас есть UnsignedAutoField, вам также нужны внешние ключи, которые указывают на это поле, чтобы использовать тот же тип данных:

# MySQL unsigned integer (range 0 to 4294967295).
class UnsignedAutoField(models.AutoField):
    def db_type(self, connection):
        return 'integer UNSIGNED AUTO_INCREMENT'

    def rel_db_type(self, connection):
        return 'integer UNSIGNED'

Преобразование значений в объекты Python

Если ваш пользовательский класс Field работает со структурами данных, которые сложнее строк, дат, целых чисел или чисел с плавающей точкой, вам, возможно, придётся переопределить from_db_value() и to_python().

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

to_python() вызывается при десериализации и во время метода clean(), используемого из форм.

В общем случае, to_python() должен корректно обрабатывать следующие аргументы:

• Экземпляр соответствующего типа (например, Hand в нашем текущем примере).
• Строка
• None (если поле допускает null=True)

В нашем классе HandField, мы храним данные как поле VARCHAR в базе данных, поэтому нам нужно уметь обрабатывать строки и None в методах from_db_value(). В методе to_python(), нам также нужно обрабатывать экземпляры Hand.

import re

from django.core.exceptions import ValidationError
from django.db import models
from django.utils.translation import gettext_lazy as _

def parse_hand(hand_string):
    """Takes a string of cards and splits into a full hand."""
    p1 = re.compile('.{26}')
    p2 = re.compile('..')
    args = [p2.findall(x) for x in p1.findall(hand_string)]
    if len(args) != 4:
        raise ValidationError(_("Invalid input for a Hand instance"))
    return Hand(*args)

class HandField(models.Field):
    # ...

    def from_db_value(self, value, expression, connection):
        if value is None:
            return value
        return parse_hand(value)

    def to_python(self, value):
        if isinstance(value, Hand):
            return value

        if value is None:
            return value

        return parse_hand(value)

Обратите внимание, что из этих методов всегда возвращается экземпляр Hand. Это тип объекта Python, который мы хотим хранить в атрибуте модели.

Для to_python(), если при преобразовании значения возникнут какие-либо ошибки, вы должны поднять исключение ValidationError.

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

Поскольку использование базы данных требует преобразований в обоих направлениях, если вы переопределяете from_db_value(), вам также нужно переопределить get_prep_value() для преобразования объектов Python обратно в значения запроса.

Например:

class HandField(models.Field):
    # ...

    def get_prep_value(self, value):
        return ''.join([''.join(l) for l in (value.north,
                value.east, value.south, value.west)])

Преобразование значений запроса в значения базы данных

Некоторые типы данных (например, даты) должны быть в определённом формате перед использованием в базе данных. get_db_prep_value() — это метод, в котором должны выполняться эти преобразования. Связь, которая будет использоваться для запроса, передаётся в качестве параметра connection. Это позволяет использовать специфичную для базы данных логику преобразования, если это необходимо.

Например, Django использует следующий метод для своего BinaryField:

def get_db_prep_value(self, value, connection, prepared=False):
    value = super().get_db_prep_value(value, connection, prepared)
    if value is not None:
        return connection.Database.Binary(value)
    return value

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

Предварительная обработка значений перед сохранением

Если вы хотите предварительно обработать значение перед сохранением, вы можете использовать pre_save(). Например, Django использует этот метод для корректной установки атрибута в случае auto_now или auto_now_add.

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

Указание поля формы для поля модели

Для настройки поля формы, используемого ModelForm, вы можете переопределить formfield().

Класс поля формы может быть указан через аргументы form_class и choices_form_class; последний используется, если для поля указаны варианты, первый — в противном случае. Если эти аргументы не предоставлены, будут использованы CharField или TypedChoiceField.

Весь словарь kwargs передаётся напрямую в метод __init__() поля формы. Как правило, вам нужно только установить хорошее значение по умолчанию для аргумента form_class (и, возможно, choices_form_class) и затем делегировать дальнейшую обработку родительскому классу. Это может потребовать написания пользовательского поля формы (и даже виджета формы). См. документацию по формам для получения информации об этом.

Продолжая наш пример, мы можем написать метод formfield() так:

class HandField(models.Field):
    # ...

    def formfield(self, **kwargs):
        # This is a fairly standard way to set up some defaults
        # while letting the caller override them.
        defaults = {'form_class': MyFormField}
        defaults.update(kwargs)
        return super().formfield(**defaults)

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

Имитирование встроенных типов полей

Если вы создали метод db_type(), вам не нужно беспокоиться о get_internal_type() — он будет использоваться редко. Иногда, однако, ваше хранение в базе данных похоже по типу на какое-то другое поле, поэтому вы можете использовать логику этого другого поля для создания правильного столбца.

Например:

class HandField(models.Field):
    # ...

    def get_internal_type(self):
        return 'CharField'

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

Если get_internal_type() возвращает строку, которая не известна Django для используемой базы данных – то есть, она не появляется в django.db.backends.<db_name>.base.DatabaseWrapper.data_types – строка всё равно будет использоваться сериализатором, но метод по умолчанию db_type() вернёт None. Обратитесь к документации db_type() для понимания, почему это может быть полезно. Вставка описательной строки в качестве типа поля для сериализатора – полезная идея, если вы планируете использовать вывод сериализатора в другом месте, вне Django.

Преобразование данных поля для сериализации

Чтобы настроить способ сериализации значений сериализатором, вы можете переопределить value_to_string(). Использование value_from_object() – лучший способ получить значение поля до сериализации. Например, так как HandField использует строки для хранения данных, мы можем повторно использовать некоторый существующий код преобразования:

class HandField(models.Field):
    # ...

    def value_to_string(self, obj):
        value = self.value_from_object(obj)
        return self.get_prep_value(value)

Общие рекомендации

Создание пользовательского поля может быть сложным процессом, особенно если вы выполняете сложные преобразования между вашими типами Python, базами данных и форматами сериализации. Вот несколько советов, чтобы упростить задачу:

1. Обратитесь к существующим полям Django (в django/db/models/fields/__init__.py) за вдохновением. Попробуйте найти поле, подобное тому, что вам нужно, и немного расширить его, вместо создания совершенно нового поля с нуля.
2. Добавьте метод __str__() в класс, который вы оборачиваете как поле. В многих местах по умолчанию код поля вызывает str() для значения. (В наших примерах в этом документе value будет экземпляром Hand, а не HandField). Поэтому, если ваш метод __str__() автоматически преобразует в строковую форму вашего объекта Python, вы можете сэкономить много работы.

Создание подкласса FileField

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

Django предоставляет класс File, который используется как прокси для содержимого и операций с файлом. Его можно расширить, чтобы настроить доступ к файлу и доступные методы. Он находится в django.db.models.fields.files, и его поведение по умолчанию объясняется в документации по файлам.

После создания подкласса File, новый подкласс FileField должен быть проинформирован об использовании этого подкласса. Для этого присвойте новый подкласс File специальному атрибуту attr_class подкласса FileField.

Некоторые рекомендации

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

1. Исходный код собственного ImageField Django (в django/db/models/fields/files.py) – отличный пример того, как расширить FileField для поддержки конкретного типа файла, поскольку он включает все описанные выше методы.
2. Кэшируйте атрибуты файлов, где это возможно. Поскольку файлы могут храниться в удаленных системах хранения, их получение может занимать больше времени или даже денег, что не всегда необходимо. Как только файл получен для получения данных о его содержимом, кэшируйте как можно больше этих данных, чтобы сократить количество обращений к файлу при последующих запросах информации.