Основные аргументы¶

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

class CurrentUserDefault:
    """
    May be applied as a `default=...` value on a serializer field.
    Returns the current user.
    """
    requires_context = True

    def __call__(self, serializer_field):
        return serializer_field.context['request'].user

import datetime
from rest_framework import serializers
class ExampleSerializer(serializers.Serializer):
    day = serializers.DateField(initial=datetime.date.today)

# Use <input type="password"> for the input.
password = serializers.CharField(
    style={'input_type': 'password'}
)

# Use a radio input instead of a select input.
color_channel = serializers.ChoiceField(
    choices=['red', 'green', 'blue'],
    style={'base_template': 'radio.html'}
)

BooleanField¶

Булево представление.

При использовании HTML-кодированных форм ввода следует помнить, что пропуск значения всегда будет рассматриваться как установка поля в значение False , даже если для него задана опция default=True. Это связано с тем, что входы с флажками HTML представляют состояние без флажка, когда значение отсутствует, поэтому фреймворк REST рассматривает отсутствие значения как пустой вход с флажком.

Обратите внимание, что в Django 2.1 из blank убран карг models.BooleanField. До Django 2.1 models.BooleanField поля всегда были blank=True. Таким образом, начиная с Django 2.1 экземпляры serializers.BooleanField по умолчанию будут генерироваться без кванга required (т.е. эквивалентно required=True ), тогда как в предыдущих версиях Django экземпляры BooleanField по умолчанию будут генерироваться с опцией required=False. Если вы хотите управлять этим поведением вручную, явно объявите BooleanField на классе сериализатора, или используйте опцию extra_kwargs для установки флага required.

Соответствует django.db.models.fields.BooleanField.

Подпись: BooleanField()

NullBooleanField¶

Булево представление, которое также принимает None в качестве допустимого значения.

Соответствует django.db.models.fields.NullBooleanField.

Подпись: NullBooleanField()

CharField¶

Текстовое представление. Опционально проверяет, чтобы текст был короче max_length и длиннее min_length.

Соответствует django.db.models.fields.CharField или django.db.models.fields.TextField.

Подпись: CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)

• max_length - Проверяет, что вход содержит не более данного количества символов.

• min_length - Проверяет, что вход содержит не менее данного количества символов.

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

• trim_whitespace - Если установлено значение True, то обрезаются ведущие и отстающие пробельные символы. По умолчанию установлено значение True.

Опция allow_null также доступна для строковых полей, хотя ее использование не рекомендуется в пользу allow_blank. Можно установить и allow_blank=True, и allow_null=True , но это означает, что для строковых представлений допустимы два разных типа пустого значения, что может привести к несоответствию данных и тонким ошибкам в работе приложения.

EmailField¶

Текстовое представление, проверяет, является ли текст действительным адресом электронной почты.

Соответствует django.db.models.fields.EmailField

Подпись: EmailField(max_length=None, min_length=None, allow_blank=False)

RegexField¶

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

Соответствует django.forms.fields.RegexField.

Подпись: RegexField(regex, max_length=None, min_length=None, allow_blank=False)

Обязательный аргумент regex может быть либо строкой, либо скомпилированным объектом регулярного выражения python.

Использует django.core.validators.RegexValidator от Django для валидации.

SlugField¶

RegexField, который проверяет входные данные на соответствие шаблону [a-zA-Z0-9_-]+.

Соответствует django.db.models.fields.SlugField.

Подпись: SlugField(max_length=50, min_length=None, allow_blank=False)

URLField¶

RegexField, который проверяет вводимые данные на соответствие шаблону URL. Ожидает полностью определенный URL в форме http://<host>/<path>.

Соответствует django.db.models.fields.URLField. Использует django.core.validators.URLValidator Django для валидации.

Подпись: URLField(max_length=200, min_length=None, allow_blank=False)

UUIDField¶

Поле, которое гарантирует, что вводимые данные являются действительной строкой UUID. Метод to_internal_value вернет экземпляр uuid.UUID. На выходе поле вернет строку в каноническом дефисном формате, например:

"de305d54-75b4-431b-adb2-eb6b9e546013"

Подпись: UUIDField(format='hex_verbose')

