• 第一个Form类

    第一个Form类

    Django带有一个form库,称为django.forms,这个库可以处理我们本章所提到的包括HTML表单显示以及验证。 接下来我们来深入了解一下form库,并使用她来重写contact表单应用。

    Django的newforms库

    在Django社区上会经常看到django.newforms这个词语。当人们讨论django.newforms,其实就是我们本章里面介绍的django.forms。

    改名其实有历史原因的。 当Django一次向公众发行时,它有一个复杂难懂的表单系统:django.forms。后来它被完全重写了,新的版本改叫作:django.newforms,这样人们还可以通过名称,使用旧版本。 当Django 1.0发布时,旧版本django.forms就不再使用了,而django.newforms也终于可以名正言顺的叫做:django.forms

    表单框架最主要的用法是,为每一个将要处理的HTML的<Form> 定义一个Form类。 在这个例子中,我们只有一个<Form> ,因此我们只需定义一个Form类。 这个类可以存在于任何地方,甚至直接写在views.py 文件里也行,但是社区的惯例是把Form类都放到一个文件中:forms.py。在存放views.py 的目录中,创建这个文件,然后输入:

    1. from django import forms
    2. class ContactForm(forms.Form):
    3. subject = forms.CharField()
    4. email = forms.EmailField(required=False)
    5. message = forms.CharField()

    这看上去简单易懂,并且很像在模块中使用的语法。 表单中的每一个字段(域)作为Form类的属性,被展现成Field类。这里只用到CharFieldEmailField类型。 每一个字段都默认是必填。要使email成为可选项,我们需要指定required=False

    让我们钻研到Python解释器里面看看这个类做了些什么。 它做的第一件事是将自己显示成HTML:

    1. >>> from contact.forms import ContactForm
    2. >>> f = ContactForm()
    3. >>> print f
    4. <tr><th><label for="id_subject">Subject:</label></th><td><input type="text" name="subject" id="id_subject" /></td></tr>
    5. <tr><th><label for="id_email">Email:</label></th><td><input type="text" name="email" id="id_email" /></td></tr>
    6. <tr><th><label for="id_message">Message:</label></th><td><input type="text" name="message" id="id_message" /></td></tr>

    为了便于访问,Django用&lt;label&gt; 标志,为每一个字段添加了标签。 这个做法使默认行为尽可能合适。

    默认输出按照HTML的<table >格式,另外有一些其它格式的输出:

    1. >>> print f.as_ul()
    2. <li><label for="id_subject">Subject:</label> <input type="text" name="subject" id="id_subject" /></li>
    3. <li><label for="id_email">Email:</label> <input type="text" name="email" id="id_email" /></li>
    4. <li><label for="id_message">Message:</label> <input type="text" name="message" id="id_message" /></li>
    5. >>> print f.as_p()
    6. <p><label for="id_subject">Subject:</label> <input type="text" name="subject" id="id_subject" /></p>
    7. <p><label for="id_email">Email:</label> <input type="text" name="email" id="id_email" /></p>
    8. <p><label for="id_message">Message:</label> <input type="text" name="message" id="id_message" /></p>

    请注意,标签<table>、<ul>、<form>的开闭合标记没有包含于输出当中,这样你就可以添加额外的行或者自定义格式。

    这些类方法只是一般情况下用于快捷显示完整表单的方法。 你同样可以用HTML显示个别字段:

    1. >>> print f['subject']
    2. <input type="text" name="subject" id="id_subject" />
    3. >>> print f['message']
    4. <input type="text" name="message" id="id_message" />

    Form对象做的第二件事是校验数据。 为了校验数据,我们创建一个新的对Form象,并且传入一个与定义匹配的字典类型数据:

    1. >>> f = ContactForm({'subject': 'Hello', 'email': 'adrian@example.com', 'message': 'Nice site!'})

    一旦你对一个Form实体赋值,你就得到了一个绑定form:

    1. >>> f.is_bound
    2. True

    调用任何绑定form的is_valid()方法,就可以知道它的数据是否合法。 我们已经为每个字段传入了值,因此整个Form是合法的:

    1. >>> f.is_valid()
    2. True

    如果我们不传入email值,它依然是合法的。因为我们指定这个字段的属性required=False

    1. >>> f = ContactForm({'subject': 'Hello', 'message': 'Nice site!'})
    2. >>> f.is_valid()
    3. True

    但是,如果留空subjectmessage,整个Form就不再合法了:

    1. >>> f = ContactForm({'subject': 'Hello'})
    2. >>> f.is_valid()
    3. False
    4. >>> f = ContactForm({'subject': 'Hello', 'message': ''})
    5. >>> f.is_valid()
    6. False

    你可以逐一查看每个字段的出错消息:

    1. >>> f = ContactForm({'subject': 'Hello', 'message': ''})
    2. >>> f['message'].errors
    3. [u'This field is required.']
    4. >>> f['subject'].errors
    5. []
    6. >>> f['email'].errors
    7. []

    每一个邦定Form实体都有一个errors属性,它为你提供了一个字段与错误消息相映射的字典表。

    1. >>> f = ContactForm({'subject': 'Hello', 'message': ''})
    2. >>> f.errors
    3. {'message': [u'This field is required.']}

    最终,如果一个Form实体的数据是合法的,它就会有一个可用的cleaned_data属性。 这是一个包含干净的提交数据的字典。 Django的form框架不但校验数据,它还会把它们转换成相应的Python类型数据,这叫做清理数据。

    1. >>> f = ContactForm({subject': Hello, email: adrian@example.com, message: Nice site!})
    2. >>> f.is_valid()
    3. True
    4. >>> f.cleaned_data
    5. {message': uNice site!, email: uadrian@example.com, subject: uHello}

    我们的contact form只涉及字符串类型,它们会被清理成Unicode对象。如果我们使用整数型或日期型,form框架会确保方法使用合适的Python整数型或datetime.date型对象。