class documentation

class MultiWidget(Widget):

Known subclasses: django.contrib.postgres.forms.ranges.RangeWidget, django.forms.widgets.SplitDateTimeWidget

View In Hierarchy

A widget that is composed of multiple widgets.

In addition to the values added by Widget.get_context(), this widget adds a list of subwidgets to the context as widget['subwidgets']. These can be looped over and rendered like normal widgets.

You'll probably want to use this class with MultiValueField.

Method __deepcopy__ Undocumented
Method __init__ Undocumented
Method ​_get​_media Media for a multiwidget is the combination of all media of the subwidgets.
Method decompress Return a list of decompressed values for the given compressed value. The given value can be assumed to be valid, but not necessarily non-empty.
Method get​_context Undocumented
Method id​_for​_label Return the HTML ID attribute of this Widget for use by a <label>, given the ID of the field. Return None if no ID is available.
Method value​_from​_datadict Given a dictionary of data and this widget's name, return the value of this widget or None if it's not provided.
Method value​_omitted​_from​_data Undocumented
Class Variable media Undocumented
Class Variable template​_name Undocumented
Instance Variable widgets Undocumented
Instance Variable widgets​_names Undocumented
Property is​_hidden Undocumented
Property needs​_multipart​_form Undocumented

Inherited from Widget:

Method ​_render Undocumented
Method build​_attrs Build an attribute dictionary.
Method format​_value Return a value as it should appear when rendered in a template.
Method render Render the widget as an HTML string.
Method subwidgets Undocumented
Method use​_required​_attribute Undocumented
Class Variable is​_localized Undocumented
Class Variable is​_required Undocumented
Class Variable supports​_microseconds Undocumented
Instance Variable attrs Undocumented
def __deepcopy__(self, memo):
def _get_media(self):
Media for a multiwidget is the combination of all media of the subwidgets.
def decompress(self, value):
Return a list of decompressed values for the given compressed value. The given value can be assumed to be valid, but not necessarily non-empty.
def get_context(self, name, value, attrs):
def id_for_label(self, id_):

Return the HTML ID attribute of this Widget for use by a <label>, given the ID of the field. Return None if no ID is available.

This hook is necessary because some widgets have multiple HTML elements and, thus, multiple IDs. In that case, this method should return an ID value that corresponds to the first ID in the widget's tags.

def value_from_datadict(self, data, files, name):
Given a dictionary of data and this widget's name, return the value of this widget or None if it's not provided.
def value_omitted_from_data(self, data, files, name):
media =

Undocumented

template_name: str =

Undocumented

widgets =

Undocumented

widgets_names =

Undocumented

@property
is_hidden =

Undocumented

@property
needs_multipart_form =