Django Form Utils 技术文档

安装指南

安装方式

1. 使用 pip 安装 django-form-utils：

   pip install django-form-utils
   

2. 在 Django 项目的 settings.py 文件中，将 form_utils 添加到 INSTALLED_APPS 列表中：

   INSTALLED_APPS = [
       ...
       'form_utils',
       ...
   ]
   

依赖项

• django-form-utils 支持 Django 1.4 及以上版本，Python 2.6、2.7 和 3.3。
• ImageWidget 需要 Python Imaging Library。
• AutoResizeTextarea 需要 jQuery。

项目使用说明

BetterForm 和 BetterModelForm

BetterForm 和 BetterModelForm 是 django.forms.Form 和 django.forms.ModelForm 的子类，允许将表单划分为多个字段集（fieldsets），并在模板中迭代这些字段集。还可以为每个字段定义 row_attrs，以便在模板中为字段容器添加属性。

示例

from form_utils.forms import BetterForm

class MyForm(BetterForm):
    one = forms.CharField()
    two = forms.CharField()
    three = forms.CharField()

    class Meta:
        fieldsets = [
            ('main', {'fields': ['two'], 'legend': ''}),
            ('Advanced', {'fields': ['three', 'one'], 'description': 'advanced stuff', 'classes': ['advanced', 'collapse']})
        ]
        row_attrs = {'one': {'style': 'display: none'}}

字段集（Fieldsets）

字段集定义类似于 ModelAdmin 的字段集定义。每个字段集是一个包含名称和选项字典的二元组。选项字典中的有效选项包括：

• fields：必填，字段名称的元组。
• classes：应用于字段集的额外 CSS 类。
• legend：字段集的标题。
• description：字段集的描述文本。

行属性（Row Attributes）

row_attrs 是一个字典，映射字段名称到属性值字典。属性值字典将被展平为 HTML 样式的属性值对，并作为 row_attrs 属性提供给 BoundField。

渲染

可以使用以下模板来渲染 BetterForm：

{% if form.non_field_errors %}{{ form.non_field_errors }}{% endif %}
{% for fieldset in form.fieldsets %}
  <fieldset class="{{ fieldset.classes }}">
    {% if fieldset.legend %}
      <legend>{{ fieldset.legend }}</legend>
    {% endif %}
    {% if fieldset.description %}
      <p class="description">{{ fieldset.description }}</p>
    {% endif %}
    <ul>
      {% for field in fieldset %}
        {% if field.is_hidden %}
          {{ field }}
        {% else %}
          <li{{ field.row_attrs }}>
            {{ field.errors }}
            {{ field.label_tag }}
            {{ field }}
          </li>
        {% endif %}
      {% endfor %}
    </ul>
  </fieldset>
{% endfor %}

项目 API 使用文档

实用模板过滤器

django-form-utils 提供了一些有用的模板过滤器，帮助模板作者在不修改 Python 代码的情况下自定义表单渲染。

label

渲染给定表单字段的标签标签。默认使用 Python 定义的标签文本，但可以通过过滤器参数提供备用标签文本。

{{ form.fieldname|label:"Alternate label" }}

value_text

以人类可读的方式显示给定表单字段的当前值。

{{ form.fieldname|value_text }}

selected_values

类似于 value_text，但用于多选表单字段，返回选定值的列表。

<ul>
  {% for selected_value in form.multiselect|selected_values %}
    <li>{{ selected_value }}</li>
  {% endfor %}
</ul>

optional

如果给定字段是可选的，则返回 True，否则返回 False。

{% if form.fieldname|optional %}(optional){% endif %}

is_checkbox

如果给定字段的控件是 CheckboxInput，则返回 True，否则返回 False。

{% if form.fieldname|is_checkbox %}
  {{ form.fieldname }}
  {{ form.fieldname|label }}
{% else %}
  {{ form.fieldname|label }}
  {{ form.fieldname }}
{% endif %}

is_multiple

如果给定字段是 MultipleChoiceField，则返回 True，否则返回 False。

{% if form.fieldname|is_multiple %}
  {% for value in form.fieldname|selected_values %}{{ value }} {% endif %}
{% else %}
  {{ form.fieldname|value_text }}
{% endif %}

项目安装方式

使用 pip 安装

pip install django-form-utils

添加到 INSTALLED_APPS

在 settings.py 中添加 form_utils：

INSTALLED_APPS = [
    ...
    'form_utils',
    ...
]

自定义模板

可以通过提供自定义模板来覆盖默认的表单渲染模板：

templates/form_utils/better_form.html
templates/form_utils/form.html