gocept.autocomplete 0.7

自动完成小部件

gocept.autocomplete为z3c.form提供了一个自动完成小部件。如果您想为字段提供一个建议列表，但又想接受任何其他输入，则此小部件很有用。

要使用小部件，请使用 <include package=”gocept.autocomplete”> 并提供一个实现 gocept.autocomplete.interfaces.ISearchableSource 的源。这意味着两点，一是您的源必须提供搜索()方法，以便可以查询值（使用已输入的内容作为查询），二是您必须始终从 __contains__() 方法返回 True，以便用户可以自由输入不属于建议的值。

无需进一步配置，小部件会自动注册到所有带有 ISearchableSource 的 zope.schema.IChoice 字段。

例如，我们使用 testbrowser 运行 gocept.autocomplete.tests.color 中的代码。

>>> import zope.app.testing.functional
>>> root = zope.app.testing.functional.getRootFolder()
>>> import gocept.autocomplete.tests.color
>>> house = gocept.autocomplete.tests.color.House()
>>> root['house'] = house

>>> import zope.testbrowser.testing
>>> b = zope.testbrowser.testing.Browser()
>>> b.handleErrors = False

自动完成小部件是增强型 TextWidget。因此，在显示模式下，它表现得就像一个 TextWidget。

>>> b.open('http://localhost/house')
>>> print b.contents
<?xml...
...<span id="form-widgets-color" class="text-widget autocomplete required choice-field"></span>...

但在编辑模式下，它会产生额外的 JavaScript 代码。

>>> b.addHeader('Authorization', 'Basic mgr:mgrpw')
>>> b.open('http://localhost/house')
>>> print b.contents
<?xml...
...<script src=".../autocomplete-min.js"...
...<input id="form-widgets-color"...
...<div id="form-widgets-color-container"...
...DS_XHR("http://localhost/house/@@index.html/++widget++color/@@autocomplete-search"...
...new YAHOO.widget.AutoComplete( "form-widgets-color", "form-widgets-color-container"...

自动完成通过在部件上注册的视图来填充。

>>> b.open('http://localhost/house/@@index.html/++widget++color/@@autocomplete-search')
>>> print b.contents
>>> b.open('http://localhost/house/@@index.html/++widget++color/@@autocomplete-search?q=r')
>>> print b.contents
red
ruby

但我们仍然可以输入任何我们想要的值并保存它（使此功能工作需要两个部分，一是源必须在 __contains__() 方法中始终返回 True，二是部件使用一个特殊的 TitledTokenizedTerm，该 TitledTokenizedTerm 使用实际值作为一切）。

>>> b.open('http://localhost/house')
>>> b.getControl('Color').value = 'foo'
>>> b.getControl(name='form.buttons.apply').click()
>>> print b.contents
<?xml...
...foo...

分组表单

一个特殊案例是分组表单，它们在其组中提供字段定义。为此，我们设置了一个公寓组和一个表单。

>>> apartment = gocept.autocomplete.tests.color.Apartment()
>>> root['apartment'] = apartment

分组表单的部件遍历返回正确的搜索结果。

>>> b.open('http://localhost/apartment/@@grouped.html/++widget++color/@@autocomplete-search?q=r')
>>> print b.contents
red
ruby
>>> b.open('http://localhost/apartment/@@grouped.html/++widget++number/@@autocomplete-search?q=1')
>>> print b.contents
12A
12

开发 gocept.autocomplete

作者：

gocept <mail@gocept.com>

PyPI 页面：

http://pypi.python.org/pypi/gocept.autocomplete/

问题跟踪器：

https://bitbucket.org/gocept/gocept.autocomplete/issues/

源代码：

https://bitbucket.org/gocept/gocept.autocomplete/

当前变更日志：

https://bitbucket.org/gocept/gocept.autocomplete/src/tip/CHANGES.txt

Buildout 配置

此软件包附带一个最小的 buildout 配置，允许运行测试。

$ python bootstrap.py
$ bin/buildout
$ bin/test

变更