dolmen.forms.base 1.2.1

应用值

我们创建我们的测试模型

>>> from zope.schema import TextLine, Choice
>>> from zope.interface import Interface, implements

>>> class ICaveman(Interface):
...    name = TextLine(title=u'a name')
...    weapon = Choice(title=u'a weapon',
...                    values=[u'none', u'a club', u'a spear'])

>>> class Neanderthal(object):
...    implements(ICaveman)
...    def __init__(self):
...       self.name = u"no name"
...       self.weapon = u"none"

>>> moshe = Neanderthal()
>>> moshe.name
u'no name'
>>> moshe.weapon
u'none'

我们现在可以使用第一个函数 set_fields_data。它接受字段列表、通过 Fields 集合提取的内容以及数据字典。此调用的结果是一个字典，其中包含字段定义的接口和字段标识符作为值。

>>> from dolmen.forms.base import Fields, set_fields_data

>>> fields = Fields(ICaveman)
>>> for field in fields: print field
<TextLineField a name>
<ChoiceField a weapon>

>>> data = {u'name': u'Grok', u'weapon': u'a club'}

>>> changes = set_fields_data(fields, moshe, data)
>>> print changes
{<InterfaceClass __builtin__.ICaveman>: [u'weapon', u'name']}

>>> moshe.name
u'Grok'
>>> moshe.weapon
u'a club'

数据字典的值可以包含标记，以警告可能的特殊情况：值缺失或没有变化。在这两种情况下，跳过值分配。

>>> from dolmen.forms.base import NO_VALUE, NO_CHANGE
>>> data = {u'name': NO_VALUE, u'weapon': NO_CHANGE}

>>> changes = set_fields_data(fields, moshe, data)
>>> print changes
{}

为事件生成更改属性

生成更改字典的一个优点是可以触发了解更改格式的特定事件。例如，IObjectModifiedEvent 使用更改日志来触发修改字段的重新索引。函数 notify_changes 专门用于通知特定事件已应用的更改。它接受内容、更改字典和事件作为参数。如果省略事件参数，则默认使用 ObjectModifiedEvent。

首先我们生成一个更改字典

>>> data = {u'name': u'Grok', u'weapon': u'a club'}
>>> changes = set_fields_data(fields, moshe, data)
>>> print changes
{<InterfaceClass __builtin__.ICaveman>: [u'weapon', u'name']}

现在我们可以为IObjectModifiedEvent设置一个记录器，以检查更改是否被广播

>>> from zope.component import adapter, provideHandler
>>> from zope.lifecycleevent import IObjectModifiedEvent
>>> from zope.event import subscribers


>>> logger = []

>>> @adapter(ICaveman, IObjectModifiedEvent)
... def changes_broadcasted(content, event):
...    logger.append(event.descriptions)

>>> provideHandler(changes_broadcasted)

现在我们可以将其传递给函数

>>> from dolmen.forms.base import notify_changes
>>> change_log = notify_changes(moshe, changes)

记录器必须已被触发。我们可以检查其值

>>> logger
[(<zope.lifecycleevent.Attributes object at ...>,)]

>>> for attrs in logger[0]:
...     print attrs.interface, attrs.attributes
<InterfaceClass __builtin__.ICaveman> (u'weapon', u'name')

声明不变性

>>> from zope.schema import Password
>>> from zope.interface import invariant, Interface
>>> from zope.interface.exceptions import Invalid

>>> class IPasswords(Interface):
...     passwd = Password(
...         title=u"Password",
...         description=u"Type the password.",
...         required=True)
...
...     verify = Password(
...         title=u"Password checking",
...         description=u"Retype the password.",
...         required=True)
...
...     @invariant
...     def check_pass(data):
...         if data.passwd != data.verify:
...             raise Invalid(u"Mismatching passwords!")

>>> from zeam.form.base import Fields
>>> from grokcore.component import testing

