Функции форм модели

Справочник по API форм модели. Для ознакомления с формами модели см. руководство Создание форм из моделей.

modelform_factory

modelform_factory(model, form=ModelForm, fields=None, exclude=None, formfield_callback=None, widgets=None, localized_fields=None, labels=None, help_texts=None, error_messages=None, field_classes=None)

Возвращает класс ModelForm для заданной model. Можно дополнительно указать form в качестве начальной точки для построения ModelForm.

fields — это необязательный список имён полей. Если он указан, будут включены только поля с указанными именами.

exclude — это необязательный список имён полей. Если он указан, поля с указанными именами будут исключены из возвращаемых полей, даже если они присутствуют в списке fields.

formfield_callback — это вызываемый объект, принимающий поле модели и возвращающий поле формы.

widgets — это словарь, сопоставляющий имена полей модели с виджетами.

localized_fields — это список имён полей, которые должны быть локализованы.

labels — это словарь, сопоставляющий имена полей модели с метками.

help_texts — это словарь, сопоставляющий имена полей модели с подсказками.

error_messages — это словарь, сопоставляющий имена полей модели с словарем сообщений об ошибках.

field_classes — это словарь, сопоставляющий имена полей модели с классом поля формы.

Пример использования см. в Функция-фабрика для ModelForm.

Необходимо явно указать список полей, либо через ключевые аргументы fields или exclude, либо через соответствующие атрибуты в классе Meta. Подробнее см. в разделе Выбор полей для использования. Если определения полей отсутствуют, будет возбуждено исключение ImproperlyConfigured.

modelformset_factory

modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None, widgets=None, validate_max=False, localized_fields=None, labels=None, help_texts=None, error_messages=None, min_num=None, validate_min=False, field_classes=None)

Возвращает класс FormSet для заданного класса model.

Аргументы model, form, fields, exclude, formfield_callback, widgets, localized_fields, labels, help_texts, error_messages, и field_classes передаются в modelform_factory().

Аргументы formset, extra, max_num, can_order, can_delete и validate_max передаются в formset_factory(). Подробнее см. в разделе formsets.

Пример использования см. в Наборы форм модели.

inlineformset_factory

inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None, widgets=None, validate_max=False, localized_fields=None, labels=None, help_texts=None, error_messages=None, min_num=None, validate_min=False, field_classes=None)

Возвращает набор форм InlineFormSet, используя modelformset_factory() с заданными значениями formset=BaseInlineFormSet, can_delete=True, и extra=3.

Если модель содержит более одного ForeignKey к parent_model, необходимо указать fk_name.

Пример использования см. в Вложенные наборы форм.