• format : Определяет формат представления значения uuid

  • 'hex_verbose' - Каноническое шестнадцатеричное представление, включая дефисы: "5ce0e9a5-5ffa-654b-cee0-1238041fb31a"

  • 'hex' - компактное шестнадцатеричное представление UUID, не включая дефисы: "5ce0e9a55ffa654bcee01238041fb31a"

  • 'int' - 128-битное целочисленное представление UUID: "123456789012312313134124512351145145114"

  • 'urn' - RFC 4122 URN представление UUID: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a" Изменение параметров format влияет только на значения представления. Все форматы принимаются to_internal_value

FilePathField¶

Поле, выбор которого ограничен именами файлов в определенном каталоге в файловой системе

Соответствует django.forms.fields.FilePathField.

Подпись: FilePathField(path, match=None, recursive=False, allow_files=True, allow_folders=False, required=None, **kwargs)

• path - Абсолютный путь файловой системы к каталогу, из которого это поле FilePathField должно получить свой выбор.

• match - регулярное выражение в виде строки, которое FilePathField будет использовать для фильтрации имен файлов.

• recursive - Указывает, следует ли включать все подкаталоги пути. По умолчанию False.

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

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

IPAddressField¶

Поле, которое гарантирует, что вводимые данные являются действительной строкой IPv4 или IPv6.

Соответствует django.forms.fields.IPAddressField и django.forms.fields.GenericIPAddressField.

Подпись : IPAddressField(protocol='both', unpack_ipv4=False, **options)

• protocol Ограничивает допустимые входы указанным протоколом. Принимаемые значения: „both“ (по умолчанию), „IPv4“ или „IPv6“. Соответствие нечувствительно к регистру.

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

IntegerField¶

Целочисленное представление.

Соответствует django.db.models.fields.IntegerField , django.db.models.fields.SmallIntegerField , django.db.models.fields.PositiveIntegerField и django.db.models.fields.PositiveSmallIntegerField.

Подпись : IntegerField(max_value=None, min_value=None)

• max_value Убедитесь, что предоставленное число не больше этого значения.

• min_value Проверьте, что предоставленное число не меньше этого значения.

FloatField¶

Представление с плавающей запятой.

Соответствует django.db.models.fields.FloatField.

Подпись : FloatField(max_value=None, min_value=None)

• max_value Убедитесь, что предоставленное число не больше этого значения.

• min_value Проверьте, что предоставленное число не меньше этого значения.

DecimalField¶

Десятичное представление, представленное в Python экземпляром Decimal.

Соответствует django.db.models.fields.DecimalField.

Подпись : DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None)

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

• decimal_places Количество знаков после запятой, которое должно храниться вместе с числом.

• coerce_to_string Устанавливается в True, если для представления должны быть возвращены строковые значения, или False, если должны быть возвращены Decimal объекты. По умолчанию имеет то же значение, что и ключ настроек COERCE_DECIMAL_TO_STRING, который будет True, если его не переопределить. Если сериализатор возвращает Decimal объектов, то окончательный формат вывода будет определяться рендерером. Обратите внимание, что установка localize приведет к принудительному значению True.

• max_value Убедитесь, что предоставленное число не больше этого значения.

• min_value Проверьте, что предоставленное число не меньше этого значения.

• localize Установите значение True, чтобы включить локализацию ввода и вывода на основе текущей локали. Это также заставит coerce_to_string установить значение True. По умолчанию установлено значение False. Обратите внимание, что форматирование данных включено, если вы установили USE_L10N=True в файле настроек.

• rounding Устанавливает режим округления, используемый при квантовании до настроенной точности. Допустимые значения: ** ``decimal:doc:` module rounding modes <https://docs.python.org/3/library/decimal.html#rounding-modes>`. По умолчанию None.

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

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

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

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

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

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

DateTimeField¶

Представление даты и времени.

Соответствует django.db.models.fields.DateTimeField.

Подпись: DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None, default_timezone=None)

