FormAutoConfig
==============

Base class: `AutoConfig`

Refinable members
-----------------


`default_included`
^^^^^^^^^^^^^^^^^^

Type: `bool`


Cookbook:
    :ref:`show-fields`


`exclude`
^^^^^^^^^

A list of attribute names to exclude, use `__` to drill down to nested attributes. Example: `['album', 'album__year']`

Type: `list[str] | None`


Cookbook:
    :ref:`show-fields`


`include`
^^^^^^^^^

A list of attribute names to include, use `__` to drill down to nested attributes. Example: `['album', 'album__year']`. A list item may also be a dict carrying the attribute path under its `attr` key, with the remaining keys passed as additional configuration to that entry. Example: `['album', dict(attr='album__year', display_name='Year')]`

Type: `list[str | dict] | None`

    See :ref:`include <include>`


Cookbook:
    :ref:`show-fields`


`instance`
^^^^^^^^^^

An instance of a Django model. If this field is specified, the `model` attribute will be automatically derived. This cannot be a callable, in that case set `model` and use `instance=lambda...` instead of `auto__instance`.


Cookbook:
    :ref:`reverse-fk-form`

    :ref:`field-non-editable`

    :ref:`form-redirect`


`model`       (:ref:`evaluated <evaluate>`)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A Django model class

Type: `type[Model] | None`


Cookbook:
    :ref:`show-fields`

    :ref:`form-save-hooks`


`type`
^^^^^^


Cookbook:
    :ref:`create-or-edit-forms`