{
"info": {
"author": "Zope Corporation and Contributors",
"author_email": "zope-dev@zope.org",
"bugtrack_url": null,
"classifiers": [
"Environment :: Web Environment",
"Framework :: Zope :: 3",
"Intended Audience :: Developers",
"License :: OSI Approved :: Zope Public License",
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Internet :: WWW/HTTP"
],
"description": "The zc.form package is a possibly temporary appendage used to hold extra\nbrowser widgets and alternative approaches to code found in the\nzope.formlib package. Most or all of the code is created by Zope\nCorporation and is intended for eventual folding into the main Zope 3\nrelease.\n\n\n.. contents::\n\n=======\nChanges\n=======\n\n1.1 (2019-02-11)\n----------------\n\n- Fix ZCML configuration issue if the ``[mruwidget]`` extra was not installed.\n\n\n1.0 (2019-01-11)\n----------------\n\nFeatures\n++++++++\n\n- Claim support for Python 3.5, 3.6, 3.7, PyPy and PyPy3.\n\nBugfixes\n++++++++\n\n- Fix a ``NameError`` in ``BaseVocabularyDisplay.render()``.\n\n- Actually pass a ``missing_value`` set on the ``Combination`` field to the\n containing fields.\n\nCaveats\n+++++++\n\n- Installation of ``MruSourceInputWidget`` and ``TimeZoneWidget`` requires the\n ``[mruwidget]`` extra to break dependency on ``zc.resourcelibrary`` for\n projects which do not need it.\n\n\n0.5 (2016-08-02)\n----------------\n\n- Bind fields that are contained in a ``zc.form.field.Combination`` to fix the\n ``context`` of those fields.\n\n\n0.4 (2016-01-12)\n----------------\n\n- Get rid of the `zope.app.pagetemplate` dependency.\n\n\n0.3 (2014-04-23)\n----------------\n\n- Remove requirement, that ``zc.form.field.Combination`` needs at least\n two subfields.\n\n\n0.2 (2011-09-24)\n----------------\n\n- Got rid of ``zope.app.form`` dependency by requiring at least\n ``zope.formlib`` 4.0.\n\n- Got rid of ``zope.app.component`` dependency by requiring at least\n ``zope.component`` 3.8.\n\n- Depending on ``zope.catalog`` instead of ``zope.app.catalog``.\n\n- Depending on ``zope.security`` instead of ``zope.app.security``.\n\n- Depending on ``zope.app.wsgi`` >=3.7 instead of ``zope.app.testing`` for\n test setup.\n\n- Depending on ``zope.browserpage`` and ``zope.container`` instead of\n ``zope.app.publisher``.\n\n- Got rid of the following dependencies:\n\n - ``zope.app.basicskin``\n - ``zope.app.securitypolicy``\n - ``zope.app.zapi``\n - ``zope.app.zcmlfiles``\n\n- Fixed tests to run with ``zope.schema`` >= 3.6.\n\n- Made package fit to run on ZTK 1.1.\n\n- Moved test dependencies to `test` extra.\n\n- Using Python's ``doctest`` module instead of deprecated\n ``zope.testing.doctest``.\n\n\n0.1\n---\n\n- Exception views are now unicode aware. They used to break on translated\n content.\n\n- Added use_default_for_not_selected to Union field to use default\n value even if sub field is not selected.\n\n\n===================\n CombinationWidget\n===================\n\nThe combinationwidget collects two or more subfields to provide a convenient\nway to specify a sequence of values.\n\nRendering the widget returns a table with the subfields::\n\n >>> from zc.form.browser.combinationwidget import (\n ... CombinationWidget, CombinationDisplayWidget, default_template)\n >>> from zope import component, interface\n >>> component.provideAdapter(default_template, name='default')\n >>> from zc.form.field import Combination, OrderedCombinationConstraint\n >>> from zope.schema import Int\n >>> from zope.schema.interfaces import IInt\n >>> from zope.publisher.interfaces.browser import IBrowserRequest\n >>> from zope.formlib.interfaces import IInputWidget\n >>> from zope.formlib.textwidgets import IntWidget\n >>> component.provideAdapter(\n ... IntWidget, (IInt, IBrowserRequest), IInputWidget)\n >>> from zope import interface\n >>> class IDemo(interface.Interface):\n ... acceptable_count = Combination(\n ... (Int(title=u'Minimum', required=True, min=0),\n ... Int(title=u'Maximum', required=False)),\n ... title=u'Acceptable Count',\n ... required=False,\n ... constraints=(OrderedCombinationConstraint(),))\n ...\n >>> from zope.publisher.browser import TestRequest\n >>> request = TestRequest()\n >>> widget = CombinationWidget(IDemo['acceptable_count'], request)\n >>> widget.setPrefix('field')\n >>> widget.loadValueFromRequest() # None\n >>> print(widget())\n \n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n\nSetting the appropriate values in the Request lets the widget correctly read\nthe specified value::\n\n >>> request.form['field.acceptable_count-marker'] = 'x'\n >>> request.form['field.acceptable_count.combination_00'] = '10'\n >>> request.form['field.acceptable_count.combination_01'] = ''\n >>> widget = CombinationWidget(IDemo['acceptable_count'], request)\n >>> widget.setPrefix('field')\n >>> widget.getInputValue()\n (10, None)\n >>> print(widget())\n <...\n ......\n ......\n\n\nThe field is fine with empty values, because it is not required::\n\n >>> request.form['field.acceptable_count-marker'] = 'x'\n >>> request.form['field.acceptable_count.combination_00'] = ''\n >>> request.form['field.acceptable_count.combination_01'] = ''\n >>> widget = CombinationWidget(IDemo['acceptable_count'], request)\n >>> widget.setPrefix('field')\n >>> widget.getInputValue() # None\n >>> print(widget())\n <...\n ......\n ......\n >>> bool(widget.error())\n False\n >>> bool(widget.widgets[0].error())\n False\n\nIf the optional value is filled in and the required one is not, though, there\nare errors::\n\n >>> request.form['field.acceptable_count-marker'] = 'x'\n >>> request.form['field.acceptable_count.combination_00'] = ''\n >>> request.form['field.acceptable_count.combination_01'] = '10'\n >>> widget = CombinationWidget(IDemo['acceptable_count'], request)\n >>> widget.setPrefix('field')\n >>> widget.getInputValue()\n Traceback (most recent call last):\n WidgetInputError: ('acceptable_count', u'Acceptable Count',\n WidgetInputError('combination_00', u'Minimum',\n RequiredMissing('combination_00')))\n >>> import zope.formlib.interfaces\n >>> import zope.publisher.interfaces.browser\n >>> @interface.implementer(zope.formlib.interfaces.IWidgetInputErrorView)\n ... @component.adapter(zope.formlib.interfaces.WidgetInputError,\n ... zope.publisher.interfaces.browser.IBrowserRequest)\n ... class SnippetView(object):\n ...\n ... def __init__(self, context, request):\n ... self.context = context\n ... self.request = request\n ... def snippet(self):\n ... return self.context.doc()\n ...\n >>> component.provideAdapter(SnippetView)\n >>> print(widget())\n <...\n ......\n ...Required input is missing...\n ......\n >>> print(widget.error())\n Required input is missing.\n >>> print(widget.widgets[0].error())\n Required input is missing.\n\nSimilarly, if the field's constraints are not met, the widget shows errors::\n\n >>> request.form['field.acceptable_count-marker'] = 'x'\n >>> request.form['field.acceptable_count.combination_00'] = '20'\n >>> request.form['field.acceptable_count.combination_01'] = '10'\n >>> widget = CombinationWidget(IDemo['acceptable_count'], request)\n >>> widget.setPrefix('field')\n >>> widget.getInputValue()\n Traceback (most recent call last):\n WidgetInputError: ('acceptable_count', u'Acceptable Count',\n MessageValidationError(u'${minimum} ...\n >>> print(widget())\n <...\n ...input class=\"textType\" id=\"field.acceptable_count.combination_00\"\n name=\"field.acceptable_count.combination_00\" size=\"10\"\n type=\"text\" value=\"20\" />...\n ......\n >>> print(widget.error())\n ${minimum} must be less than or equal to ${maximum}.\n\n\nThere's also a display version of the widget::\n\n >>> request = TestRequest()\n >>> from zope.formlib.widget import DisplayWidget\n >>> from zope.formlib.interfaces import IDisplayWidget\n >>> component.provideAdapter(\n ... DisplayWidget, (IInt, IBrowserRequest), IDisplayWidget)\n >>> widget = CombinationDisplayWidget(IDemo['acceptable_count'], request)\n >>> widget.setPrefix('field')\n >>> widget.setRenderedValue(('10', '2'))\n >>> print(widget())\n \n
\n
\n
\n \n
\n
\n
10\n
\n
\n
\n
\n
\n \n
\n
\n
2\n
\n
\n
\n
\n\nIn case of a wrong amount of parameters, the missing_value is used::\n\n >>> field = IDemo['acceptable_count']\n >>> field.missing_value=('23', '42')\n >>> widget = CombinationDisplayWidget(field, request)\n >>> widget.setPrefix('field')\n >>> widget.setRenderedValue(('10', '2', '3'))\n >>> print(widget())\n \n
\n
\n
\n \n
\n
\n
23\n
\n
\n
\n
\n
\n \n
\n
\n
42\n
\n
\n
\n
\n\nIn case the parameter is not a sequence, the missing_value is used::\n\n >>> widget = CombinationDisplayWidget(field, request)\n >>> widget.setPrefix('field')\n >>> widget.setRenderedValue(10)\n >>> print(widget())\n \n
\n
\n
\n \n
\n
\n
23\n
\n
\n
\n
\n
\n \n
\n
\n
42\n
\n
\n
\n
\n\nThe order of label and field are inverted in case of boolean::\n\n >>> request = TestRequest()\n >>> from zope.schema import Bool\n >>> from zope.schema.interfaces import IBool\n >>> from zope.formlib.boolwidgets import CheckBoxWidget\n >>> from zope.formlib.widget import DisplayWidget\n >>> from zope.formlib.interfaces import IDisplayWidget\n >>> component.provideAdapter(\n ... CheckBoxWidget, (IBool, IBrowserRequest), IInputWidget)\n >>> class IBoolDemo(interface.Interface):\n ... choices = Combination(\n ... (Bool(title=u'first'),\n ... Bool(title=u'second')),\n ... title=u'Choices',\n ... required=False,)\n\n >>> widget = CombinationWidget(IBoolDemo['choices'], request)\n >>> widget.setPrefix('field')\n >>> print(widget())\n \n
\n
\n
\n
\n
\n first\n
\n
\n
\n
\n
\n
\n
\n second\n
\n
\n
\n
\n\n\n\n========================================\n Most Recently Used (MRU) Source Widget\n========================================\n\nThe MRU widget keeps track of the last few values selected (on a per-principal\nbasis) and allows quickly selecting from that list instead of using a query\ninterface.\n\nWe can see the widget in action by using a custom form. Let's define a schema\nfor the form that uses a source::\n\n >>> import zope.interface\n >>> import zope.schema\n\n >>> class IDemo(zope.interface.Interface):\n ...\n ... color = zope.schema.Choice(\n ... title=u\"Color\",\n ... description=u\"My favorite color\",\n ... source=AvailableColors,\n ... )\n\nAnd then a class that implements the interface::\n\n >>> @zope.interface.implementer(IDemo)\n ... class Demo(object):\n ...\n ... color = None\n\nWe'll need a form that uses this schema::\n\n >>> import zope.formlib.form\n\n >>> class DemoInput(zope.formlib.form.EditForm):\n ... actions = ()\n ... form_fields = zope.formlib.form.fields(IDemo)\n\nBy rendering the form we can see that there are no MRU items to choose from\n(because this principal has never visited this form before) and the query\ninterface is displayed::\n\n >>> import zope.publisher.browser\n >>> import zope.security.interfaces\n >>> import zope.security.management\n >>> import zope.component.hooks\n\n >>> @zope.interface.implementer(zope.security.interfaces.IPrincipal)\n ... class DummyPrincipal(object):\n ...\n ... id = \"someuser\"\n ... title = \"Some User's Name\"\n ... description = \"A User\"\n\nNote that we need to use the special resourcelibrary request. We're\nhacking together the TestRequest and the resourcelibrary request here; when we\nswitch to TestBrowser we can remove this oddity.\n\n >>> import zc.resourcelibrary.publication\n >>> class TestRequest(zope.publisher.browser.TestRequest,\n ... zc.resourcelibrary.publication.Request):\n ... def _createResponse(self):\n ... return zc.resourcelibrary.publication.Request._createResponse(\n ... self)\n ...\n\n >>> request = TestRequest()\n >>> principal = DummyPrincipal()\n >>> request.setPrincipal(principal)\n >>> zope.security.management.newInteraction(request)\n\n >>> oldsite = zope.component.hooks.getSite()\n >>> zope.component.hooks.setSite(getRootFolder())\n\nNow we can use an instance of our demo object to see that the form\npulls the possible values from the vocabulary we've defined above::\n\n >>> form = DemoInput(Demo(), request)\n >>> print(form())\n <...\n
\n
\n
\n \n
\n
\n
\n ...\n\nNote that the select box of MRU values isn't in the output, because the user\nhas never selected a value before::\n\n >>> '