• format - Строка, представляющая формат вывода. Если она не указана, то по умолчанию имеет то же значение, что и ключ настроек DATETIME_FORMAT, который будет 'iso-8601', если не установлен. Установка в строку формата указывает на то, что возвращаемые значения to_representation должны быть принудительно выведены в строку. Форматные строки описаны ниже. Установка этого значения в None указывает, что объекты Python datetime должны быть возвращены to_representation. В этом случае кодировка времени суток будет определяться рендерером.

• input_formats - Список строк, представляющих входные форматы, которые могут быть использованы для разбора даты. Если не указано, то будет использоваться параметр DATETIME_INPUT_FORMATS, который по умолчанию равен ['iso-8601'].

• default_timezone - pytz.timezone, представляющий часовой пояс. Если не указано и включен параметр USE_TZ, то по умолчанию используется current timezone. Если параметр USE_TZ отключен, то объекты datetime будут наивными.

Строки формата могут быть либо Python strftime formats, которые явно указывают формат, либо специальная строка 'iso-8601' , которая указывает на то, что следует использовать время даты в стиле ISO 8601. (например, '2013-01-29T12:34:56.000000Z' )

При использовании значения None для формата datetime объекты будут возвращены to_representation, а окончательное представление вывода будет определяться классом рендерера.

При использовании ModelSerializer или HyperlinkedModelSerializer``** , обратите внимание, что любые поля модели с ``auto_now=True или auto_now_add=True будут использовать поля сериализатора, которые по умолчанию read_only=True.

Если вы хотите отменить это поведение, вам нужно будет явно объявить DateTimeField в сериализаторе. Например:

class CommentSerializer(serializers.ModelSerializer):
    created = serializers.DateTimeField()

    class Meta:
        model = Comment

DateField¶

Представление даты.

Соответствует django.db.models.fields.DateField

Подпись: DateField(format=api_settings.DATE_FORMAT, input_formats=None)

• format - Строка, представляющая формат вывода. Если она не указана, то по умолчанию имеет то же значение, что и ключ настроек DATE_FORMAT, который будет 'iso-8601', если не установлен. Установка в строку формата указывает на то, что возвращаемые значения to_representation должны быть принудительно выведены в строку. Форматные строки описаны ниже. Установка этого значения в None указывает, что объекты Python date должны быть возвращены to_representation. В этом случае кодировка даты будет определяться рендерером.

• input_formats - Список строк, представляющих входные форматы, которые могут быть использованы для разбора даты. Если не указано, то будет использоваться параметр DATE_INPUT_FORMATS, который по умолчанию равен ['iso-8601'].

Строки формата могут быть либо Python strftime formats, которые явно указывают формат, либо специальная строка 'iso-8601' , которая указывает, что следует использовать даты в стиле ISO 8601. (например, '2013-01-29' )

TimeField¶

Представление времени.

Соответствует django.db.models.fields.TimeField

Подпись: TimeField(format=api_settings.TIME_FORMAT, input_formats=None)

• format - Строка, представляющая формат вывода. Если она не указана, то по умолчанию имеет то же значение, что и ключ настроек TIME_FORMAT, который будет 'iso-8601', если не установлен. Установка в строку формата указывает на то, что возвращаемые значения to_representation должны быть принудительно выведены в строку. Форматные строки описаны ниже. Установка этого значения в None указывает, что объекты Python time должны быть возвращены to_representation. В этом случае кодировка времени будет определяться рендерером.

• input_formats - Список строк, представляющих входные форматы, которые могут быть использованы для разбора даты. Если не указано, то будет использоваться параметр TIME_INPUT_FORMATS, который по умолчанию равен ['iso-8601'].

Строки формата могут быть либо Python strftime formats, которые явно указывают формат, либо специальная строка 'iso-8601' , которая указывает, что следует использовать время в стиле ISO 8601. (например, ``“12:34:56.000000“``** )

DurationField¶

Представление длительности. Соответствует django.db.models.fields.DurationField

validated_data для этих полей будет содержать экземпляр datetime.timedelta. Представление представляет собой строку, следующую этому формату '[DD] [HH:[MM:]]ss[.uuuuuu]'.

Подпись: DurationField(max_value=None, min_value=None)

• max_value Убедитесь, что предоставленная продолжительность не превышает этого значения.

• min_value Убедитесь, что предоставленная продолжительность не меньше этого значения.

ChoiceField¶

