All of these fields and widgets are available from the\ndjango.contrib.postgres.forms module.
SimpleArrayFieldLink to this heading#A simple field which maps to an array. It is represented by an HTML\n<input>.
This is a required argument.
\nIt specifies the underlying form field for the array. This is not used\nto render any HTML, but it is used to process the submitted data and\nvalidate it. For example:
\n>>> from django.contrib.postgres.forms import SimpleArrayField\n>>> from django import forms\n\n>>> class NumberListForm(forms.Form):\n... numbers = SimpleArrayField(forms.IntegerField())\n\n>>> form = NumberListForm({'numbers': '1,2,3'})\n>>> form.is_valid()\nTrue\n>>> form.cleaned_data\n{'numbers': [1, 2, 3]}\n\n>>> form = NumberListForm({'numbers': '1,2,a'})\n>>> form.is_valid()\nFalse\nThis is an optional argument which defaults to a comma: ,. This\nvalue is used to split the submitted data. It allows you to chain\nSimpleArrayField for multidimensional data:
>>> from django.contrib.postgres.forms import SimpleArrayField\n>>> from django import forms\n\n>>> class GridForm(forms.Form):\n... places = SimpleArrayField(SimpleArrayField(IntegerField()), delimiter='|')\n\n>>> form = GridForm({'places': '1,2|2,1|4,3'})\n>>> form.is_valid()\nTrue\n>>> form.cleaned_data\n{'places': [[1, 2], [2, 1], [4, 3]]}\nThis is an optional argument which validates that the array does not\nexceed the stated length.
\nThis is an optional argument which validates that the array reaches at\nleast the stated length.
\nSplitArrayFieldLink to this heading#This field handles arrays by reproducing the underlying field a fixed\nnumber of times.
\nThis is a required argument. It specifies the form field to be\nrepeated.
\nThis is the fixed number of times the underlying field will be used.
\nBy default, this is set to False. When False, each value from\nthe repeated fields is stored. When set to True, any trailing\nvalues which are blank will be stripped from the result. If the\nunderlying field has required=True, but remove_trailing_nulls\nis True, then null values are only allowed at the end, and will be\nstripped.
Some examples:
\nSplitArrayField(IntegerField(required=True), size=3, remove_trailing_nulls=False)\n\n['1', '2', '3'] # -> [1, 2, 3]\n['1', '2', ''] # -> ValidationError - third entry required.\n['1', '', '3'] # -> ValidationError - second entry required.\n['', '2', ''] # -> ValidationError - first and third entries required.\n\nSplitArrayField(IntegerField(required=False), size=3, remove_trailing_nulls=False)\n\n['1', '2', '3'] # -> [1, 2, 3]\n['1', '2', ''] # -> [1, 2, None]\n['1', '', '3'] # -> [1, None, 3]\n['', '2', ''] # -> [None, 2, None]\n\nSplitArrayField(IntegerField(required=True), size=3, remove_trailing_nulls=True)\n\n['1', '2', '3'] # -> [1, 2, 3]\n['1', '2', ''] # -> [1, 2]\n['1', '', '3'] # -> ValidationError - second entry required.\n['', '2', ''] # -> ValidationError - first entry required.\n\nSplitArrayField(IntegerField(required=False), size=3, remove_trailing_nulls=True)\n\n['1', '2', '3'] # -> [1, 2, 3]\n['1', '2', ''] # -> [1, 2]\n['1', '', '3'] # -> [1, None, 3]\n['', '2', ''] # -> [None, 2]\nHStoreFieldLink to this heading#A field which accepts JSON encoded data for an\nHStoreField. It will cast all the\nvalues to strings. It is represented by an HTML <textarea>.
JSONFieldLink to this heading#A field which accepts JSON encoded data for a\nJSONField. It is represented by an\nHTML <textarea>.
This group of fields all share similar functionality for accepting range data.\nThey are based on MultiValueField. They treat one\nomitted value as an unbounded range. They also validate that the lower bound is\nnot greater than the upper bound. All of these fields use\nRangeWidget.
IntegerRangeFieldLink to this heading#Based on IntegerField and translates its input into\nNumericRange. Default for\nIntegerRangeField and\nBigIntegerRangeField.
FloatRangeFieldLink to this heading#Based on FloatField and translates its input into\nNumericRange. Default for\nFloatRangeField.
DateTimeRangeFieldLink to this heading#Based on DateTimeField and translates its input into\nDateTimeTZRange. Default for\nDateTimeRangeField.
DateRangeFieldLink to this heading#Based on DateField and translates its input into\nDateRange. Default for\nDateRangeField.
RangeWidgetLink to this heading#Widget used by all of the range fields.\nBased on MultiWidget.
RangeWidget has one required argument:
A RangeWidget comprises a 2-tuple of base_widget.
Takes a single "compressed" value of a field, for example a\nDateRangeField,\nand returns a tuple representing and lower and upper bound.