>>> class MyForm(ApplicationForm):
...     ignoreContent = True
...     ignoreRequest = False
...     fields = Fields(IPasswords)

默认行为

>>> form = MyForm(item, request)
>>> form.update()
>>> form.updateForm()
>>> data, errors = form.extractData()

>>> print data
{'passwd': <Marker NO_VALUE>, 'verify': <Marker NO_VALUE>}

>>> for error in errors:
...     print error.title
Missing required value.
Missing required value.
There were errors.

>>> for error in form.formErrors:
...     print error.title
There were errors.

计算错误

>>> post = TestRequest(form = {'form.field.passwd': u'test',
...                            'form.field.verify': u'fail'})
>>> form = MyForm(item, post)
>>> form.update()
>>> form.updateForm()
>>> data, errors = form.extractData()

>>> print data
{'passwd': u'test', 'verify': u'fail'}

返回的错误是错误组件的集合。使用表单前缀作为标识符，它逻辑上封装了由不变性验证创建的所有错误

>>> for error in form.formErrors:
...     print error.title
Mismatching passwords!

>>> form.errors.get(form.prefix) == form.formErrors[0]
True

混合字段

有两种类型的字段，一种来自zeam.form.base，另一种来自zope.schema。它们都可以在表单中使用，单独或混合使用

>>> from zeam.form.base import Field
>>> from dolmen.forms.base import Fields
>>> class MixedForm(ApplicationForm):
...     ignoreContent = True
...     ignoreRequest = False
...     fields = Fields(IPasswords) + Field(u'Name')

>>> mixedform = MixedForm(item, post)
>>> mixedform.update()
>>> [x.title for x in mixedform.fields]
[u'Password', u'Password checking', u'Name']

>>> mixedform.updateForm()
>>> data, errors = mixedform.extractData()

>>> print form.formErrors
[<Error Mismatching passwords!>]

>>> for error in form.formErrors:
...     print error.title
Mismatching passwords!

1.2.1 (2014-11-20)

• 更新了‘application_url’方法，使其能够与grokcore堆栈的最新更改一起工作。还更新了独立构建包中的版本。

1.2 (2014-11-18)

• 向表单添加了application_url和flash方法。这导致了使用grokcore.site，现在是一个依赖项。

1.1 (2014-06-18)

• grokcore.layout取代了megrok.layout。所有导入和测试都已相应更改。

1.0 (2012-10-24)

• 修复了相关包的新依赖项和更改。

1.0b3 (2010-10-27)

• 实用方法set_fields_data现在确保，即使数据条目没有相应的字段，它也不会引发错误，正如它应该做的那样。

1.0b2 (2010-10-20)

• 现在在表单中可以使用zeam.form和zope.schema字段。已对行内验证进行了更改，以处理这两种类型。

• 现在我们使用来自zeam.form.base表单的formErrors而不是我们自己的formError方法。

• InvariantsValidation现在通过zeam.form.base 1.0引入的dataValidators机制声明。

• 该包现在在Grok 1.2下进行测试。

1.0b1 (2010-06-25)

• 该软件包现在使用最新版本的 zeam.form.base，它将 extractData 和 validateData 分离。这使得以更清晰的方式验证不变性，无需覆盖通用代码。

• 不变性验证中的 DeprecationWarning 已消失。现在使用异常的表示形式，而不是 message 属性。

• 该软件包现在公开了基 zeam.form 标记。

1.0a2（2010-06-25）

• ApplicationForm 现在验证接口的不变性。

• ApplicationForm 现已本地化，因为它提供了上下文 i18nLanguage 属性。

• 添加了测试

1.0a1（2010-06-02）

• 添加了一个基础表单模型： ApplicationForm

• dolmen.forms.base 现在不再使用 z3c.form，而是基于 zeam.form 表单框架

• 添加了几个辅助函数，用于提取更改属性和通知事件

• 添加了测试

0.1 (2009-10-25)

• 初始发布