Поле, которое может принимать значение из ограниченного набора вариантов.

Используется ModelSerializer для автоматической генерации полей, если соответствующее поле модели включает аргумент choices=….

Подпись: ChoiceField(choices)

• choices - Список допустимых значений, или список кортежей (key, display_name).

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

• html_cutoff - Если установлено, это будет максимальное количество вариантов выбора, которое будет отображаться в выпадающем списке HTML select. Может использоваться для того, чтобы автоматически генерируемые поля выбора с очень большим количеством возможных вариантов выбора не препятствовали отрисовке шаблона. По умолчанию установлено значение None.

• html_cutoff_text - Если установлено, то будет отображаться текстовый индикатор, если максимальное количество элементов было отсечено в выпадающем списке HTML select. По умолчанию "More than {count} items…"

И allow_blank, и allow_null являются допустимыми вариантами ChoiceField , хотя настоятельно рекомендуется использовать только один из них, а не оба. allow_blank следует предпочесть для текстовых вариантов, а allow_null - для числовых или других нетекстовых вариантов.

MultipleChoiceField¶

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

Подпись: MultipleChoiceField(choices)

• choices - Список допустимых значений, или список кортежей (key, display_name).

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

• html_cutoff - Если установлено, это будет максимальное количество вариантов выбора, которое будет отображаться в выпадающем списке HTML select. Может использоваться для того, чтобы автоматически генерируемые поля выбора с очень большим количеством возможных вариантов выбора не препятствовали отрисовке шаблона. По умолчанию установлено значение None.

• html_cutoff_text - Если установлено, то будет отображаться текстовый индикатор, если максимальное количество элементов было отсечено в выпадающем списке HTML select. По умолчанию "More than {count} items…"

Как и в случае с ChoiceField , оба варианта allow_blank и allow_null являются допустимыми, хотя настоятельно рекомендуется использовать только один из них, а не оба. allow_blank следует предпочесть для текстовых вариантов, а allow_null - для числовых или других нетекстовых вариантов.

FileField¶

Представление файла. Выполняет стандартную для Django валидацию FileField.

Соответствует django.forms.fields.FileField.

Подпись: FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)

• max_length - Обозначает максимальную длину имени файла.

• allow_empty_file - Указывает, разрешены ли пустые файлы.

  • use_url - Если установлено значение True, то для выходного представления будут использоваться строковые значения URL. Если установлено значение False, то для вывода будут использоваться строковые значения имени файла. По умолчанию используется значение ключа настроек UPLOADED_FILES_USE_URL, которое равно True, если не установлено иное.

ImageField¶

Представление изображения. Проверяет соответствие содержимого загруженного файла известному формату изображения.

Соответствует django.forms.fields.ImageField.

Подпись: ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)

• max_length - Обозначает максимальную длину имени файла.

• allow_empty_file - Указывает, разрешены ли пустые файлы.

  • use_url - Если установлено значение True, то для выходного представления будут использоваться строковые значения URL. Если установлено значение False, то для вывода будут использоваться строковые значения имени файла. По умолчанию используется значение ключа настроек UPLOADED_FILES_USE_URL, которое равно True, если не установлено иное.

Требуется либо пакет Pillow, либо пакет PIL. Рекомендуется использовать пакет Pillow, так как пакет PIL больше не поддерживается.

ListField¶

Класс поля, который проверяет список объектов.

Подпись : ListField(child=<A_FIELD_INSTANCE>, allow_empty=True, min_length=None, max_length=None)

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

• allow_empty - Указывает, разрешены ли пустые списки.

• min_length - Проверяет, что список содержит не менее данного количества элементов.

• max_length - Проверяет, что список содержит не более данного количества элементов.

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

scores = serializers.ListField(
   child=serializers.IntegerField(min_value=0, max_value=100)
)

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

class StringListField(serializers.ListField):
    child = serializers.CharField()

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

DictField¶

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

Подпись : DictField(child=<A_FIELD_INSTANCE>, allow_empty=True)

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

• allow_empty - Указывает, разрешены ли пустые словари.

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

document = DictField(child=CharField())

Вы также можете использовать декларативный стиль, как в случае с ListField. Например:

