Model Form Functions

Model Form API reference. For introductory material about model forms, see the从模型创建表单 topic guide.

modelform_factory

  • modelformfactory(_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)[source]
  • Returns a ModelForm class for the given model.You can optionally pass a form argument to use as a starting point forconstructing the ModelForm.

fields is an optional list of field names. If provided, only the namedfields will be included in the returned fields.

exclude is an optional list of field names. If provided, the namedfields will be excluded from the returned fields, even if they are listedin the fields argument.

formfield_callback is a callable that takes a model field and returnsa form field.

widgets is a dictionary of model field names mapped to a widget.

localized_fields is a list of names of fields which should be localized.

labels is a dictionary of model field names mapped to a label.

help_texts is a dictionary of model field names mapped to a help text.

error_messages is a dictionary of model field names mapped to adictionary of error messages.

field_classes is a dictionary of model field names mapped to a formfield class.

See ModelForm的工厂函数 for example usage.

You must provide the list of fields explicitly, either via keyword argumentsfields or exclude, or the corresponding attributes on the form'sinner Meta class. See 选择要使用的字段 for moreinformation. Omitting any definition of the fields to use will result inan ImproperlyConfigured exception.

modelformset_factory

  • modelformsetfactory(_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)[source]
  • Returns a FormSet class for the given model class.

Arguments model, form, fields, exclude,formfield_callback, widgets, localized_fields, labels,help_texts, error_messages, and field_classes are all passedthrough to modelform_factory().

Arguments formset, extra, max_num, can_order,can_delete and validate_max are passed through toformset_factory(). See formsets for details.

See 模型表单集 for example usage.

inlineformset_factory

  • inlineformsetfactory(_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)[source]
  • Returns an InlineFormSet using modelformset_factory() withdefaults of formset=BaseInlineFormSet,can_delete=True, and extra=3.

If your model has more than one ForeignKey tothe parent_model, you must specify a fk_name.

See Inline formsets for example usage.