Поля и виджеты, специфичные для PostgreSQL

Все эти поля и виджеты доступны из модуля django.contrib.postgres.forms.

Поля

SimpleArrayField

class SimpleArrayField(base_field, delimiter=', ', max_length=None, min_length=None)

Поле, которое отображает массив. Оно представлено HTML-элементом <input>.

base_field

Это обязательный аргумент.

Он задаёт базовое поле формы для массива. Оно не используется для рендеринга HTML, но используется для обработки отправленных данных и их валидации. Например:

>>> from django import forms
>>> from django.contrib.postgres.forms import SimpleArrayField

>>> class NumberListForm(forms.Form):
...     numbers = SimpleArrayField(forms.IntegerField())

>>> form = NumberListForm({'numbers': '1,2,3'})
>>> form.is_valid()
True
>>> form.cleaned_data
{'numbers': [1, 2, 3]}

>>> form = NumberListForm({'numbers': '1,2,a'})
>>> form.is_valid()
False

delimiter

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

>>> from django import forms
>>> from django.contrib.postgres.forms import SimpleArrayField

>>> class GridForm(forms.Form):
...     places = SimpleArrayField(SimpleArrayField(IntegerField()), delimiter='|')

>>> form = GridForm({'places': '1,2|2,1|4,3'})
>>> form.is_valid()
True
>>> form.cleaned_data
{'places': [[1, 2], [2, 1], [4, 3]]}

Примечание

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

max_length

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

min_length

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

Пользовательские формы

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

SplitArrayField

class SplitArrayField(base_field, size, remove_trailing_nulls=False)

Это поле обрабатывает массивы, повторяя базовое поле заданное количество раз.

base_field

Это обязательный аргумент. Он задаёт поле формы, которое нужно повторить.

size

Это фиксированное количество повторений базового поля.

remove_trailing_nulls

По умолчанию это установлено в значение False. Когда установлено значение False, каждое значение из повторяющихся полей сохраняется. Когда установлено значение True, любые пустые хвостовые значения удаляются из результата. Если базовое поле позволяет required=True, но remove_trailing_nulls имеет значение True, то значения NULL разрешены только в конце и будут удалены.

Примеры:

SplitArrayField(IntegerField(required=True), size=3, remove_trailing_nulls=False)

['1', '2', '3']  # -> [1, 2, 3]
['1', '2', '']  # -> ValidationError - third entry required.
['1', '', '3']  # -> ValidationError - second entry required.
['', '2', '']  # -> ValidationError - first and third entries required.

SplitArrayField(IntegerField(required=False), size=3, remove_trailing_nulls=False)

['1', '2', '3']  # -> [1, 2, 3]
['1', '2', '']  # -> [1, 2, None]
['1', '', '3']  # -> [1, None, 3]
['', '2', '']  # -> [None, 2, None]

SplitArrayField(IntegerField(required=True), size=3, remove_trailing_nulls=True)

['1', '2', '3']  # -> [1, 2, 3]
['1', '2', '']  # -> [1, 2]
['1', '', '3']  # -> ValidationError - second entry required.
['', '2', '']  # -> ValidationError - first entry required.

SplitArrayField(IntegerField(required=False), size=3, remove_trailing_nulls=True)

['1', '2', '3']  # -> [1, 2, 3]
['1', '2', '']  # -> [1, 2]
['1', '', '3']  # -> [1, None, 3]
['', '2', '']  # -> [None, 2]

HStoreField

class HStoreField

Поле, которое принимает данные, закодированные в формате JSON, для HStoreField. Оно преобразует все значения (кроме null) в строки. Оно представлено HTML-элементом <textarea>.

Пользовательские формы

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

Примечание

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

JSONField

class JSONField

Поле, которое принимает данные, закодированные в формате JSON, для JSONField. Оно представлено HTML-элементом <textarea>.

Пользовательские формы

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

Устарело начиная с версии 3.1: Используйте django.forms.JSONField вместо этого.

Поля диапазона

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

IntegerRangeField

class IntegerRangeField

Основано на IntegerField и преобразует его вход в NumericRange. По умолчанию для IntegerRangeField и BigIntegerRangeField.

DecimalRangeField

class DecimalRangeField

Основано на DecimalField и преобразует его вход в NumericRange. По умолчанию для DecimalRangeField.

DateTimeRangeField

class DateTimeRangeField

Основано на DateTimeField и преобразует его вход в DateTimeTZRange. По умолчанию для DateTimeRangeField.

DateRangeField

class DateRangeField

Основано на DateField и преобразует его вход в DateRange. По умолчанию для DateRangeField.

Виджеты

RangeWidget

class RangeWidget(base_widget, attrs=None)

Виджет, используемый всеми полями диапазона. Основан на MultiWidget.

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

base_widget

А RangeWidget состоит из 2-кортежа base_widget.

decompress(value)

Принимает единственное «сжатое» значение поля, например DateRangeField, и возвращает кортеж, представляющий нижнюю и верхнюю границы.