class DocumentField(DictField):
    child = CharField()

HStoreField¶

Предварительно настроенный DictField, который совместим с постгрес Django HStoreField.

Подпись : HStoreField(child=<A_FIELD_INSTANCE>, allow_empty=True)

• child - Экземпляр поля, который используется для проверки значений в словаре. Дочернее поле по умолчанию принимает как пустые строки, так и нулевые значения.

• allow_empty - Указывает, разрешены ли пустые словари.

Обратите внимание, что дочернее поле должно быть экземпляром CharField , так как расширение hstore хранит значения в виде строк.

JSONField¶

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

Подпись : JSONField(binary, encoder)

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

• encoder - Использовать этот JSON-кодер для сериализации входного объекта. По умолчанию установлено значение None.

ReadOnlyField¶

Класс поля, который просто возвращает значение поля без модификации.

Это поле используется по умолчанию с ModelSerializer при включении имен полей, относящихся к атрибуту, а не к полю модели.

Подпись : ReadOnlyField()

Например, если has_expired было свойством модели Account, то следующий сериализатор автоматически сгенерирует его как ``ReadOnlyField``** :

class AccountSerializer(serializers.ModelSerializer):
    class Meta:
        model = Account
        fields = ['id', 'account_name', 'has_expired']

HiddenField¶

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

Подпись : HiddenField()

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

modified = serializers.HiddenField(default=timezone.now)

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

Дополнительные примеры по HiddenField см. в документации по validators.

ModelField¶

Общее поле, которое может быть привязано к любому произвольному полю модели. Класс ModelField делегирует задачу сериализации/десериализации связанному с ним полю модели. Это поле можно использовать для создания полей сериализатора для пользовательских полей модели, без необходимости создавать новое пользовательское поле сериализатора.

Это поле используется ModelSerializer для соответствия классам полей пользовательской модели.

Подпись: ModelField(model_field=<Django ModelField instance>)

Класс ModelField обычно предназначен для внутреннего использования, но при необходимости может быть использован вашим API. Для того чтобы правильно инстанцировать ModelField , ему должно быть передано поле, которое прикреплено к инстанцированной модели. Например: ModelField(model_field=MyModel()._meta.get_field('custom_field'))

SerializerMethodField¶

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

Подпись : SerializerMethodField(method_name=None)

• method_name - Имя метода сериализатора, который будет вызван. Если оно не включено, по умолчанию используется значение get_<field_name>.

Метод сериализатора, на который ссылается аргумент method_name, должен принимать единственный аргумент (в дополнение к self ), которым является сериализуемый объект. Он должен возвращать все, что вы хотите включить в сериализованное представление объекта. Например:

from django.contrib.auth.models import User
from django.utils.timezone import now
from rest_framework import serializers

class UserSerializer(serializers.ModelSerializer):
    days_since_joined = serializers.SerializerMethodField()

    class Meta:
        model = User
        fields = '__all__'

    def get_days_since_joined(self, obj):
        return (now() - obj.date_joined).days

Примеры¶

class Color:
    """
    A color represented in the RGB colorspace.
    """
    def __init__(self, red, green, blue):
        assert(red >= 0 and green >= 0 and blue >= 0)
        assert(red < 256 and green < 256 and blue < 256)
        self.red, self.green, self.blue = red, green, blue

class ColorField(serializers.Field):
    """
    Color objects are serialized into 'rgb(#, #, #)' notation.
    """
    def to_representation(self, value):
        return "rgb(%d, %d, %d)" % (value.red, value.green, value.blue)

    def to_internal_value(self, data):
        data = data.strip('rgb(').rstrip(')')
        red, green, blue = [int(col) for col in data.split(',')]
        return Color(red, green, blue)

class ClassNameField(serializers.Field):
    def get_attribute(self, instance):
        # We pass the object instance onto `to_representation`,
        # not just the field attribute.
        return instance

    def to_representation(self, value):
        """
        Serialize the value's class name.
        """
        return value.__class__.__name__

