django.forms.fields.MultiValueField

class documentation

class MultiValueField(Field):

Known subclasses: django.contrib.postgres.forms.ranges.BaseRangeField, django.forms.fields.SplitDateTimeField

Aggregate the logic of multiple Fields.

Its clean() method takes a "decompressed" list of values, which are then cleaned into a single value according to self.fields. Each value in this list is cleaned by the corresponding field -- the first value is cleaned by the first field, the second value is cleaned by the second field, etc. Once all fields are cleaned, the list of clean values is "compressed" into a single value.

Subclasses should not have to implement clean(). Instead, they must implement compress(), which takes a list of valid values and returns a "compressed" version of those values -- a single value.

You'll probably want to use this with MultiWidget.

Method	`__deepcopy__`	Undocumented
Method	`__init__`	Undocumented
Method	`clean`	Validate every value in the given list. A value is validated against the corresponding Field in self.fields.
Method	`compress`	Return a single value for the given list of values. The values can be assumed to be valid.
Method	`has_changed`	Return True if data differs from initial.
Method	`validate`	Undocumented
Class Variable	`default_error_messages`	Undocumented
Instance Variable	`fields`	Undocumented
Instance Variable	`require_all_fields`	Undocumented

Inherited from Field:

Method	`bound_data`	Return the value that should be shown for this field on render of a bound form, given the submitted POST data for the field and the initial data, if any.
Method	`get_bound_field`	Return a BoundField instance that will be used when accessing the form field in a template.
Method	`prepare_value`	Undocumented
Method	`run_validators`	Undocumented
Method	`to_python`	Undocumented
Method	`widget_attrs`	Given a Widget instance (not a Widget class), return a dictionary of any HTML attributes that should be added to the Widget, based on this Field.
Class Variable	`default_validators`	Undocumented
Class Variable	`empty_values`	Undocumented
Instance Variable	`disabled`	Undocumented
Instance Variable	`error_messages`	Undocumented
Instance Variable	`help_text`	Undocumented
Instance Variable	`initial`	Undocumented
Instance Variable	`label`	Undocumented
Instance Variable	`label_suffix`	Undocumented
Instance Variable	`localize`	Undocumented
Instance Variable	`required`	Undocumented
Instance Variable	`show_hidden_initial`	Undocumented
Instance Variable	`validators`	Undocumented
Instance Variable	`widget`	Undocumented

def __deepcopy__(self, memo):

overrides django.forms.fields.Field.__deepcopy__

Undocumented

def __init__(self, fields, *, require_all_fields=True, **kwargs):

overrides django.forms.fields.Field.__init__

overridden in django.contrib.postgres.forms.ranges.BaseRangeField, django.forms.fields.SplitDateTimeField

Undocumented

def clean(self, value):

overrides django.forms.fields.Field.clean

Validate every value in the given list. A value is validated against the corresponding Field in self.fields.

For example, if this MultiValueField was instantiated with fields=(DateField(), TimeField()), clean() would call DateField.clean(value[0]) and TimeField.clean(value[1]).

def compress(self, data_list):

overridden in django.contrib.postgres.forms.ranges.BaseRangeField, django.forms.fields.SplitDateTimeField

Return a single value for the given list of values. The values can be assumed to be valid.

For example, if this MultiValueField was instantiated with fields=(DateField(), TimeField()), this might return a datetime object created by combining the date and time in data_list.

def has_changed(self, initial, data):

overrides django.forms.fields.Field.has_changed

Return True if data differs from initial.

def validate(self, value):

overrides django.forms.fields.Field.validate

Undocumented

default_error_messages =

overrides django.forms.fields.Field.default_error_messages

overridden in django.contrib.postgres.forms.ranges.BaseRangeField, django.forms.fields.SplitDateTimeField

Undocumented

fields =

Undocumented

require_all_fields =

Undocumented