mirror of https://github.com/django/django.git
41 lines
1.6 KiB
Plaintext
41 lines
1.6 KiB
Plaintext
====================
|
|
Model Form Functions
|
|
====================
|
|
|
|
.. module:: django.forms.models
|
|
:synopsis: Django's functions for building model forms and formsets.
|
|
|
|
.. method:: modelform_factory(model, form=ModelForm, fields=None, exclude=None, formfield_callback=None, widgets=None)
|
|
|
|
Returns a :class:`~django.forms.ModelForm` class for the given ``model``.
|
|
You can optionally pass a ``form`` argument to use as a starting point for
|
|
constructing the ``ModelForm``.
|
|
|
|
``fields`` is an optional list of field names. If provided, only the named
|
|
fields will be included in the returned fields.
|
|
|
|
``exclude`` is an optional list of field names. If provided, the named
|
|
fields will be excluded from the returned fields, even if they are listed
|
|
in the ``fields`` argument.
|
|
|
|
``widgets`` is a dictionary of model field names mapped to a widget.
|
|
|
|
``formfield_callback`` is a callable that takes a model field and returns
|
|
a form field.
|
|
|
|
See :ref:`modelforms-factory` for example usage.
|
|
|
|
.. method:: 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)
|
|
|
|
Returns a ``FormSet`` class for the given ``model`` class.
|
|
|
|
Arguments ``model``, ``form``, ``fields``, ``exclude``, and
|
|
``formfield_callback`` are all passed through to
|
|
:meth:`~django.forms.models.modelform_factory`.
|
|
|
|
Arguments ``formset``, ``extra``, ``max_num``, ``can_order``, and
|
|
``can_delete`` are passed through to ``formset_factory``. See
|
|
:ref:`formsets` for details.
|
|
|
|
See :ref:`model-formsets` for example usage.
|