def to_internal_value(self, data):
    if not isinstance(data, str):
        msg = 'Incorrect type. Expected a string, but got %s'
        raise ValidationError(msg % type(data).__name__)

    if not re.match(r'^rgb**([0-9]+,[0-9]+,[0-9]+**)$', data):
        raise ValidationError('Incorrect format. Expected `rgb(#,#,#)`.')

    data = data.strip('rgb(').rstrip(')')
    red, green, blue = [int(col) for col in data.split(',')]

    if any([col > 255 or col < 0 for col in (red, green, blue)]):
        raise ValidationError('Value out of range. Must be between 0 and 255.')

    return Color(red, green, blue)

default_error_messages = {
    'incorrect_type': 'Incorrect type. Expected a string, but got {input_type}',
    'incorrect_format': 'Incorrect format. Expected `rgb(#,#,#)`.',
    'out_of_range': 'Value out of range. Must be between 0 and 255.'
}

def to_internal_value(self, data):
    if not isinstance(data, str):
        self.fail('incorrect_type', input_type=type(data).__name__)

    if not re.match(r'^rgb**([0-9]+,[0-9]+,[0-9]+**)$', data):
        self.fail('incorrect_format')

    data = data.strip('rgb(').rstrip(')')
    red, green, blue = [int(col) for col in data.split(',')]

    if any([col > 255 or col < 0 for col in (red, green, blue)]):
        self.fail('out_of_range')

    return Color(red, green, blue)

class DataPoint(models.Model):
    label = models.CharField(max_length=50)
    x_coordinate = models.SmallIntegerField()
    y_coordinate = models.SmallIntegerField()

class CoordinateField(serializers.Field):

    def to_representation(self, value):
        ret = {
            "x": value.x_coordinate,
            "y": value.y_coordinate
        }
        return ret

    def to_internal_value(self, data):
        ret = {
            "x_coordinate": data["x"],
            "y_coordinate": data["y"],
        }
        return ret


class DataPointSerializer(serializers.ModelSerializer):
    coordinates = CoordinateField(source='*')

    class Meta:
        model = DataPoint
        fields = ['label', 'coordinates']

class NestedCoordinateSerializer(serializers.Serializer):
    x = serializers.IntegerField(source='x_coordinate')
    y = serializers.IntegerField(source='y_coordinate')


class DataPointSerializer(serializers.ModelSerializer):
    coordinates = NestedCoordinateSerializer(source='*')

    class Meta:
        model = DataPoint
        fields = ['label', 'coordinates']

>>> out_serializer = DataPointSerializer(instance)
>>> out_serializer.data
ReturnDict([('label', 'testing'),
            ('coordinates', OrderedDict([('x', 1), ('y', 2)]))])

>>> in_serializer = DataPointSerializer(data=data)
>>> in_serializer.is_valid()
True
>>> in_serializer.validated_data
OrderedDict([('label', 'still testing'),
             ('x_coordinate', 3),
             ('y_coordinate', 4)])

>>> invalid_data = {
...     "label": "still testing",
...     "coordinates": {
...         "x": 'a',
...         "y": 'b',
...     }
... }
>>> invalid_serializer = DataPointSerializer(data=invalid_data)
>>> invalid_serializer.is_valid()
False
>>> invalid_serializer.errors
ReturnDict([('coordinates',
             {'x': ['A valid integer is required.'],
              'y': ['A valid integer is required.']})])

Составные поля DRF¶

Пакет drf-compound-fields предоставляет «составные» поля сериализатора, такие как списки простых значений, которые могут быть описаны другими полями, а не сериализаторами с помощью опции many=True. Также предоставляются поля для типизированных словарей и значений, которые могут быть либо определенным типом, либо списком элементов этого типа.

Дополнительные поля DRF¶

Пакет drf-extra-fields предоставляет дополнительные поля сериализатора для фреймворка REST, включая классы Base64ImageField и PointField.

djangorestframework-recursive¶

пакет djangorestframework-recursive предоставляет RecursiveField для сериализации и десериализации рекурсивных структур

django-rest-framework-gis¶

Пакет django-rest-framework-gis предоставляет географические дополнения для django rest framework, такие как поле GeometryField и сериализатор GeoJSON.

django-rest-framework-hstore¶

Пакет django-rest-framework-hstore предоставляет HStoreField для поддержки django-hstore DictionaryField модельного поля.