zope.schema-4.4.2/ 0000775 0001750 0001750 00000000000 12402106344 015077 5 ustar tseaver tseaver 0000000 0000000 zope.schema-4.4.2/setup.cfg 0000664 0001750 0001750 00000000433 12402106344 016720 0 ustar tseaver tseaver 0000000 0000000 [nosetests]
nocapture = 1
cover-package = zope.schema
cover-erase = 1
with-doctest = 0
where = src
ignore-files = examples.py
[aliases]
dev = develop easy_install zope.schema[testing]
docs = easy_install zope.schema[docs]
[egg_info]
tag_build =
tag_date = 0
tag_svn_revision = 0
zope.schema-4.4.2/buildout.cfg 0000664 0001750 0001750 00000000231 12312122016 017375 0 ustar tseaver tseaver 0000000 0000000 [buildout]
develop = .
parts =
tox
test
[test]
recipe = zc.recipe.testrunner
eggs = zope.schema [test]
[tox]
recipe = zc.recipe.egg
eggs = tox
zope.schema-4.4.2/PKG-INFO 0000664 0001750 0001750 00000034043 12402106344 016200 0 ustar tseaver tseaver 0000000 0000000 Metadata-Version: 1.1
Name: zope.schema
Version: 4.4.2
Summary: zope.interface extension for defining data schemas
Home-page: http://pypi.python.org/pypi/zope.schema
Author: Zope Foundation and Contributors
Author-email: zope-dev@zope.org
License: ZPL 2.1
Description: zope.schema README
==================
Schemas extend the notion of interfaces to detailed descriptions of
Attributes (but not methods). Every schema is an interface and
specifies the public fields of an object. A *field* roughly
corresponds to an attribute of a Python object. But a Field provides
space for at least a title and a description. It can also constrain
its value and provide a validation method. Besides you can optionally
specify characteristics such as its value being read-only or not
required.
See http://docs.zope.org/zope.schema/ for more information.
zope.schema Changelog
=====================
4.4.2 (2014-09-04)
------------------
- Fix description of min max field: max value is included, not excluded.
4.4.1 (2014-03-19)
------------------
- Added support for Python 3.4.
4.4.0 (2014-01-22)
------------------
- Add an event on field properties to notify that a field has been updated.
This event enables definition of subscribers based on an event, a context
and a field. The event contains also the old value and the new value.
(also see package ``zope.schemaevent`` that define a field event handler)
4.3.3 (2014-01-06)
------------------
- PEP 8 cleanup.
- Don't raise RequiredMissing if a field's defaultFactory returns the field's
missing_value.
- Updated ``boostrap.py`` to version 2.2.
- Add the ability to swallow ValueErrors when rendering a SimpleVocabulary,
allowing for cases where vocabulary items may be duplicated (e.g., due to
user input).
- It was a pain that ``ConstraintNotSatisfied`` did not tell the field name.
4.3.2 (2013-02-24)
------------------
- Fix Python 2.6 support. (Forgot to run tox with all environments before last
release.)
4.3.1 (2013-02-24)
------------------
- Make sure that we do not fail during bytes decoding of term token when
generated from a bytes value by ignoring all errors. (Another option would
have been to hexlify the value, but that would break way too many tests.)
4.3.0 (2013-02-24)
------------------
- Fixed a bug where bytes values were turned into tokens inproperly in
Python 3.
- Added ``createFieldProperties()`` function which maps schema fields into
``FieldProperty`` instances.
4.2.2 (2012-11-21)
------------------
- Added support for Python 3.3.
4.2.1 (2012-11-09)
------------------
- Fix the default property of fields that have no defaultFactory attribute.
4.2.0 (2012-05-12)
------------------
- Automated build of Sphinx HTML docs and running doctest snippets via tox.
- Dropped explicit support for Python 3.1.
- Introduce NativeString and NativeStringLine which are equal to Bytes and
BytesLine on Python 2 and Text and TextLine on Python 3.
- Change IURI from a Bytes string to a "native" string. This is a backwards
incompatibility which only affects Python 3.
- 100% unit test coverage.
- Doctests moved from the package and wired up as normal Sphinx documentation.
- Added explicit support for PyPy.
- Added support for continuous integration using ``tox`` and ``jenkins``.
- Dropped the external ``six`` dependency in favor of a much-trimmed
``zope.schema._compat`` module.
- Tests now pass when run under ``nose``.
- Added ``setup.py dev`` alias (runs ``setup.py develop`` plus installs
``nose`` and ``coverage``).
- Added ``setup.py docs`` alias (installs ``Sphinx`` and dependencies).
4.1.1 (2012-03-23)
------------------
- Remove trailing slash in MANIFEST.in, it causes Winbot to crash.
4.1.0 (2012-03-23)
------------------
- Add TreeVocabulary for nested tree-like vocabularies.
- Fix broken Object field validation where the schema contains a Choice with
ICountextSourceBinder source. In this case the vocabulary was not iterable
because the field was not bound and the source binder didn't return the
real vocabulary. Added simple test for IContextSourceBinder validation. But a
test with an Object field with a schema using a Choice with
IContextSourceBinder is still missing.
4.0.1 (2011-11-14)
------------------
- Fix bug in ``fromUnicode`` method of ``DottedName`` which would fail
validation on being given unicode. Introduced in 4.0.0.
4.0.0 (2011-11-09)
------------------
- Fix deprecated unittest methods.
- Port to Python 3. This adds a dependency on six and removes support for
Python 2.5.
3.8.1 (2011-09-23)
------------------
- fix broken Object field validation. Previous version was using a volatile
property on object field values which ends in a ForbiddenAttribute error
on security proxied objects.
3.8.0 (2011-03-18)
------------------
- Implemented a ``defaultFactory`` attribute for all fields. It is a callable
that can be used to compute default values. The simplest case is::
Date(defaultFactory=datetime.date.today)
If the factory needs a context to compute a sensible default value, then it
must provide ``IContextAwareDefaultFactory``, which can be used as follows::
@provider(IContextAwareDefaultFactory)
def today(context):
return context.today()
Date(defaultFactory=today)
3.7.1 (2010-12-25)
------------------
- The validation token, used in the validation of schema with Object
Field to avoid infinite recursion, has been renamed.
``__schema_being_validated`` became ``_v_schema_being_validated``,
a volatile attribute, to avoid persistency and therefore,
read/write conflicts.
- Don't allow "[\]^`" in DottedName.
https://bugs.launchpad.net/zope.schema/+bug/191236
3.7.0 (2010-09-12)
------------------
- Improve error messages when term tokens or values are duplicates.
- Fix the buildout so the tests run.
3.6.4 (2010-06-08)
------------------
- fix validation of schema with Object Field that specify Interface schema.
3.6.3 (2010-04-30)
------------------
- Prefer the standard libraries doctest module to the one from zope.testing.
3.6.2 (2010-04-30)
------------------
- Avoid maximum recursion when validating Object field that points to cycles
- Made the dependency on ``zope.i18nmessageid`` optional.
3.6.1 (2010-01-05)
------------------
- Allow "setup.py test" to run at least a subset of the tests runnable
via ``bin/test`` (227 for ``setup.py test`` vs. 258. for
``bin/test``)
- Make ``zope.schema._bootstrapfields.ValidatedProperty`` descriptor
work under Jython.
- Make "setup.py test" tests pass on Jython.
3.6.0 (2009-12-22)
------------------
- Prefer zope.testing.doctest over doctestunit.
- Extend validation error to hold the field name.
- Add FieldProperty class that uses Field.get and Field.set methods
instead of storing directly on the instance __dict__.
3.5.4 (2009-03-25)
------------------
- Don't fail trying to validate default value for Choice fields with
IContextSourceBinder object given as a source. See
https://bugs.launchpad.net/zope3/+bug/340416.
- Add an interface for ``DottedName`` field.
- Add ``vocabularyName`` attribute to the ``IChoice`` interface, change
"vocabulary" attribute description to be more sensible, making it
``zope.schema.Field`` instead of plain ``zope.interface.Attribute``.
- Make IBool interface of Bool more important than IFromUnicode so adapters
registered for IBool take precendence over adapters registered for
IFromUnicode.
3.5.3 (2009-03-10)
------------------
- Make Choice and Bool fields implement IFromUnicode interface, because
they do provide the ``fromUnicode`` method.
- Change package's mailing list address to zope-dev at zope.org, as
zope3-dev at zope.org is now retired.
- Fix package's documentation formatting. Change package's description.
- Add buildout part that builds Sphinx-generated documentation.
- Remove zpkg-related file.
3.5.2 (2009-02-04)
------------------
- Made validation tests compatible with Python 2.5 again (hopefully not
breaking Python 2.4)
- Added an __all__ package attribute to expose documentation.
3.5.1 (2009-01-31)
------------------
- Stop using the old old set type.
- Make tests compatible and silent with Python 2.4.
- Fix __cmp__ method in ValidationError. Show some side effects based on the
existing __cmp__ implementation. See validation.txt
- Make 'repr' of the ValidationError and its subclasses more sensible. This
may require you to adapt your doctests for the new style, but now it makes
much more sense for debugging for developers.
3.5.0a2 (2008-12-11)
--------------------
- Move zope.testing to "test" extras_require, as it is not needed
for zope.schema itself.
- Change the order of classes in SET_TYPES tuple, introduced in
previous release to one that was in 3.4 (SetType, set), because
third-party code could be dependent on that order. The one
example is z3c.form's converter.
3.5.0a1 (2008-10-10)
--------------------
- Added the doctests to the long description.
- Removed use of deprecated 'sets' module when running under Python 2.6.
- Removed spurious doctest failure when running under Python 2.6.
- Added support to bootstrap on Jython.
- Added helper methods for schema validation: ``getValidationErrors``
and ``getSchemaValidationErrors``.
- zope.schema now works on Python2.5
3.4.0 (2007-09-28)
------------------
Added BeforeObjectAssignedEvent that is triggered before the object
field sets a value.
3.3.0 (2007-03-15)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.3.0 release.
3.2.1 (2006-03-26)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.2.1 release.
Fixed missing import of 'VocabularyRegistryError'. See
http://www.zope.org/Collectors/Zope3-dev/544 .
3.2.0 (2006-01-05)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.2.0 release.
Added "iterable" sources to replace vocabularies, which are now deprecated
and scheduled for removal in Zope 3.3.
3.1.0 (2005-10-03)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.1.0 release.
Allowed 'Choice' fields to take either a 'vocabulary' or a 'source'
argument (sources are a simpler implementation).
Added 'TimeDelta' and 'ASCIILine' field types.
3.0.0 (2004-11-07)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope X3.0.0 release.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Framework :: Zope3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
zope.schema-4.4.2/tox.ini 0000664 0001750 0001750 00000002122 12312122016 016401 0 ustar tseaver tseaver 0000000 0000000 [tox]
envlist =
# Jython support pending 2.7 support, due 2012-07-15 or so. See:
# http://fwierzbicki.blogspot.com/2012/03/adconion-to-fund-jython-27.html
# py26,py27,py32,jython,pypy,coverage
py26,py27,py32,py33,py34,pypy,coverage,docs
[testenv]
deps =
zope.schema[test]
commands =
python setup.py test -q
[testenv:jython]
commands =
jython setup.py test -q
[testenv:coverage]
basepython =
python2.6
commands =
# The installed version messes up nose's test discovery / coverage reporting
# So, we uninstall that from the environment, and then install the editable
# version, before running nosetests.
pip uninstall -y zope.schema
pip install -e .
nosetests --with-xunit --with-xcoverage
deps =
zope.schema[test]
zope.interface>=3.6.0
zope.event
zope.testing
nose
coverage
nosexcover
[testenv:docs]
basepython =
python2.6
commands =
sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
deps =
zope.interface>=3.6.0
Sphinx
zope.schema-4.4.2/.gitignore 0000664 0001750 0001750 00000000234 12312122016 017060 0 ustar tseaver tseaver 0000000 0000000 *.pyc
__pycache__
.installed.cfg
bin
eggs
develop-eggs
build
docs/_build
parts
*.egg-info
.tox
.coverage
nosetests.xml
coverage.xml
devel
include
lib
local
zope.schema-4.4.2/setup.py 0000664 0001750 0001750 00000010142 12402106212 016601 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2006 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
# This package is developed by the Zope Toolkit project, documented here:
# http://docs.zope.org/zopetoolkit
# When developing and releasing this package, please follow the documented
# Zope Toolkit policies as described by this documentation.
##############################################################################
"""Setup for zope.schema package
"""
import os
import sys
from setuptools import setup, find_packages
def read(*rnames):
return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
def _modname(path, base, name=''):
if path == base:
return name
dirname, basename = os.path.split(path)
return _modname(dirname, base, basename + '.' + name)
def alltests():
import logging
import pkg_resources
import unittest
class NullHandler(logging.Handler):
level = 50
def emit(self, record):
pass
logging.getLogger().addHandler(NullHandler())
suite = unittest.TestSuite()
base = pkg_resources.working_set.find(
pkg_resources.Requirement.parse('zope.schema')).location
for dirpath, dirnames, filenames in os.walk(base):
if os.path.basename(dirpath) == 'tests':
for filename in filenames:
if filename.endswith('.py') and filename.startswith('test'):
mod = __import__(
_modname(dirpath, base, os.path.splitext(filename)[0]),
{}, {}, ['*'])
suite.addTest(mod.test_suite())
elif 'tests.py' in filenames:
continue
mod = __import__(_modname(dirpath, base, 'tests'), {}, {}, ['*'])
suite.addTest(mod.test_suite())
return suite
REQUIRES = [
'setuptools',
'zope.interface >= 3.6.0',
'zope.event',
]
if sys.version_info < (2, 7):
REQUIRES += ['ordereddict']
TESTS_REQUIRE = ['zope.testing']
setup(
name='zope.schema',
version='4.4.2',
url='http://pypi.python.org/pypi/zope.schema',
license='ZPL 2.1',
description='zope.interface extension for defining data schemas',
author='Zope Foundation and Contributors',
author_email='zope-dev@zope.org',
long_description=(read('README.rst') + '\n\n' + read('CHANGES.rst')),
packages=find_packages('src'),
package_dir = {'': 'src'},
namespace_packages=['zope', ],
#extras_require={'docs': ['z3c.recipe.sphinxdoc']},
install_requires=REQUIRES,
classifiers=[
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: Zope Public License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.6",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.2",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Framework :: Zope3",
"Topic :: Software Development :: Libraries :: Python Modules",
],
include_package_data = True,
zip_safe = False,
test_suite='__main__.alltests',
tests_require=TESTS_REQUIRE,
extras_require={
'docs': ['Sphinx'],
'test': TESTS_REQUIRE,
'testing': TESTS_REQUIRE + ['nose', 'coverage'],
},
)
zope.schema-4.4.2/bootstrap.py 0000664 0001750 0001750 00000013066 12167126650 017506 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2006 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Bootstrap a buildout-based project
Simply run this script in a directory containing a buildout.cfg.
The script accepts buildout command-line options, so you can
use the -c option to specify an alternate configuration file.
"""
import os
import shutil
import sys
import tempfile
from optparse import OptionParser
tmpeggs = tempfile.mkdtemp()
usage = '''\
[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
Bootstraps a buildout-based project.
Simply run this script in a directory containing a buildout.cfg, using the
Python that you want bin/buildout to use.
Note that by using --find-links to point to local resources, you can keep
this script from going over the network.
'''
parser = OptionParser(usage=usage)
parser.add_option("-v", "--version", help="use a specific zc.buildout version")
parser.add_option("-t", "--accept-buildout-test-releases",
dest='accept_buildout_test_releases',
action="store_true", default=False,
help=("Normally, if you do not specify a --version, the "
"bootstrap script and buildout gets the newest "
"*final* versions of zc.buildout and its recipes and "
"extensions for you. If you use this flag, "
"bootstrap and buildout will get the newest releases "
"even if they are alphas or betas."))
parser.add_option("-c", "--config-file",
help=("Specify the path to the buildout configuration "
"file to be used."))
parser.add_option("-f", "--find-links",
help=("Specify a URL to search for buildout releases"))
options, args = parser.parse_args()
######################################################################
# load/install setuptools
to_reload = False
try:
import pkg_resources
import setuptools
except ImportError:
ez = {}
try:
from urllib.request import urlopen
except ImportError:
from urllib2 import urlopen
# XXX use a more permanent ez_setup.py URL when available.
exec(urlopen('https://bitbucket.org/pypa/setuptools/raw/0.7.2/ez_setup.py'
).read(), ez)
setup_args = dict(to_dir=tmpeggs, download_delay=0)
ez['use_setuptools'](**setup_args)
if to_reload:
reload(pkg_resources)
import pkg_resources
# This does not (always?) update the default working set. We will
# do it.
for path in sys.path:
if path not in pkg_resources.working_set.entries:
pkg_resources.working_set.add_entry(path)
######################################################################
# Install buildout
ws = pkg_resources.working_set
cmd = [sys.executable, '-c',
'from setuptools.command.easy_install import main; main()',
'-mZqNxd', tmpeggs]
find_links = os.environ.get(
'bootstrap-testing-find-links',
options.find_links or
('http://downloads.buildout.org/'
if options.accept_buildout_test_releases else None)
)
if find_links:
cmd.extend(['-f', find_links])
setuptools_path = ws.find(
pkg_resources.Requirement.parse('setuptools')).location
requirement = 'zc.buildout'
version = options.version
if version is None and not options.accept_buildout_test_releases:
# Figure out the most recent final version of zc.buildout.
import setuptools.package_index
_final_parts = '*final-', '*final'
def _final_version(parsed_version):
for part in parsed_version:
if (part[:1] == '*') and (part not in _final_parts):
return False
return True
index = setuptools.package_index.PackageIndex(
search_path=[setuptools_path])
if find_links:
index.add_find_links((find_links,))
req = pkg_resources.Requirement.parse(requirement)
if index.obtain(req) is not None:
best = []
bestv = None
for dist in index[req.project_name]:
distv = dist.parsed_version
if _final_version(distv):
if bestv is None or distv > bestv:
best = [dist]
bestv = distv
elif distv == bestv:
best.append(dist)
if best:
best.sort()
version = best[-1].version
if version:
requirement = '=='.join((requirement, version))
cmd.append(requirement)
import subprocess
if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0:
raise Exception(
"Failed to execute command:\n%s",
repr(cmd)[1:-1])
######################################################################
# Import and run buildout
ws.add_entry(tmpeggs)
ws.require(requirement)
import zc.buildout.buildout
if not [a for a in args if '=' not in a]:
args.append('bootstrap')
# if -c was provided, we push it back into args for buildout' main function
if options.config_file is not None:
args[0:0] = ['-c', options.config_file]
zc.buildout.buildout.main(args)
shutil.rmtree(tmpeggs)
zope.schema-4.4.2/.travis.yml 0000664 0001750 0001750 00000000275 12164372403 017222 0 ustar tseaver tseaver 0000000 0000000 language: python
python:
- 2.6
- 2.7
- 3.2
- 3.3
- pypy
install:
- pip install . --use-mirrors
script:
- python setup.py test -q
notifications:
email: false
zope.schema-4.4.2/src/ 0000775 0001750 0001750 00000000000 12402106344 015666 5 ustar tseaver tseaver 0000000 0000000 zope.schema-4.4.2/src/coverage.xml 0000664 0001750 0001750 00000131434 12164372720 020221 0 ustar tseaver tseaver 0000000 0000000
zope.schema-4.4.2/src/zope.schema.egg-info/ 0000775 0001750 0001750 00000000000 12402106344 021574 5 ustar tseaver tseaver 0000000 0000000 zope.schema-4.4.2/src/zope.schema.egg-info/top_level.txt 0000664 0001750 0001750 00000000005 12402106344 024321 0 ustar tseaver tseaver 0000000 0000000 zope
zope.schema-4.4.2/src/zope.schema.egg-info/SOURCES.txt 0000664 0001750 0001750 00000005673 12402106344 023473 0 ustar tseaver tseaver 0000000 0000000 .gitignore
.travis.yml
CHANGES.rst
COPYRIGHT.txt
LICENSE.txt
MANIFEST.in
README.rst
bootstrap.py
buildout.cfg
setup.cfg
setup.py
tox.ini
docs/Makefile
docs/conf.py
docs/fields.rst
docs/hacking.rst
docs/index.rst
docs/make.bat
docs/narr.rst
docs/sources.rst
docs/validation.rst
docs/_build/doctest/output.txt
docs/_build/doctrees/environment.pickle
docs/_build/doctrees/fields.doctree
docs/_build/doctrees/hacking.doctree
docs/_build/doctrees/index.doctree
docs/_build/doctrees/narr.doctree
docs/_build/doctrees/sources.doctree
docs/_build/doctrees/validation.doctree
docs/_build/html/.buildinfo
docs/_build/html/fields.html
docs/_build/html/genindex.html
docs/_build/html/hacking.html
docs/_build/html/index.html
docs/_build/html/narr.html
docs/_build/html/objects.inv
docs/_build/html/search.html
docs/_build/html/searchindex.js
docs/_build/html/sources.html
docs/_build/html/validation.html
docs/_build/html/_sources/fields.txt
docs/_build/html/_sources/hacking.txt
docs/_build/html/_sources/index.txt
docs/_build/html/_sources/narr.txt
docs/_build/html/_sources/sources.txt
docs/_build/html/_sources/validation.txt
docs/_build/html/_static/ajax-loader.gif
docs/_build/html/_static/basic.css
docs/_build/html/_static/comment-bright.png
docs/_build/html/_static/comment-close.png
docs/_build/html/_static/comment.png
docs/_build/html/_static/default.css
docs/_build/html/_static/doctools.js
docs/_build/html/_static/down-pressed.png
docs/_build/html/_static/down.png
docs/_build/html/_static/file.png
docs/_build/html/_static/jquery.js
docs/_build/html/_static/minus.png
docs/_build/html/_static/plus.png
docs/_build/html/_static/pygments.css
docs/_build/html/_static/searchtools.js
docs/_build/html/_static/sidebar.js
docs/_build/html/_static/underscore.js
docs/_build/html/_static/up-pressed.png
docs/_build/html/_static/up.png
docs/_build/html/_static/websupport.js
src/coverage.xml
src/zope/__init__.py
src/zope.schema.egg-info/PKG-INFO
src/zope.schema.egg-info/SOURCES.txt
src/zope.schema.egg-info/dependency_links.txt
src/zope.schema.egg-info/namespace_packages.txt
src/zope.schema.egg-info/not-zip-safe
src/zope.schema.egg-info/requires.txt
src/zope.schema.egg-info/top_level.txt
src/zope/schema/__init__.py
src/zope/schema/_bootstrapfields.py
src/zope/schema/_bootstrapinterfaces.py
src/zope/schema/_compat.py
src/zope/schema/_field.py
src/zope/schema/_messageid.py
src/zope/schema/_schema.py
src/zope/schema/accessors.py
src/zope/schema/fieldproperty.py
src/zope/schema/interfaces.py
src/zope/schema/vocabulary.py
src/zope/schema/tests/__init__.py
src/zope/schema/tests/states.py
src/zope/schema/tests/test__bootstrapfields.py
src/zope/schema/tests/test__bootstrapinterfaces.py
src/zope/schema/tests/test__field.py
src/zope/schema/tests/test_accessors.py
src/zope/schema/tests/test_equality.py
src/zope/schema/tests/test_fieldproperty.py
src/zope/schema/tests/test_interfaces.py
src/zope/schema/tests/test_schema.py
src/zope/schema/tests/test_states.py
src/zope/schema/tests/test_vocabulary.py zope.schema-4.4.2/src/zope.schema.egg-info/PKG-INFO 0000664 0001750 0001750 00000034043 12402106344 022675 0 ustar tseaver tseaver 0000000 0000000 Metadata-Version: 1.1
Name: zope.schema
Version: 4.4.2
Summary: zope.interface extension for defining data schemas
Home-page: http://pypi.python.org/pypi/zope.schema
Author: Zope Foundation and Contributors
Author-email: zope-dev@zope.org
License: ZPL 2.1
Description: zope.schema README
==================
Schemas extend the notion of interfaces to detailed descriptions of
Attributes (but not methods). Every schema is an interface and
specifies the public fields of an object. A *field* roughly
corresponds to an attribute of a Python object. But a Field provides
space for at least a title and a description. It can also constrain
its value and provide a validation method. Besides you can optionally
specify characteristics such as its value being read-only or not
required.
See http://docs.zope.org/zope.schema/ for more information.
zope.schema Changelog
=====================
4.4.2 (2014-09-04)
------------------
- Fix description of min max field: max value is included, not excluded.
4.4.1 (2014-03-19)
------------------
- Added support for Python 3.4.
4.4.0 (2014-01-22)
------------------
- Add an event on field properties to notify that a field has been updated.
This event enables definition of subscribers based on an event, a context
and a field. The event contains also the old value and the new value.
(also see package ``zope.schemaevent`` that define a field event handler)
4.3.3 (2014-01-06)
------------------
- PEP 8 cleanup.
- Don't raise RequiredMissing if a field's defaultFactory returns the field's
missing_value.
- Updated ``boostrap.py`` to version 2.2.
- Add the ability to swallow ValueErrors when rendering a SimpleVocabulary,
allowing for cases where vocabulary items may be duplicated (e.g., due to
user input).
- It was a pain that ``ConstraintNotSatisfied`` did not tell the field name.
4.3.2 (2013-02-24)
------------------
- Fix Python 2.6 support. (Forgot to run tox with all environments before last
release.)
4.3.1 (2013-02-24)
------------------
- Make sure that we do not fail during bytes decoding of term token when
generated from a bytes value by ignoring all errors. (Another option would
have been to hexlify the value, but that would break way too many tests.)
4.3.0 (2013-02-24)
------------------
- Fixed a bug where bytes values were turned into tokens inproperly in
Python 3.
- Added ``createFieldProperties()`` function which maps schema fields into
``FieldProperty`` instances.
4.2.2 (2012-11-21)
------------------
- Added support for Python 3.3.
4.2.1 (2012-11-09)
------------------
- Fix the default property of fields that have no defaultFactory attribute.
4.2.0 (2012-05-12)
------------------
- Automated build of Sphinx HTML docs and running doctest snippets via tox.
- Dropped explicit support for Python 3.1.
- Introduce NativeString and NativeStringLine which are equal to Bytes and
BytesLine on Python 2 and Text and TextLine on Python 3.
- Change IURI from a Bytes string to a "native" string. This is a backwards
incompatibility which only affects Python 3.
- 100% unit test coverage.
- Doctests moved from the package and wired up as normal Sphinx documentation.
- Added explicit support for PyPy.
- Added support for continuous integration using ``tox`` and ``jenkins``.
- Dropped the external ``six`` dependency in favor of a much-trimmed
``zope.schema._compat`` module.
- Tests now pass when run under ``nose``.
- Added ``setup.py dev`` alias (runs ``setup.py develop`` plus installs
``nose`` and ``coverage``).
- Added ``setup.py docs`` alias (installs ``Sphinx`` and dependencies).
4.1.1 (2012-03-23)
------------------
- Remove trailing slash in MANIFEST.in, it causes Winbot to crash.
4.1.0 (2012-03-23)
------------------
- Add TreeVocabulary for nested tree-like vocabularies.
- Fix broken Object field validation where the schema contains a Choice with
ICountextSourceBinder source. In this case the vocabulary was not iterable
because the field was not bound and the source binder didn't return the
real vocabulary. Added simple test for IContextSourceBinder validation. But a
test with an Object field with a schema using a Choice with
IContextSourceBinder is still missing.
4.0.1 (2011-11-14)
------------------
- Fix bug in ``fromUnicode`` method of ``DottedName`` which would fail
validation on being given unicode. Introduced in 4.0.0.
4.0.0 (2011-11-09)
------------------
- Fix deprecated unittest methods.
- Port to Python 3. This adds a dependency on six and removes support for
Python 2.5.
3.8.1 (2011-09-23)
------------------
- fix broken Object field validation. Previous version was using a volatile
property on object field values which ends in a ForbiddenAttribute error
on security proxied objects.
3.8.0 (2011-03-18)
------------------
- Implemented a ``defaultFactory`` attribute for all fields. It is a callable
that can be used to compute default values. The simplest case is::
Date(defaultFactory=datetime.date.today)
If the factory needs a context to compute a sensible default value, then it
must provide ``IContextAwareDefaultFactory``, which can be used as follows::
@provider(IContextAwareDefaultFactory)
def today(context):
return context.today()
Date(defaultFactory=today)
3.7.1 (2010-12-25)
------------------
- The validation token, used in the validation of schema with Object
Field to avoid infinite recursion, has been renamed.
``__schema_being_validated`` became ``_v_schema_being_validated``,
a volatile attribute, to avoid persistency and therefore,
read/write conflicts.
- Don't allow "[\]^`" in DottedName.
https://bugs.launchpad.net/zope.schema/+bug/191236
3.7.0 (2010-09-12)
------------------
- Improve error messages when term tokens or values are duplicates.
- Fix the buildout so the tests run.
3.6.4 (2010-06-08)
------------------
- fix validation of schema with Object Field that specify Interface schema.
3.6.3 (2010-04-30)
------------------
- Prefer the standard libraries doctest module to the one from zope.testing.
3.6.2 (2010-04-30)
------------------
- Avoid maximum recursion when validating Object field that points to cycles
- Made the dependency on ``zope.i18nmessageid`` optional.
3.6.1 (2010-01-05)
------------------
- Allow "setup.py test" to run at least a subset of the tests runnable
via ``bin/test`` (227 for ``setup.py test`` vs. 258. for
``bin/test``)
- Make ``zope.schema._bootstrapfields.ValidatedProperty`` descriptor
work under Jython.
- Make "setup.py test" tests pass on Jython.
3.6.0 (2009-12-22)
------------------
- Prefer zope.testing.doctest over doctestunit.
- Extend validation error to hold the field name.
- Add FieldProperty class that uses Field.get and Field.set methods
instead of storing directly on the instance __dict__.
3.5.4 (2009-03-25)
------------------
- Don't fail trying to validate default value for Choice fields with
IContextSourceBinder object given as a source. See
https://bugs.launchpad.net/zope3/+bug/340416.
- Add an interface for ``DottedName`` field.
- Add ``vocabularyName`` attribute to the ``IChoice`` interface, change
"vocabulary" attribute description to be more sensible, making it
``zope.schema.Field`` instead of plain ``zope.interface.Attribute``.
- Make IBool interface of Bool more important than IFromUnicode so adapters
registered for IBool take precendence over adapters registered for
IFromUnicode.
3.5.3 (2009-03-10)
------------------
- Make Choice and Bool fields implement IFromUnicode interface, because
they do provide the ``fromUnicode`` method.
- Change package's mailing list address to zope-dev at zope.org, as
zope3-dev at zope.org is now retired.
- Fix package's documentation formatting. Change package's description.
- Add buildout part that builds Sphinx-generated documentation.
- Remove zpkg-related file.
3.5.2 (2009-02-04)
------------------
- Made validation tests compatible with Python 2.5 again (hopefully not
breaking Python 2.4)
- Added an __all__ package attribute to expose documentation.
3.5.1 (2009-01-31)
------------------
- Stop using the old old set type.
- Make tests compatible and silent with Python 2.4.
- Fix __cmp__ method in ValidationError. Show some side effects based on the
existing __cmp__ implementation. See validation.txt
- Make 'repr' of the ValidationError and its subclasses more sensible. This
may require you to adapt your doctests for the new style, but now it makes
much more sense for debugging for developers.
3.5.0a2 (2008-12-11)
--------------------
- Move zope.testing to "test" extras_require, as it is not needed
for zope.schema itself.
- Change the order of classes in SET_TYPES tuple, introduced in
previous release to one that was in 3.4 (SetType, set), because
third-party code could be dependent on that order. The one
example is z3c.form's converter.
3.5.0a1 (2008-10-10)
--------------------
- Added the doctests to the long description.
- Removed use of deprecated 'sets' module when running under Python 2.6.
- Removed spurious doctest failure when running under Python 2.6.
- Added support to bootstrap on Jython.
- Added helper methods for schema validation: ``getValidationErrors``
and ``getSchemaValidationErrors``.
- zope.schema now works on Python2.5
3.4.0 (2007-09-28)
------------------
Added BeforeObjectAssignedEvent that is triggered before the object
field sets a value.
3.3.0 (2007-03-15)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.3.0 release.
3.2.1 (2006-03-26)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.2.1 release.
Fixed missing import of 'VocabularyRegistryError'. See
http://www.zope.org/Collectors/Zope3-dev/544 .
3.2.0 (2006-01-05)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.2.0 release.
Added "iterable" sources to replace vocabularies, which are now deprecated
and scheduled for removal in Zope 3.3.
3.1.0 (2005-10-03)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.1.0 release.
Allowed 'Choice' fields to take either a 'vocabulary' or a 'source'
argument (sources are a simpler implementation).
Added 'TimeDelta' and 'ASCIILine' field types.
3.0.0 (2004-11-07)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope X3.0.0 release.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Framework :: Zope3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
zope.schema-4.4.2/src/zope.schema.egg-info/dependency_links.txt 0000664 0001750 0001750 00000000001 12402106344 025642 0 ustar tseaver tseaver 0000000 0000000
zope.schema-4.4.2/src/zope.schema.egg-info/not-zip-safe 0000664 0001750 0001750 00000000001 12072657570 024041 0 ustar tseaver tseaver 0000000 0000000
zope.schema-4.4.2/src/zope.schema.egg-info/namespace_packages.txt 0000664 0001750 0001750 00000000005 12402106344 026122 0 ustar tseaver tseaver 0000000 0000000 zope
zope.schema-4.4.2/src/zope.schema.egg-info/requires.txt 0000664 0001750 0001750 00000000167 12402106344 024200 0 ustar tseaver tseaver 0000000 0000000 setuptools
zope.interface >= 3.6.0
zope.event
[test]
zope.testing
[docs]
Sphinx
[testing]
zope.testing
nose
coverage zope.schema-4.4.2/src/zope/ 0000775 0001750 0001750 00000000000 12402106344 016643 5 ustar tseaver tseaver 0000000 0000000 zope.schema-4.4.2/src/zope/__init__.py 0000664 0001750 0001750 00000000070 12072655571 020767 0 ustar tseaver tseaver 0000000 0000000 __import__('pkg_resources').declare_namespace(__name__)
zope.schema-4.4.2/src/zope/schema/ 0000775 0001750 0001750 00000000000 12402106344 020103 5 ustar tseaver tseaver 0000000 0000000 zope.schema-4.4.2/src/zope/schema/vocabulary.py 0000664 0001750 0001750 00000032344 12265302416 022637 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2003 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Vocabulary support for schema.
"""
from zope.interface import directlyProvides
from zope.interface import implementer
from zope.schema.interfaces import ITitledTokenizedTerm
from zope.schema.interfaces import ITokenizedTerm
from zope.schema.interfaces import ITreeVocabulary
from zope.schema.interfaces import IVocabularyRegistry
from zope.schema.interfaces import IVocabularyTokenized
from zope.schema._compat import OrderedDict
# simple vocabularies performing enumerated-like tasks
_marker = object()
@implementer(ITokenizedTerm)
class SimpleTerm(object):
"""Simple tokenized term used by SimpleVocabulary."""
def __init__(self, value, token=None, title=None):
"""Create a term for value and token. If token is omitted,
str(value) is used for the token. If title is provided,
term implements ITitledTokenizedTerm.
"""
self.value = value
if token is None:
token = value
# In Python 3 str(bytes) returns str(repr(bytes)), which is not what
# we want here. On the other hand, we want to try to keep the token as
# readable as possible.
self.token = str(token) \
if not isinstance(token, bytes) \
else str(token.decode('ascii', 'ignore'))
self.title = title
if title is not None:
directlyProvides(self, ITitledTokenizedTerm)
@implementer(IVocabularyTokenized)
class SimpleVocabulary(object):
"""Vocabulary that works from a sequence of terms."""
def __init__(self, terms, *interfaces, **kwargs):
"""Initialize the vocabulary given a list of terms.
The vocabulary keeps a reference to the list of terms passed
in; it should never be modified while the vocabulary is used.
One or more interfaces may also be provided so that alternate
widgets may be bound without subclassing.
By default, ValueErrors are thrown if duplicate values or tokens
are passed in. If you want to swallow these exceptions, pass
in swallow_duplicates=True. In this case, the values will
override themselves.
"""
self.by_value = {}
self.by_token = {}
self._terms = terms
for term in self._terms:
swallow_dupes = kwargs.get('swallow_duplicates', False)
if not swallow_dupes:
if term.value in self.by_value:
raise ValueError(
'term values must be unique: %s' % repr(term.value))
if term.token in self.by_token:
raise ValueError(
'term tokens must be unique: %s' % repr(term.token))
self.by_value[term.value] = term
self.by_token[term.token] = term
if interfaces:
directlyProvides(self, *interfaces)
@classmethod
def fromItems(cls, items, *interfaces):
"""Construct a vocabulary from a list of (token, value) pairs.
The order of the items is preserved as the order of the terms
in the vocabulary. Terms are created by calling the class
method createTerm() with the pair (value, token).
One or more interfaces may also be provided so that alternate
widgets may be bound without subclassing.
"""
terms = [cls.createTerm(value, token) for (token, value) in items]
return cls(terms, *interfaces)
@classmethod
def fromValues(cls, values, *interfaces):
"""Construct a vocabulary from a simple list.
Values of the list become both the tokens and values of the
terms in the vocabulary. The order of the values is preserved
as the order of the terms in the vocabulary. Tokens are
created by calling the class method createTerm() with the
value as the only parameter.
One or more interfaces may also be provided so that alternate
widgets may be bound without subclassing.
"""
terms = [cls.createTerm(value) for value in values]
return cls(terms, *interfaces)
@classmethod
def createTerm(cls, *args):
"""Create a single term from data.
Subclasses may override this with a class method that creates
a term of the appropriate type from the arguments.
"""
return SimpleTerm(*args)
def __contains__(self, value):
"""See zope.schema.interfaces.IBaseVocabulary"""
try:
return value in self.by_value
except TypeError:
# sometimes values are not hashable
return False
def getTerm(self, value):
"""See zope.schema.interfaces.IBaseVocabulary"""
try:
return self.by_value[value]
except KeyError:
raise LookupError(value)
def getTermByToken(self, token):
"""See zope.schema.interfaces.IVocabularyTokenized"""
try:
return self.by_token[token]
except KeyError:
raise LookupError(token)
def __iter__(self):
"""See zope.schema.interfaces.IIterableVocabulary"""
return iter(self._terms)
def __len__(self):
"""See zope.schema.interfaces.IIterableVocabulary"""
return len(self.by_value)
def _createTermTree(ttree, dict_):
""" Helper method that creates a tree-like dict with ITokenizedTerm
objects as keys from a similar tree with tuples as keys.
See fromDict for more details.
"""
for key in sorted(dict_.keys()):
term = SimpleTerm(key[1], key[0], key[-1])
ttree[term] = TreeVocabulary.terms_factory()
_createTermTree(ttree[term], dict_[key])
return ttree
@implementer(ITreeVocabulary)
class TreeVocabulary(object):
""" Vocabulary that relies on a tree (i.e nested) structure.
"""
# The default implementation uses a dict to create the tree structure. This
# can however be overridden in a subclass by any other IEnumerableMapping
# compliant object type. Python 2.7's OrderedDict for example.
terms_factory = OrderedDict
def __init__(self, terms, *interfaces):
"""Initialize the vocabulary given a recursive dict (i.e a tree) with
ITokenizedTerm objects for keys and self-similar dicts representing the
branches for values.
Refer to the method fromDict for more details.
Concerning the ITokenizedTerm keys, the 'value' and 'token' attributes
of each key (including nested ones) must be unique.
One or more interfaces may also be provided so that alternate
widgets may be bound without subclassing.
"""
self._terms = self.terms_factory()
self._terms.update(terms)
self.path_by_value = {}
self.term_by_value = {}
self.term_by_token = {}
self._populateIndexes(terms)
if interfaces:
directlyProvides(self, *interfaces)
def __contains__(self, value):
""" See zope.schema.interfaces.IBaseVocabulary
D.__contains__(k) -> True if D has a key k, else False
"""
try:
return value in self.term_by_value
except TypeError:
# sometimes values are not hashable
return False
def __getitem__(self, key):
"""x.__getitem__(y) <==> x[y]
"""
return self._terms.__getitem__(key)
def __iter__(self):
"""See zope.schema.interfaces.IIterableVocabulary
x.__iter__() <==> iter(x)
"""
return self._terms.__iter__()
def __len__(self):
"""x.__len__() <==> len(x)
"""
return self._terms.__len__()
def get(self, key, default=None):
"""Get a value for a key
The default is returned if there is no value for the key.
"""
return self._terms.get(key, default)
def keys(self):
"""Return the keys of the mapping object.
"""
return self._terms.keys()
def values(self):
"""Return the values of the mapping object.
"""
return self._terms.values()
def items(self):
"""Return the items of the mapping object.
"""
return self._terms.items()
@classmethod
def fromDict(cls, dict_, *interfaces):
"""Constructs a vocabulary from a dictionary-like object (like dict or
OrderedDict), that has tuples for keys.
The tuples should have either 2 or 3 values, i.e:
(token, value, title) or (token, value)
For example, a dict with 2-valued tuples:
dict_ = {
('exampleregions', 'Regions used in ATVocabExample'): {
('aut', 'Austria'): {
('tyr', 'Tyrol'): {
('auss', 'Ausserfern'): {},
}
},
('ger', 'Germany'): {
('bav', 'Bavaria'):{}
},
}
}
One or more interfaces may also be provided so that alternate
widgets may be bound without subclassing.
"""
return cls(_createTermTree(cls.terms_factory(), dict_), *interfaces)
def _populateIndexes(self, tree):
""" The TreeVocabulary contains three helper indexes for quick lookups.
They are: term_by_value, term_by_token and path_by_value
This method recurses through the tree and populates these indexes.
tree: The tree (a nested/recursive dictionary).
"""
for term in tree.keys():
value = getattr(term, 'value')
token = getattr(term, 'token')
if value in self.term_by_value:
raise ValueError(
"Term values must be unique: '%s'" % value)
if token in self.term_by_token:
raise ValueError(
"Term tokens must be unique: '%s'" % token)
self.term_by_value[value] = term
self.term_by_token[token] = term
if value not in self.path_by_value:
self.path_by_value[value] = self._getPathToTreeNode(self,
value)
self._populateIndexes(tree[term])
def getTerm(self, value):
"""See zope.schema.interfaces.IBaseVocabulary"""
try:
return self.term_by_value[value]
except KeyError:
raise LookupError(value)
def getTermByToken(self, token):
"""See zope.schema.interfaces.IVocabularyTokenized"""
try:
return self.term_by_token[token]
except KeyError:
raise LookupError(token)
def _getPathToTreeNode(self, tree, node):
"""Helper method that computes the path in the tree from the root
to the given node.
The tree must be a recursive IEnumerableMapping object.
"""
path = []
for parent, child in tree.items():
if node == parent.value:
return [node]
path = self._getPathToTreeNode(child, node)
if path:
path.insert(0, parent.value)
break
return path
def getTermPath(self, value):
"""Returns a list of strings representing the path from the root node
to the node with the given value in the tree.
Returns an empty string if no node has that value.
"""
return self.path_by_value.get(value, [])
# registry code
class VocabularyRegistryError(LookupError):
def __init__(self, name):
self.name = name
Exception.__init__(self, str(self))
def __str__(self):
return "unknown vocabulary: %r" % self.name
@implementer(IVocabularyRegistry)
class VocabularyRegistry(object):
__slots__ = '_map',
def __init__(self):
self._map = {}
def get(self, object, name):
"""See zope.schema.interfaces.IVocabularyRegistry"""
try:
vtype = self._map[name]
except KeyError:
raise VocabularyRegistryError(name)
return vtype(object)
def register(self, name, factory):
self._map[name] = factory
_vocabularies = None
def getVocabularyRegistry():
"""Return the vocabulary registry.
If the registry has not been created yet, an instance of
VocabularyRegistry will be installed and used.
"""
if _vocabularies is None:
setVocabularyRegistry(VocabularyRegistry())
return _vocabularies
def setVocabularyRegistry(registry):
"""Set the vocabulary registry."""
global _vocabularies
_vocabularies = registry
def _clear():
"""Remove the registries (for use by tests)."""
global _vocabularies
_vocabularies = None
try:
from zope.testing.cleanup import addCleanUp
except ImportError: # pragma: no cover
# don't have that part of Zope
pass
else: # pragma: no cover
addCleanUp(_clear)
del addCleanUp
zope.schema-4.4.2/src/zope/schema/_bootstrapinterfaces.py 0000664 0001750 0001750 00000006072 12312122016 024674 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Bootstrap schema interfaces and exceptions
"""
import zope.interface
from zope.schema._messageid import _
class StopValidation(Exception):
"""Raised if the validation is completed early.
Note that this exception should be always caught, since it is just
a way for the validator to save time.
"""
class ValidationError(zope.interface.Invalid):
"""Raised if the Validation process fails."""
def doc(self):
return self.__class__.__doc__
def __cmp__(self, other):
if not hasattr(other, 'args'):
return -1
return cmp(self.args, other.args)
def __eq__(self, other):
if not hasattr(other, 'args'):
return False
return self.args == other.args
__hash__ = zope.interface.Invalid.__hash__ # python3
def __repr__(self): # pragma: no cover
return '%s(%s)' % (self.__class__.__name__,
', '.join(repr(arg) for arg in self.args))
class RequiredMissing(ValidationError):
__doc__ = _("""Required input is missing.""")
class WrongType(ValidationError):
__doc__ = _("""Object is of wrong type.""")
class TooBig(ValidationError):
__doc__ = _("""Value is too big""")
class TooSmall(ValidationError):
__doc__ = _("""Value is too small""")
class TooLong(ValidationError):
__doc__ = _("""Value is too long""")
class TooShort(ValidationError):
__doc__ = _("""Value is too short""")
class InvalidValue(ValidationError):
__doc__ = _("""Invalid value""")
class ConstraintNotSatisfied(ValidationError):
__doc__ = _("""Constraint not satisfied""")
class NotAContainer(ValidationError):
__doc__ = _("""Not a container""")
class NotAnIterator(ValidationError):
__doc__ = _("""Not an iterator""")
class IFromUnicode(zope.interface.Interface):
"""Parse a unicode string to a value
We will often adapt fields to this interface to support views and
other applications that need to conver raw data as unicode
values.
"""
def fromUnicode(str):
"""Convert a unicode string to a value.
"""
class IContextAwareDefaultFactory(zope.interface.Interface):
"""A default factory that requires a context.
The context is the field context. If the field is not bound, context may
be ``None``.
"""
def __call__(context):
"""Returns a default value for the field."""
class NO_VALUE(object):
def __repr__(self):
return ''
NO_VALUE = NO_VALUE()
zope.schema-4.4.2/src/zope/schema/_compat.py 0000664 0001750 0001750 00000002135 12265302416 022105 0 ustar tseaver tseaver 0000000 0000000 import sys
PY3 = sys.version_info[0] >= 3
try:
from collections import OrderedDict
except ImportError: # pragma: no cover
from ordereddict import OrderedDict
# pep 8 friendlyness
OrderedDict
if PY3: # pragma: no cover
def b(s):
return s.encode("latin-1")
def u(s):
return s
string_types = str,
text_type = str
binary_type = bytes
integer_types = int,
def non_native_string(x):
if isinstance(x, bytes):
return x
return bytes(x, 'unicode_escape')
def make_binary(x):
if isinstance(x, bytes):
return x
return x.encode('ascii')
else: # pragma: no cover
def b(s):
return s
def u(s):
return unicode(s, "unicode_escape")
string_types = basestring,
text_type = unicode
binary_type = str
integer_types = (int, long)
def non_native_string(x):
if isinstance(x, unicode):
return x
return unicode(x, 'unicode_escape')
def make_binary(x):
if isinstance(x, str):
return x
return x.encode('ascii')
zope.schema-4.4.2/src/zope/schema/__init__.py 0000664 0001750 0001750 00000005632 12312122016 022214 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Schema package constructor
"""
# Field APIs
from zope.schema._field import ASCII
from zope.schema._field import ASCIILine
from zope.schema._field import Bool
from zope.schema._field import Bytes
from zope.schema._field import BytesLine
from zope.schema._field import Choice
from zope.schema._field import Container
from zope.schema._field import Date
from zope.schema._field import Datetime
from zope.schema._field import Decimal
from zope.schema._field import Dict
from zope.schema._field import DottedName
from zope.schema._field import Field
from zope.schema._field import Float
from zope.schema._field import FrozenSet
from zope.schema._field import Id
from zope.schema._field import Int
from zope.schema._field import InterfaceField
from zope.schema._field import Iterable
from zope.schema._field import List
from zope.schema._field import MinMaxLen
from zope.schema._field import NativeString
from zope.schema._field import NativeStringLine
from zope.schema._field import Object
from zope.schema._field import Orderable
from zope.schema._field import Password
from zope.schema._field import Set
from zope.schema._field import SourceText
from zope.schema._field import Text
from zope.schema._field import TextLine
from zope.schema._field import Time
from zope.schema._field import Timedelta
from zope.schema._field import Tuple
from zope.schema._field import URI
# Schema APIs
from zope.schema._schema import getFields
from zope.schema._schema import getFieldsInOrder
from zope.schema._schema import getFieldNames
from zope.schema._schema import getFieldNamesInOrder
from zope.schema._schema import getValidationErrors
from zope.schema._schema import getSchemaValidationErrors
# Acessor API
from zope.schema.accessors import accessors
# Error API
from zope.schema.interfaces import ValidationError
from zope.schema._bootstrapinterfaces import NO_VALUE
# pep 8 friendlyness
ASCII, ASCIILine, Bool, Bytes, BytesLine, Choice, Container, Date, Datetime
Decimal, Dict, DottedName, Field, Float, FrozenSet, Id, Int, InterfaceField
Iterable, List, MinMaxLen, NativeString, NativeStringLine, Object, Orderable
Password, Set, SourceText, Text, TextLine, Time, Timedelta, Tuple, URI
getFields, getFieldsInOrder, getFieldNames, getFieldNamesInOrder,
getValidationErrors, getSchemaValidationErrors
accessors
ValidationError
NO_VALUE
zope.schema-4.4.2/src/zope/schema/_schema.py 0000664 0001750 0001750 00000005700 12265302416 022063 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Schema convenience functions
"""
import zope.interface.verify
def getFieldNames(schema):
"""Return a list of all the Field names in a schema.
"""
from zope.schema.interfaces import IField
return [name for name in schema if IField.providedBy(schema[name])]
def getFields(schema):
"""Return a dictionary containing all the Fields in a schema.
"""
from zope.schema.interfaces import IField
fields = {}
for name in schema:
attr = schema[name]
if IField.providedBy(attr):
fields[name] = attr
return fields
def getFieldsInOrder(schema, _field_key=lambda x: x[1].order):
"""Return a list of (name, value) tuples in native schema order.
"""
return sorted(getFields(schema).items(), key=_field_key)
def getFieldNamesInOrder(schema):
"""Return a list of all the Field names in a schema in schema order.
"""
return [name for name, field in getFieldsInOrder(schema)]
def getValidationErrors(schema, object):
"""Return a list of all validation errors.
"""
errors = getSchemaValidationErrors(schema, object)
if errors:
return errors
# Only validate invariants if there were no previous errors. Previous
# errors could be missing attributes which would most likely make an
# invariant raise an AttributeError.
invariant_errors = []
try:
schema.validateInvariants(object, invariant_errors)
except zope.interface.exceptions.Invalid:
# Just collect errors
pass
errors = [(None, e) for e in invariant_errors]
return errors
def getSchemaValidationErrors(schema, object):
errors = []
for name in schema.names(all=True):
if zope.interface.interfaces.IMethod.providedBy(schema[name]):
continue
attribute = schema[name]
if not zope.schema.interfaces.IField.providedBy(attribute):
continue
try:
value = getattr(object, name)
except AttributeError as error:
# property for the given name is not implemented
errors.append((
name, zope.schema.interfaces.SchemaNotFullyImplemented(error)))
else:
try:
attribute.bind(object).validate(value)
except zope.schema.ValidationError as e:
errors.append((name, e))
return errors
zope.schema-4.4.2/src/zope/schema/_field.py 0000664 0001750 0001750 00000055270 12265302416 021715 0 ustar tseaver tseaver 0000000 0000000 # -*- coding: utf-8 -*-
##############################################################################
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Schema Fields
"""
__docformat__ = 'restructuredtext'
from datetime import datetime
from datetime import date
from datetime import timedelta
from datetime import time
import decimal
import re
import threading
from zope.event import notify
from zope.interface import classImplements
from zope.interface import implementer
from zope.interface import Interface
from zope.interface.interfaces import IInterface
from zope.interface.interfaces import IMethod
from zope.schema.interfaces import IASCII
from zope.schema.interfaces import IASCIILine
from zope.schema.interfaces import IBaseVocabulary
from zope.schema.interfaces import IBeforeObjectAssignedEvent
from zope.schema.interfaces import IBool
from zope.schema.interfaces import IBytes
from zope.schema.interfaces import IBytesLine
from zope.schema.interfaces import IChoice
from zope.schema.interfaces import IContextSourceBinder
from zope.schema.interfaces import IDate
from zope.schema.interfaces import IDatetime
from zope.schema.interfaces import IDecimal
from zope.schema.interfaces import IDict
from zope.schema.interfaces import IDottedName
from zope.schema.interfaces import IField
from zope.schema.interfaces import IFloat
from zope.schema.interfaces import IFromUnicode
from zope.schema.interfaces import IFrozenSet
from zope.schema.interfaces import IId
from zope.schema.interfaces import IInt
from zope.schema.interfaces import IInterfaceField
from zope.schema.interfaces import IList
from zope.schema.interfaces import IMinMaxLen
from zope.schema.interfaces import IObject
from zope.schema.interfaces import IPassword
from zope.schema.interfaces import ISet
from zope.schema.interfaces import ISource
from zope.schema.interfaces import ISourceText
from zope.schema.interfaces import IText
from zope.schema.interfaces import ITextLine
from zope.schema.interfaces import ITime
from zope.schema.interfaces import ITimedelta
from zope.schema.interfaces import ITuple
from zope.schema.interfaces import IURI
from zope.schema.interfaces import ValidationError
from zope.schema.interfaces import InvalidValue
from zope.schema.interfaces import WrongType
from zope.schema.interfaces import WrongContainedType
from zope.schema.interfaces import NotUnique
from zope.schema.interfaces import SchemaNotProvided
from zope.schema.interfaces import SchemaNotFullyImplemented
from zope.schema.interfaces import InvalidURI
from zope.schema.interfaces import InvalidId
from zope.schema.interfaces import InvalidDottedName
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema._bootstrapfields import Field
from zope.schema._bootstrapfields import Container # API import for __init__
from zope.schema._bootstrapfields import Iterable
from zope.schema._bootstrapfields import Orderable
from zope.schema._bootstrapfields import Text
from zope.schema._bootstrapfields import TextLine
from zope.schema._bootstrapfields import Bool
from zope.schema._bootstrapfields import Int
from zope.schema._bootstrapfields import Password
from zope.schema._bootstrapfields import MinMaxLen
from zope.schema.fieldproperty import FieldProperty
from zope.schema.vocabulary import getVocabularyRegistry
from zope.schema.vocabulary import VocabularyRegistryError
from zope.schema.vocabulary import SimpleVocabulary
from zope.schema._compat import b
from zope.schema._compat import text_type
from zope.schema._compat import string_types
from zope.schema._compat import binary_type
from zope.schema._compat import PY3
from zope.schema._compat import make_binary
# pep 8 friendlyness
Container
# Fix up bootstrap field types
Field.title = FieldProperty(IField['title'])
Field.description = FieldProperty(IField['description'])
Field.required = FieldProperty(IField['required'])
Field.readonly = FieldProperty(IField['readonly'])
# Default is already taken care of
classImplements(Field, IField)
MinMaxLen.min_length = FieldProperty(IMinMaxLen['min_length'])
MinMaxLen.max_length = FieldProperty(IMinMaxLen['max_length'])
classImplements(Text, IText)
classImplements(TextLine, ITextLine)
classImplements(Password, IPassword)
classImplements(Bool, IBool)
classImplements(Bool, IFromUnicode)
classImplements(Int, IInt)
@implementer(ISourceText)
class SourceText(Text):
__doc__ = ISourceText.__doc__
_type = text_type
@implementer(IBytes, IFromUnicode)
class Bytes(MinMaxLen, Field):
__doc__ = IBytes.__doc__
_type = binary_type
def fromUnicode(self, uc):
""" See IFromUnicode.
"""
v = make_binary(uc)
self.validate(v)
return v
# for things which are of the str type on both Python 2 and 3
if PY3: # pragma: no cover
NativeString = Text
else: # pragma: no cover
NativeString = Bytes
@implementer(IASCII)
class ASCII(NativeString):
__doc__ = IASCII.__doc__
def _validate(self, value):
super(ASCII, self)._validate(value)
if not value:
return
if not max(map(ord, value)) < 128:
raise InvalidValue
@implementer(IBytesLine)
class BytesLine(Bytes):
"""A Text field with no newlines."""
def constraint(self, value):
# TODO: we should probably use a more general definition of newlines
return b('\n') not in value
# for things which are of the str type on both Python 2 and 3
if PY3: # pragma: no cover
NativeStringLine = TextLine
else: # pragma: no cover
NativeStringLine = BytesLine
@implementer(IASCIILine)
class ASCIILine(ASCII):
__doc__ = IASCIILine.__doc__
def constraint(self, value):
# TODO: we should probably use a more general definition of newlines
return '\n' not in value
@implementer(IFloat, IFromUnicode)
class Float(Orderable, Field):
__doc__ = IFloat.__doc__
_type = float
def __init__(self, *args, **kw):
super(Float, self).__init__(*args, **kw)
def fromUnicode(self, uc):
""" See IFromUnicode.
"""
v = float(uc)
self.validate(v)
return v
@implementer(IDecimal, IFromUnicode)
class Decimal(Orderable, Field):
__doc__ = IDecimal.__doc__
_type = decimal.Decimal
def __init__(self, *args, **kw):
super(Decimal, self).__init__(*args, **kw)
def fromUnicode(self, uc):
""" See IFromUnicode.
"""
try:
v = decimal.Decimal(uc)
except decimal.InvalidOperation:
raise ValueError('invalid literal for Decimal(): %s' % uc)
self.validate(v)
return v
@implementer(IDatetime)
class Datetime(Orderable, Field):
__doc__ = IDatetime.__doc__
_type = datetime
def __init__(self, *args, **kw):
super(Datetime, self).__init__(*args, **kw)
@implementer(IDate)
class Date(Orderable, Field):
__doc__ = IDate.__doc__
_type = date
def _validate(self, value):
super(Date, self)._validate(value)
if isinstance(value, datetime):
raise WrongType(value, self._type, self.__name__)
@implementer(ITimedelta)
class Timedelta(Orderable, Field):
__doc__ = ITimedelta.__doc__
_type = timedelta
@implementer(ITime)
class Time(Orderable, Field):
__doc__ = ITime.__doc__
_type = time
@implementer(IChoice, IFromUnicode)
class Choice(Field):
"""Choice fields can have a value found in a constant or dynamic set of
values given by the field definition.
"""
def __init__(self, values=None, vocabulary=None, source=None, **kw):
"""Initialize object."""
if vocabulary is not None:
if (not isinstance(vocabulary, string_types)
and not IBaseVocabulary.providedBy(vocabulary)):
raise ValueError('vocabulary must be a string or implement '
'IBaseVocabulary')
if source is not None:
raise ValueError(
"You cannot specify both source and vocabulary.")
elif source is not None:
vocabulary = source
if (values is None and vocabulary is None):
raise ValueError(
"You must specify either values or vocabulary."
)
if values is not None and vocabulary is not None:
raise ValueError(
"You cannot specify both values and vocabulary."
)
self.vocabulary = None
self.vocabularyName = None
if values is not None:
self.vocabulary = SimpleVocabulary.fromValues(values)
elif isinstance(vocabulary, string_types):
self.vocabularyName = vocabulary
else:
if (not ISource.providedBy(vocabulary)
and not IContextSourceBinder.providedBy(vocabulary)):
raise ValueError('Invalid vocabulary')
self.vocabulary = vocabulary
# Before a default value is checked, it is validated. However, a
# named vocabulary is usually not complete when these fields are
# initialized. Therefore signal the validation method to ignore
# default value checks during initialization of a Choice tied to a
# registered vocabulary.
self._init_field = (bool(self.vocabularyName) or
IContextSourceBinder.providedBy(self.vocabulary))
super(Choice, self).__init__(**kw)
self._init_field = False
source = property(lambda self: self.vocabulary)
def bind(self, object):
"""See zope.schema._bootstrapinterfaces.IField."""
clone = super(Choice, self).bind(object)
# get registered vocabulary if needed:
if IContextSourceBinder.providedBy(self.vocabulary):
clone.vocabulary = self.vocabulary(object)
elif clone.vocabulary is None and self.vocabularyName is not None:
vr = getVocabularyRegistry()
clone.vocabulary = vr.get(object, self.vocabularyName)
if not ISource.providedBy(clone.vocabulary):
raise ValueError('Invalid clone vocabulary')
return clone
def fromUnicode(self, str):
""" See IFromUnicode.
"""
self.validate(str)
return str
def _validate(self, value):
# Pass all validations during initialization
if self._init_field:
return
super(Choice, self)._validate(value)
vocabulary = self.vocabulary
if vocabulary is None:
vr = getVocabularyRegistry()
try:
vocabulary = vr.get(None, self.vocabularyName)
except VocabularyRegistryError:
raise ValueError("Can't validate value without vocabulary")
if value not in vocabulary:
raise ConstraintNotSatisfied(value, self.__name__)
_isuri = r"[a-zA-z0-9+.-]+:" # scheme
_isuri += r"\S*$" # non space (should be pickier)
_isuri = re.compile(_isuri).match
@implementer(IURI, IFromUnicode)
class URI(NativeStringLine):
"""URI schema field
"""
def _validate(self, value):
super(URI, self)._validate(value)
if _isuri(value):
return
raise InvalidURI(value)
def fromUnicode(self, value):
""" See IFromUnicode.
"""
v = str(value.strip())
self.validate(v)
return v
_isdotted = re.compile(
r"([a-zA-Z][a-zA-Z0-9_]*)"
r"([.][a-zA-Z][a-zA-Z0-9_]*)*"
# use the whole line
r"$").match
@implementer(IDottedName)
class DottedName(NativeStringLine):
"""Dotted name field.
Values of DottedName fields must be Python-style dotted names.
"""
def __init__(self, *args, **kw):
self.min_dots = int(kw.pop("min_dots", 0))
if self.min_dots < 0:
raise ValueError("min_dots cannot be less than zero")
self.max_dots = kw.pop("max_dots", None)
if self.max_dots is not None:
self.max_dots = int(self.max_dots)
if self.max_dots < self.min_dots:
raise ValueError("max_dots cannot be less than min_dots")
super(DottedName, self).__init__(*args, **kw)
def _validate(self, value):
"""
"""
super(DottedName, self)._validate(value)
if not _isdotted(value):
raise InvalidDottedName(value)
dots = value.count(".")
if dots < self.min_dots:
raise InvalidDottedName(
"too few dots; %d required" % self.min_dots, value
)
if self.max_dots is not None and dots > self.max_dots:
raise InvalidDottedName("too many dots; no more than %d allowed" %
self.max_dots, value)
def fromUnicode(self, value):
v = value.strip()
if not isinstance(v, self._type):
v = v.encode('ascii')
self.validate(v)
return v
@implementer(IId, IFromUnicode)
class Id(NativeStringLine):
"""Id field
Values of id fields must be either uris or dotted names.
"""
def _validate(self, value):
super(Id, self)._validate(value)
if _isuri(value):
return
if _isdotted(value) and "." in value:
return
raise InvalidId(value)
def fromUnicode(self, value):
""" See IFromUnicode.
"""
v = value.strip()
if not isinstance(v, self._type):
v = v.encode('ascii')
self.validate(v)
return v
@implementer(IInterfaceField)
class InterfaceField(Field):
__doc__ = IInterfaceField.__doc__
def _validate(self, value):
super(InterfaceField, self)._validate(value)
if not IInterface.providedBy(value):
raise WrongType("An interface is required", value, self.__name__)
def _validate_sequence(value_type, value, errors=None):
"""Validates a sequence value.
Returns a list of validation errors generated during the validation. If
no errors are generated, returns an empty list.
value_type is a field. value is the sequence being validated. errors is
an optional list of errors that will be prepended to the return value.
To illustrate, we'll use a text value type. All values must be unicode.
>>> from zope.schema._compat import u
>>> from zope.schema._compat import b
>>> field = TextLine(required=True)
To validate a sequence of various values:
>>> errors = _validate_sequence(field, (b('foo'), u('bar'), 1))
>>> errors # XXX assumes Python2 reprs
[WrongType('foo', , ''), WrongType(1, , '')]
The only valid value in the sequence is the second item. The others
generated errors.
We can use the optional errors argument to collect additional errors
for a new sequence:
>>> errors = _validate_sequence(field, (2, u('baz')), errors)
>>> errors # XXX assumes Python2 reprs
[WrongType('foo', , ''), WrongType(1, , ''), WrongType(2, , '')]
"""
if errors is None:
errors = []
if value_type is None:
return errors
for item in value:
try:
value_type.validate(item)
except ValidationError as error:
errors.append(error)
return errors
def _validate_uniqueness(value):
temp_values = []
for item in value:
if item in temp_values:
raise NotUnique(item)
temp_values.append(item)
class AbstractCollection(MinMaxLen, Iterable):
value_type = None
unique = False
def __init__(self, value_type=None, unique=False, **kw):
super(AbstractCollection, self).__init__(**kw)
# whine if value_type is not a field
if value_type is not None and not IField.providedBy(value_type):
raise ValueError("'value_type' must be field instance.")
self.value_type = value_type
self.unique = unique
def bind(self, object):
"""See zope.schema._bootstrapinterfaces.IField."""
clone = super(AbstractCollection, self).bind(object)
# binding value_type is necessary for choices with named vocabularies,
# and possibly also for other fields.
if clone.value_type is not None:
clone.value_type = clone.value_type.bind(object)
return clone
def _validate(self, value):
super(AbstractCollection, self)._validate(value)
errors = _validate_sequence(self.value_type, value)
if errors:
raise WrongContainedType(errors, self.__name__)
if self.unique:
_validate_uniqueness(value)
@implementer(ITuple)
class Tuple(AbstractCollection):
"""A field representing a Tuple."""
_type = tuple
@implementer(IList)
class List(AbstractCollection):
"""A field representing a List."""
_type = list
@implementer(ISet)
class Set(AbstractCollection):
"""A field representing a set."""
_type = set
def __init__(self, **kw):
if 'unique' in kw: # set members are always unique
raise TypeError(
"__init__() got an unexpected keyword argument 'unique'")
super(Set, self).__init__(unique=True, **kw)
@implementer(IFrozenSet)
class FrozenSet(AbstractCollection):
_type = frozenset
def __init__(self, **kw):
if 'unique' in kw: # set members are always unique
raise TypeError(
"__init__() got an unexpected keyword argument 'unique'")
super(FrozenSet, self).__init__(unique=True, **kw)
VALIDATED_VALUES = threading.local()
def _validate_fields(schema, value, errors=None):
if errors is None:
errors = []
# Interface can be used as schema property for Object fields that plan to
# hold values of any type.
# Because Interface does not include any Attribute, it is obviously not
# worth looping on its methods and filter them all out.
if schema is Interface:
return errors
# if `value` is part of a cyclic graph, we need to break the cycle to avoid
# infinite recursion. Collect validated objects in a thread local dict by
# it's python represenation. A previous version was setting a volatile
# attribute which didn't work with security proxy
if id(value) in VALIDATED_VALUES.__dict__:
return errors
VALIDATED_VALUES.__dict__[id(value)] = True
# (If we have gotten here, we know that `value` provides an interface
# other than zope.interface.Interface;
# iow, we can rely on the fact that it is an instance
# that supports attribute assignment.)
try:
for name in schema.names(all=True):
if not IMethod.providedBy(schema[name]):
try:
attribute = schema[name]
if IChoice.providedBy(attribute):
# Choice must be bound before validation otherwise
# IContextSourceBinder is not iterable in validation
bound = attribute.bind(value)
bound.validate(getattr(value, name))
elif IField.providedBy(attribute):
# validate attributes that are fields
attribute.validate(getattr(value, name))
except ValidationError as error:
errors.append(error)
except AttributeError as error:
# property for the given name is not implemented
errors.append(SchemaNotFullyImplemented(error))
finally:
del VALIDATED_VALUES.__dict__[id(value)]
return errors
@implementer(IObject)
class Object(Field):
__doc__ = IObject.__doc__
def __init__(self, schema, **kw):
if not IInterface.providedBy(schema):
raise WrongType
self.schema = schema
super(Object, self).__init__(**kw)
def _validate(self, value):
super(Object, self)._validate(value)
# schema has to be provided by value
if not self.schema.providedBy(value):
raise SchemaNotProvided
# check the value against schema
errors = _validate_fields(self.schema, value)
if errors:
raise WrongContainedType(errors, self.__name__)
def set(self, object, value):
# Announce that we're going to assign the value to the object.
# Motivation: Widgets typically like to take care of policy-specific
# actions, like establishing location.
event = BeforeObjectAssignedEvent(value, self.__name__, object)
notify(event)
# The event subscribers are allowed to replace the object, thus we need
# to replace our previous value.
value = event.object
super(Object, self).set(object, value)
@implementer(IBeforeObjectAssignedEvent)
class BeforeObjectAssignedEvent(object):
"""An object is going to be assigned to an attribute on another object."""
def __init__(self, object, name, context):
self.object = object
self.name = name
self.context = context
@implementer(IDict)
class Dict(MinMaxLen, Iterable):
"""A field representing a Dict."""
_type = dict
key_type = None
value_type = None
def __init__(self, key_type=None, value_type=None, **kw):
super(Dict, self).__init__(**kw)
# whine if key_type or value_type is not a field
if key_type is not None and not IField.providedBy(key_type):
raise ValueError("'key_type' must be field instance.")
if value_type is not None and not IField.providedBy(value_type):
raise ValueError("'value_type' must be field instance.")
self.key_type = key_type
self.value_type = value_type
def _validate(self, value):
super(Dict, self)._validate(value)
errors = []
try:
if self.value_type:
errors = _validate_sequence(self.value_type, value.values(),
errors)
errors = _validate_sequence(self.key_type, value, errors)
if errors:
raise WrongContainedType(errors, self.__name__)
finally:
errors = None
def bind(self, object):
"""See zope.schema._bootstrapinterfaces.IField."""
clone = super(Dict, self).bind(object)
# binding value_type is necessary for choices with named vocabularies,
# and possibly also for other fields.
if clone.key_type is not None:
clone.key_type = clone.key_type.bind(object)
if clone.value_type is not None:
clone.value_type = clone.value_type.bind(object)
return clone
zope.schema-4.4.2/src/zope/schema/fieldproperty.py 0000664 0001750 0001750 00000011255 12312122016 023343 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Computed attributes based on schema fields
"""
from copy import copy
import sys
import zope.schema
from zope import interface
from zope import event
from zope.schema import interfaces
from zope.schema._bootstrapinterfaces import NO_VALUE
_marker = object()
@interface.implementer(interfaces.IFieldUpdatedEvent)
class FieldUpdatedEvent(object):
def __init__(self, inst, field, old_value, new_value):
self.inst = inst
self.field = field
self.old_value = old_value
self.new_value = new_value
class FieldProperty(object):
"""Computed attributes based on schema fields
Field properties provide default values, data validation and error messages
based on data found in field meta-data.
Note that FieldProperties cannot be used with slots. They can only
be used for attributes stored in instance dictionaries.
"""
def __init__(self, field, name=None):
if name is None:
name = field.__name__
self.__field = field
self.__name = name
def __get__(self, inst, klass):
if inst is None:
return self
value = inst.__dict__.get(self.__name, _marker)
if value is _marker:
field = self.__field.bind(inst)
value = getattr(field, 'default', _marker)
if value is _marker:
raise AttributeError(self.__name)
return value
def queryValue(self, inst, default):
value = inst.__dict__.get(self.__name, default)
if value is default:
field = self.__field.bind(inst)
value = getattr(field, 'default', default)
return value
def __set__(self, inst, value):
field = self.__field.bind(inst)
field.validate(value)
if field.readonly and self.__name in inst.__dict__:
raise ValueError(self.__name, 'field is readonly')
oldvalue = self.queryValue(inst, NO_VALUE)
inst.__dict__[self.__name] = value
event.notify(FieldUpdatedEvent(inst, field, oldvalue, value))
def __getattr__(self, name):
return getattr(self.__field, name)
def createFieldProperties(schema, omit=[]):
"""Creates a FieldProperty fields in `schema` on the class it is called on.
schema ... interface those fields should be added to class
omit ... list of field names to be omitted in creation
"""
frame = sys._getframe(1)
for name in zope.schema.getFieldNamesInOrder(schema):
if name in omit:
continue
frame.f_locals[name] = FieldProperty(schema[name])
class FieldPropertyStoredThroughField(object):
def __init__(self, field, name=None):
if name is None:
name = field.__name__
self.field = copy(field)
self.field.__name__ = "__st_%s_st" % self.field.__name__
self.__name = name
def setValue(self, inst, field, value):
field.set(inst, value)
def getValue(self, inst, field):
return field.query(inst, _marker)
def queryValue(self, inst, field, default):
return field.query(inst, default)
def __getattr__(self, name):
return getattr(self.field, name)
def __get__(self, inst, klass):
if inst is None:
return self
field = self.field.bind(inst)
value = self.getValue(inst, field)
if value is _marker:
value = getattr(field, 'default', _marker)
if value is _marker:
raise AttributeError(self.__name)
return value
def __set__(self, inst, value):
field = self.field.bind(inst)
field.validate(value)
if field.readonly:
if self.queryValue(inst, field, _marker) is _marker:
field.readonly = False
self.setValue(inst, field, value)
field.readonly = True
return
else:
raise ValueError(self.__name, 'field is readonly')
oldvalue = self.queryValue(inst, field, NO_VALUE)
self.setValue(inst, field, value)
event.notify(FieldUpdatedEvent(inst, self.field, oldvalue, value))
zope.schema-4.4.2/src/zope/schema/accessors.py 0000664 0001750 0001750 00000007002 12265302416 022446 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2003 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""
Field accessors
===============
Accessors are used to model methods used to access data defined by fields.
Accessors are fields that work by decorating existing fields.
To define accessors in an interface, use the accessors function::
class IMyInterface(Interface):
getFoo, setFoo = accessors(Text(title=u'Foo', ...))
getBar = accessors(TextLine(title=u'Foo', readonly=True, ...)
Normally a read accessor and a write accessor are defined. Only a
read accessor is defined for read-only fields.
Read accessors function as access method specifications and as field
specifications. Write accessors are solely method specifications.
"""
from zope.interface import providedBy, implementedBy
from zope.interface.interface import Method
class FieldReadAccessor(Method):
"""Field read accessor
"""
# A read field accessor is a method and a field.
# A read accessor is a decorator of a field, using the given
# fields properties to provide meta data.
def __provides__(self):
return providedBy(self.field) + implementedBy(FieldReadAccessor)
__provides__ = property(__provides__)
def __init__(self, field):
self.field = field
Method.__init__(self, '')
self.__doc__ = 'get %s' % field.__doc__
def getSignatureString(self):
return '()'
def getSignatureInfo(self):
return {'positional': (),
'required': (),
'optional': (),
'varargs': None,
'kwargs': None,
}
def get(self, object):
return getattr(object, self.__name__)()
def query(self, object, default=None):
try:
f = getattr(object, self.__name__)
except AttributeError:
return default
else:
return f()
def set(self, object, value):
if self.readonly:
raise TypeError("Can't set values on read-only fields")
getattr(object, self.writer.__name__)(value)
def __getattr__(self, name):
return getattr(self.field, name)
def bind(self, object):
clone = self.__class__.__new__(self.__class__)
clone.__dict__.update(self.__dict__)
clone.field = self.field.bind(object)
return clone
class FieldWriteAccessor(Method):
def __init__(self, field):
Method.__init__(self, '')
self.field = field
self.__doc__ = 'set %s' % field.__doc__
def getSignatureString(self):
return '(newvalue)'
def getSignatureInfo(self):
return {'positional': ('newvalue',),
'required': ('newvalue',),
'optional': (),
'varargs': None,
'kwargs': None,
}
def accessors(field):
reader = FieldReadAccessor(field)
yield reader
if not field.readonly:
writer = FieldWriteAccessor(field)
reader.writer = writer
yield writer
zope.schema-4.4.2/src/zope/schema/interfaces.py 0000664 0001750 0001750 00000052012 12402105713 022577 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Schema interfaces and exceptions
"""
__docformat__ = "reStructuredText"
from zope.interface import Interface, Attribute
from zope.interface.common.mapping import IEnumerableMapping
# Import from _bootstrapinterfaces only because other packages will expect
# to find these interfaces here.
from zope.schema._bootstrapfields import Field
from zope.schema._bootstrapfields import Text
from zope.schema._bootstrapfields import TextLine
from zope.schema._bootstrapfields import Bool
from zope.schema._bootstrapfields import Int
from zope.schema._bootstrapinterfaces import StopValidation
from zope.schema._bootstrapinterfaces import ValidationError
from zope.schema._bootstrapinterfaces import IFromUnicode
from zope.schema._bootstrapinterfaces import RequiredMissing
from zope.schema._bootstrapinterfaces import WrongType
from zope.schema._bootstrapinterfaces import ConstraintNotSatisfied
from zope.schema._bootstrapinterfaces import NotAContainer
from zope.schema._bootstrapinterfaces import NotAnIterator
from zope.schema._bootstrapinterfaces import TooSmall
from zope.schema._bootstrapinterfaces import TooBig
from zope.schema._bootstrapinterfaces import TooLong
from zope.schema._bootstrapinterfaces import TooShort
from zope.schema._bootstrapinterfaces import InvalidValue
from zope.schema._bootstrapinterfaces import IContextAwareDefaultFactory
from zope.schema._compat import PY3
from zope.schema._compat import u
from zope.schema._messageid import _
# pep 8 friendlyness
StopValidation, ValidationError, IFromUnicode, RequiredMissing, WrongType
ConstraintNotSatisfied, NotAContainer, NotAnIterator
TooSmall, TooBig, TooLong, TooShort, InvalidValue, IContextAwareDefaultFactory
class WrongContainedType(ValidationError):
__doc__ = _("""Wrong contained type""")
class NotUnique(ValidationError):
__doc__ = _("""One or more entries of sequence are not unique.""")
class SchemaNotFullyImplemented(ValidationError):
__doc__ = _("""Schema not fully implemented""")
class SchemaNotProvided(ValidationError):
__doc__ = _("""Schema not provided""")
class InvalidURI(ValidationError):
__doc__ = _("""The specified URI is not valid.""")
class InvalidId(ValidationError):
__doc__ = _("""The specified id is not valid.""")
class InvalidDottedName(ValidationError):
__doc__ = _("""The specified dotted name is not valid.""")
class Unbound(Exception):
__doc__ = _("""The field is not bound.""")
class IField(Interface):
"""Basic Schema Field Interface.
Fields are used for Interface specifications. They at least provide
a title, description and a default value. You can also
specify if they are required and/or readonly.
The Field Interface is also used for validation and specifying
constraints.
We want to make it possible for a IField to not only work
on its value but also on the object this value is bound to.
This enables a Field implementation to perform validation
against an object which also marks a certain place.
Note that many fields need information about the object
containing a field. For example, when validating a value to be
set as an object attribute, it may be necessary for the field to
introspect the object's state. This means that the field needs to
have access to the object when performing validation::
bound = field.bind(object)
bound.validate(value)
"""
def bind(object):
"""Return a copy of this field which is bound to context.
The copy of the Field will have the 'context' attribute set
to 'object'. This way a Field can implement more complex
checks involving the object's location/environment.
Many fields don't need to be bound. Only fields that condition
validation or properties on an object containing the field
need to be bound.
"""
title = TextLine(
title=_("Title"),
description=_("A short summary or label"),
default=u(""),
required=False,
)
description = Text(
title=_("Description"),
description=_("A description of the field"),
default=u(""),
required=False,
)
required = Bool(
title=_("Required"),
description=(_("Tells whether a field requires its value to exist.")),
default=True)
readonly = Bool(
title=_("Read Only"),
description=_("If true, the field's value cannot be changed."),
required=False,
default=False)
default = Field(
title=_("Default Value"),
description=_("""The field default value may be None or a legal
field value""")
)
missing_value = Field(
title=_("Missing Value"),
description=_("""If input for this Field is missing, and that's ok,
then this is the value to use""")
)
order = Int(
title=_("Field Order"),
description=_("""
The order attribute can be used to determine the order in
which fields in a schema were defined. If one field is created
after another (in the same thread), its order will be
greater.
(Fields in separate threads could have the same order.)
"""),
required=True,
readonly=True,
)
def constraint(value):
"""Check a customized constraint on the value.
You can implement this method with your Field to
require a certain constraint. This relaxes the need
to inherit/subclass a Field you to add a simple constraint.
Returns true if the given value is within the Field's constraint.
"""
def validate(value):
"""Validate that the given value is a valid field value.
Returns nothing but raises an error if the value is invalid.
It checks everything specific to a Field and also checks
with the additional constraint.
"""
def get(object):
"""Get the value of the field for the given object."""
def query(object, default=None):
"""Query the value of the field for the given object.
Return the default if the value hasn't been set.
"""
def set(object, value):
"""Set the value of the field for the object
Raises a type error if the field is a read-only field.
"""
class IIterable(IField):
"""Fields with a value that can be iterated over.
The value needs to support iteration; the implementation mechanism
is not constrained. (Either `__iter__()` or `__getitem__()` may be
used.)
"""
class IContainer(IField):
"""Fields whose value allows an ``x in value`` check.
The value needs to support the `in` operator, but is not
constrained in how it does so (whether it defines `__contains__()`
or `__getitem__()` is immaterial).
"""
class IOrderable(IField):
"""Field requiring its value to be orderable.
The set of value needs support a complete ordering; the
implementation mechanism is not constrained. Either `__cmp__()` or
'rich comparison' methods may be used.
"""
class ILen(IField):
"""A Field requiring its value to have a length.
The value needs to have a conventional __len__ method.
"""
class IMinMax(IOrderable):
"""Field requiring its value to be between min and max.
This implies that the value needs to support the IOrderable interface.
"""
min = Field(
title=_("Start of the range"),
required=False,
default=None
)
max = Field(
title=_("End of the range (including the value itself)"),
required=False,
default=None
)
class IMinMaxLen(ILen):
"""Field requiring the length of its value to be within a range"""
min_length = Int(
title=_("Minimum length"),
description=_("""
Value after whitespace processing cannot have less than
`min_length` characters (if a string type) or elements (if
another sequence type). If `min_length` is ``None``, there is
no minimum.
"""),
required=False,
min=0, # needs to be a positive number
default=0)
max_length = Int(
title=_("Maximum length"),
description=_("""
Value after whitespace processing cannot have greater
or equal than `max_length` characters (if a string type) or
elements (if another sequence type). If `max_length` is
``None``, there is no maximum."""),
required=False,
min=0, # needs to be a positive number
default=None)
class IInterfaceField(IField):
"""Fields with a value that is an interface (implementing
zope.interface.Interface)."""
class IBool(IField):
"""Boolean Field."""
default = Bool(
title=_("Default Value"),
description=_("""The field default value may be None or a legal
field value""")
)
class IBytes(IMinMaxLen, IIterable, IField):
"""Field containing a byte string (like the python str).
The value might be constrained to be with length limits.
"""
class IText(IMinMaxLen, IIterable, IField):
"""Field containing a unicode string."""
# for things which are of the str type on both Python 2 and 3
if PY3: # pragma: no cover
INativeString = IText
else: # pragma: no cover
INativeString = IBytes
class IASCII(INativeString):
"""Field containing a 7-bit ASCII string. No characters > DEL
(chr(127)) are allowed
The value might be constrained to be with length limits.
"""
class IBytesLine(IBytes):
"""Field containing a byte string without newlines."""
class IASCIILine(IASCII):
"""Field containing a 7-bit ASCII string without newlines."""
class ISourceText(IText):
"""Field for source text of object."""
class ITextLine(IText):
"""Field containing a unicode string without newlines."""
if PY3: # pragma: no cover
INativeStringLine = ITextLine
else: # pragma: no cover
INativeStringLine = IBytesLine
class IPassword(ITextLine):
"Field containing a unicode string without newlines that is a password."
class IInt(IMinMax, IField):
"""Field containing an Integer Value."""
min = Int(
title=_("Start of the range"),
required=False,
default=None
)
max = Int(
title=_("End of the range (including the value itself)"),
required=False,
default=None
)
default = Int(
title=_("Default Value"),
description=_("""The field default value may be None or a legal
field value""")
)
class IFloat(IMinMax, IField):
"""Field containing a Float."""
class IDecimal(IMinMax, IField):
"""Field containing a Decimal."""
class IDatetime(IMinMax, IField):
"""Field containing a DateTime."""
class IDate(IMinMax, IField):
"""Field containing a date."""
class ITimedelta(IMinMax, IField):
"""Field containing a timedelta."""
class ITime(IMinMax, IField):
"""Field containing a time."""
def _is_field(value):
if not IField.providedBy(value):
return False
return True
def _fields(values):
for value in values:
if not _is_field(value):
return False
return True
class IURI(INativeStringLine):
"""A field containing an absolute URI
"""
class IId(INativeStringLine):
"""A field containing a unique identifier
A unique identifier is either an absolute URI or a dotted name.
If it's a dotted name, it should have a module/package name as a prefix.
"""
class IDottedName(INativeStringLine):
"""Dotted name field.
Values of DottedName fields must be Python-style dotted names.
"""
min_dots = Int(
title=_("Minimum number of dots"),
required=True,
min=0,
default=0
)
max_dots = Int(
title=_("Maximum number of dots (should not be less than min_dots)"),
required=False,
default=None
)
class IChoice(IField):
"""Field whose value is contained in a predefined set
Only one, values or vocabulary, may be specified for a given choice.
"""
vocabulary = Field(
title=_("Vocabulary or source providing values"),
description=_("The ISource, IContextSourceBinder or IBaseVocabulary "
"object that provides values for this field."),
required=False,
default=None
)
vocabularyName = TextLine(
title=_("Vocabulary name"),
description=_("Vocabulary name to lookup in the vocabulary registry"),
required=False,
default=None
)
# Collections:
# Abstract
class ICollection(IMinMaxLen, IIterable, IContainer):
"""Abstract interface containing a collection value.
The Value must be iterable and may have a min_length/max_length.
"""
value_type = Field(
title=_("Value Type"),
description=_("Field value items must conform to the given type, "
"expressed via a Field."))
unique = Bool(
title=_('Unique Members'),
description=_('Specifies whether the members of the collection '
'must be unique.'),
default=False)
class ISequence(ICollection):
"""Abstract interface specifying that the value is ordered"""
class IUnorderedCollection(ICollection):
"""Abstract interface specifying that the value cannot be ordered"""
class IAbstractSet(IUnorderedCollection):
"""An unordered collection of unique values."""
unique = Attribute("This ICollection interface attribute must be True")
class IAbstractBag(IUnorderedCollection):
"""An unordered collection of values, with no limitations on whether
members are unique"""
unique = Attribute("This ICollection interface attribute must be False")
# Concrete
class ITuple(ISequence):
"""Field containing a value that implements the API of a conventional
Python tuple."""
class IList(ISequence):
"""Field containing a value that implements the API of a conventional
Python list."""
class ISet(IAbstractSet):
"""Field containing a value that implements the API of a Python2.4+ set.
"""
class IFrozenSet(IAbstractSet):
"""Field containing a value that implements the API of a conventional
Python 2.4+ frozenset."""
# (end Collections)
class IObject(IField):
"""Field containing an Object value."""
schema = Attribute(
"schema",
_("The Interface that defines the Fields comprising the Object.")
)
class IBeforeObjectAssignedEvent(Interface):
"""An object is going to be assigned to an attribute on another object.
Subscribers to this event can change the object on this event to change
what object is going to be assigned. This is useful, e.g. for wrapping
or replacing objects before they get assigned to conform to application
policy.
"""
object = Attribute("The object that is going to be assigned.")
name = Attribute("The name of the attribute under which the object "
"will be assigned.")
context = Attribute("The context object where the object will be "
"assigned to.")
class IDict(IMinMaxLen, IIterable, IContainer):
"""Field containing a conventional dict.
The key_type and value_type fields allow specification
of restrictions for keys and values contained in the dict.
"""
key_type = Attribute(
"key_type",
_("Field keys must conform to the given type, expressed via a Field.")
)
value_type = Attribute(
"value_type",
_("Field values must conform to the given type, expressed "
"via a Field.")
)
class ITerm(Interface):
"""Object representing a single value in a vocabulary."""
value = Attribute(
"value", "The value used to represent vocabulary term in a field.")
class ITokenizedTerm(ITerm):
"""Object representing a single value in a tokenized vocabulary.
"""
# Should be a ``zope.schema.ASCIILine``, but `ASCIILine` is not a bootstrap
# field.
token = Attribute(
"token",
"""Token which can be used to represent the value on a stream.
The value of this attribute must be a non-empty 7-bit string.
Control characters are not allowed.
""")
class ITitledTokenizedTerm(ITokenizedTerm):
"""A tokenized term that includes a title."""
title = TextLine(title=_("Title"))
class ISource(Interface):
"""A set of values from which to choose
Sources represent sets of values. They are used to specify the
source for choice fields.
Sources can be large (even infinite), in which case, they need to
be queried to find out what their values are.
"""
def __contains__(value):
"""Return whether the value is available in this source
"""
class ISourceQueriables(Interface):
"""A collection of objects for querying sources
"""
def getQueriables():
"""Return an iterable of objects that can be queried
The returned obects should be two-tuples with:
- A unicode id
The id must uniquely identify the queriable object within
the set of queriable objects. Furthermore, in subsequent
calls, the same id should be used for a given queriable
object.
- A queriable object
This is an object for which there is a view provided for
searching for items.
"""
class IContextSourceBinder(Interface):
def __call__(context):
"""Return a context-bound instance that implements ISource.
"""
class IBaseVocabulary(ISource):
"""Representation of a vocabulary.
At this most basic level, a vocabulary only need to support a test
for containment. This can be implemented either by __contains__()
or by sequence __getitem__() (the later only being useful for
vocabularies which are intrinsically ordered).
"""
def getTerm(value):
"""Return the ITerm object for the term 'value'.
If 'value' is not a valid term, this method raises LookupError.
"""
class IIterableSource(ISource):
"""Source which supports iteration over allowed values.
The objects iteration provides must be values from the source.
"""
def __iter__():
"""Return an iterator which provides the values from the source."""
def __len__():
"""Return the number of valid values, or sys.maxint."""
# BBB vocabularies are pending deprecation, hopefully in 3.3
class IIterableVocabulary(Interface):
"""Vocabulary which supports iteration over allowed values.
The objects iteration provides must conform to the ITerm
interface.
"""
def __iter__():
"""Return an iterator which provides the terms from the vocabulary."""
def __len__():
"""Return the number of valid terms, or sys.maxint."""
class IVocabulary(IIterableVocabulary, IBaseVocabulary):
"""Vocabulary which is iterable."""
class IVocabularyTokenized(IVocabulary):
"""Vocabulary that provides support for tokenized representation.
Terms returned from getTerm() and provided by iteration must
conform to ITokenizedTerm.
"""
def getTermByToken(token):
"""Return an ITokenizedTerm for the passed-in token.
If `token` is not represented in the vocabulary, `LookupError`
is raised.
"""
class ITreeVocabulary(IVocabularyTokenized, IEnumerableMapping):
"""A tokenized vocabulary with a tree-like structure.
The tree is implemented as dictionary, with keys being ITokenizedTerm
terms and the values being similar dictionaries. Leaf values are empty
dictionaries.
"""
class IVocabularyRegistry(Interface):
"""Registry that provides IBaseVocabulary objects for specific fields.
"""
def get(object, name):
"""Return the vocabulary named 'name' for the content object
'object'.
When the vocabulary cannot be found, LookupError is raised.
"""
class IVocabularyFactory(Interface):
"""Can create vocabularies."""
def __call__(context):
"""The context provides a location that the vocabulary can make use of.
"""
class IFieldEvent(Interface):
field = Attribute("The field that has been changed")
object = Attribute("The object containing the field")
class IFieldUpdatedEvent(IFieldEvent):
"""
A field has been modified
Subscribers will get the old and the new value together with the field
"""
old_value = Attribute("The value of the field before modification")
new_value = Attribute("The value of the field after modification")
zope.schema-4.4.2/src/zope/schema/tests/ 0000775 0001750 0001750 00000000000 12402106344 021245 5 ustar tseaver tseaver 0000000 0000000 zope.schema-4.4.2/src/zope/schema/tests/test_schema.py 0000664 0001750 0001750 00000021163 12265302416 024126 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Schema field tests
"""
import unittest
def _makeSchema():
from zope.schema._compat import b
from zope.schema._compat import u
from zope.interface import Interface
from zope.schema import Bytes
class ISchemaTest(Interface):
title = Bytes(
title=u("Title"),
description=u("Title"),
default=b(""),
required=True)
description = Bytes(
title=u("Description"),
description=u("Description"),
default=b(""),
required=True)
spam = Bytes(
title=u("Spam"),
description=u("Spam"),
default=b(""),
required=True)
return ISchemaTest
def _makeDerivedSchema(base=None):
from zope.schema._compat import b
from zope.schema._compat import u
from zope.schema import Bytes
if base is None:
base = _makeSchema()
class ISchemaTestSubclass(base):
foo = Bytes(
title=u('Foo'),
description=u('Fooness'),
default=b(""),
required=False)
return ISchemaTestSubclass
class Test_getFields(unittest.TestCase):
def _callFUT(self, schema):
from zope.schema import getFields
return getFields(schema)
def test_simple(self):
fields = self._callFUT(_makeSchema())
self.assertTrue('title' in fields)
self.assertTrue('description' in fields)
self.assertTrue('spam' in fields)
# test whether getName() has the right value
for key, value in fields.items():
self.assertEqual(key, value.getName())
def test_derived(self):
fields = self._callFUT(_makeDerivedSchema())
self.assertTrue('title' in fields)
self.assertTrue('description' in fields)
self.assertTrue('spam' in fields)
self.assertTrue('foo' in fields)
# test whether getName() has the right value
for key, value in fields.items():
self.assertEqual(key, value.getName())
class Test_getFieldsInOrder(unittest.TestCase):
def _callFUT(self, schema):
from zope.schema import getFieldsInOrder
return getFieldsInOrder(schema)
def test_simple(self):
fields = self._callFUT(_makeSchema())
field_names = [name for name, field in fields]
self.assertEqual(field_names, ['title', 'description', 'spam'])
for key, value in fields:
self.assertEqual(key, value.getName())
def test_derived(self):
fields = self._callFUT(_makeDerivedSchema())
field_names = [name for name, field in fields]
self.assertEqual(field_names, ['title', 'description', 'spam', 'foo'])
for key, value in fields:
self.assertEqual(key, value.getName())
class Test_getFieldNames(unittest.TestCase):
def _callFUT(self, schema):
from zope.schema import getFieldNames
return getFieldNames(schema)
def test_simple(self):
names = self._callFUT(_makeSchema())
self.assertEqual(len(names), 3)
self.assertTrue('title' in names)
self.assertTrue('description' in names)
self.assertTrue('spam' in names)
def test_derived(self):
names = self._callFUT(_makeDerivedSchema())
self.assertEqual(len(names), 4)
self.assertTrue('title' in names)
self.assertTrue('description' in names)
self.assertTrue('spam' in names)
self.assertTrue('foo' in names)
class Test_getFieldNamesInOrder(unittest.TestCase):
def _callFUT(self, schema):
from zope.schema import getFieldNamesInOrder
return getFieldNamesInOrder(schema)
def test_simple(self):
names = self._callFUT(_makeSchema())
self.assertEqual(names, ['title', 'description', 'spam'])
def test_derived(self):
names = self._callFUT(_makeDerivedSchema())
self.assertEqual(names, ['title', 'description', 'spam', 'foo'])
class Test_getValidationErrors(unittest.TestCase):
def _callFUT(self, schema, object):
from zope.schema import getValidationErrors
return getValidationErrors(schema, object)
def test_schema(self):
from zope.interface import Interface
class IEmpty(Interface):
pass
errors = self._callFUT(IEmpty, object())
self.assertEqual(len(errors), 0)
def test_schema_with_field_errors(self):
from zope.interface import Interface
from zope.schema import Text
from zope.schema.interfaces import SchemaNotFullyImplemented
class IWithRequired(Interface):
must = Text(required=True)
errors = self._callFUT(IWithRequired, object())
self.assertEqual(len(errors), 1)
self.assertEqual(errors[0][0], 'must')
self.assertEqual(errors[0][1].__class__, SchemaNotFullyImplemented)
def test_schema_with_invariant_errors(self):
from zope.interface import Interface
from zope.interface import invariant
from zope.interface.exceptions import Invalid
class IWithFailingInvariant(Interface):
@invariant
def _epic_fail(obj):
raise Invalid('testing')
errors = self._callFUT(IWithFailingInvariant, object())
self.assertEqual(len(errors), 1)
self.assertEqual(errors[0][0], None)
self.assertEqual(errors[0][1].__class__, Invalid)
def test_schema_with_invariant_ok(self):
from zope.interface import Interface
from zope.interface import invariant
class IWithPassingInvariant(Interface):
@invariant
def _hall_pass(obj):
pass
errors = self._callFUT(IWithPassingInvariant, object())
self.assertEqual(len(errors), 0)
class Test_getSchemaValidationErrors(unittest.TestCase):
def _callFUT(self, schema, object):
from zope.schema import getSchemaValidationErrors
return getSchemaValidationErrors(schema, object)
def test_schema_wo_fields(self):
from zope.interface import Interface
from zope.interface import Attribute
class INoFields(Interface):
def method():
pass
attr = Attribute('ignoreme')
errors = self._callFUT(INoFields, object())
self.assertEqual(len(errors), 0)
def test_schema_with_fields_ok(self):
from zope.interface import Interface
from zope.schema import Text
from zope.schema._compat import u
class IWithFields(Interface):
foo = Text()
bar = Text()
class Obj(object):
foo = u('Foo')
bar = u('Bar')
errors = self._callFUT(IWithFields, Obj())
self.assertEqual(len(errors), 0)
def test_schema_with_missing_field(self):
from zope.interface import Interface
from zope.schema import Text
from zope.schema.interfaces import SchemaNotFullyImplemented
class IWithRequired(Interface):
must = Text(required=True)
errors = self._callFUT(IWithRequired, object())
self.assertEqual(len(errors), 1)
self.assertEqual(errors[0][0], 'must')
self.assertEqual(errors[0][1].__class__, SchemaNotFullyImplemented)
def test_schema_with_invalid_field(self):
from zope.interface import Interface
from zope.schema import Int
from zope.schema.interfaces import TooSmall
class IWithMinium(Interface):
value = Int(required=True, min=0)
class Obj(object):
value = -1
errors = self._callFUT(IWithMinium, Obj())
self.assertEqual(len(errors), 1)
self.assertEqual(errors[0][0], 'value')
self.assertEqual(errors[0][1].__class__, TooSmall)
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(Test_getFields),
unittest.makeSuite(Test_getFieldsInOrder),
unittest.makeSuite(Test_getFieldNames),
unittest.makeSuite(Test_getFieldNamesInOrder),
unittest.makeSuite(Test_getValidationErrors),
unittest.makeSuite(Test_getSchemaValidationErrors),
))
zope.schema-4.4.2/src/zope/schema/tests/test_equality.py 0000664 0001750 0001750 00000002367 12265302416 024530 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Field equality tests
"""
import unittest
class FieldEqualityTests(unittest.TestCase):
def test_equality(self):
from zope.schema._compat import u
from zope.schema import Int
from zope.schema import Text
# pep 8 friendlyness
u, Int, Text
equality = [
'Text(title=u("Foo"), description=u("Bar"))',
'Int(title=u("Foo"), description=u("Bar"))',
]
for text in equality:
self.assertEqual(eval(text), eval(text))
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(FieldEqualityTests),
))
zope.schema-4.4.2/src/zope/schema/tests/__init__.py 0000664 0001750 0001750 00000003551 12072655571 023400 0 ustar tseaver tseaver 0000000 0000000 #
# This file is necessary to make this directory a package.
import re
from zope.schema._compat import PY3
from zope.testing import renormalizing
if PY3:
py3_checker = renormalizing.RENormalizing([
(re.compile(r"u'([^']*)'"),
r"'\1'"),
(re.compile(r"^b'([^']*)'"),
r"'\1'"),
(re.compile(r"([^'])b'([^']*)'"),
r"\1'\2'"),
(re.compile(r""),
r""),
(re.compile(r""),
r""),
(re.compile(r"zope.schema._bootstrapinterfaces.InvalidValue"),
r"InvalidValue"),
(re.compile(r"zope.schema.interfaces.InvalidId: '([^']*)'"),
r"InvalidId: \1"),
(re.compile(r"zope.schema.interfaces.InvalidId:"),
r"InvalidId:"),
(re.compile(r"zope.schema.interfaces.InvalidURI: '([^']*)'"),
r"InvalidURI: \1"),
(re.compile(r"zope.schema.interfaces.InvalidURI:"),
r"InvalidURI:"),
(re.compile(r"zope.schema.interfaces.InvalidDottedName: '([^']*)'"),
r"InvalidDottedName: \1"),
(re.compile(r"zope.schema.interfaces.InvalidDottedName:"),
r"InvalidDottedName:"),
(re.compile(
r"zope.schema._bootstrapinterfaces.ConstraintNotSatisfied: '([^']*)'"
),
r"ConstraintNotSatisfied: \1"),
(re.compile(
r"zope.schema._bootstrapinterfaces.ConstraintNotSatisfied:"),
r"ConstraintNotSatisfied:"),
(re.compile(r"zope.schema._bootstrapinterfaces.WrongType:"),
r"WrongType:"),
])
else:
py3_checker = renormalizing.RENormalizing([
(re.compile(r"([^'])b'([^']*)'"),
r"\1'\2'"),
])
zope.schema-4.4.2/src/zope/schema/tests/states.py 0000664 0001750 0001750 00000006746 12265302416 023144 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2003 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Sample vocabulary supporting state abbreviations.
"""
from zope.schema._compat import u
from zope.interface import implementer
from zope.schema import interfaces
from zope.schema import Choice
# This table is based on information from the United States Postal Service:
# http://www.usps.com/ncsc/lookups/abbreviations.html#states
_states = {
'AL': u('Alabama'),
'AK': u('Alaska'),
'AS': u('American Samoa'),
'AZ': u('Arizona'),
'AR': u('Arkansas'),
'CA': u('California'),
'CO': u('Colorado'),
'CT': u('Connecticut'),
'DE': u('Delaware'),
'DC': u('District of Columbia'),
'FM': u('Federated States of Micronesia'),
'FL': u('Florida'),
'GA': u('Georgia'),
'GU': u('Guam'),
'HI': u('Hawaii'),
'ID': u('Idaho'),
'IL': u('Illinois'),
'IN': u('Indiana'),
'IA': u('Iowa'),
'KS': u('Kansas'),
'KY': u('Kentucky'),
'LA': u('Louisiana'),
'ME': u('Maine'),
'MH': u('Marshall Islands'),
'MD': u('Maryland'),
'MA': u('Massachusetts'),
'MI': u('Michigan'),
'MN': u('Minnesota'),
'MS': u('Mississippi'),
'MO': u('Missouri'),
'MT': u('Montana'),
'NE': u('Nebraska'),
'NV': u('Nevada'),
'NH': u('New Hampshire'),
'NJ': u('New Jersey'),
'NM': u('New Mexico'),
'NY': u('New York'),
'NC': u('North Carolina'),
'ND': u('North Dakota'),
'MP': u('Northern Mariana Islands'),
'OH': u('Ohio'),
'OK': u('Oklahoma'),
'OR': u('Oregon'),
'PW': u('Palau'),
'PA': u('Pennsylvania'),
'PR': u('Puerto Rico'),
'RI': u('Rhode Island'),
'SC': u('South Carolina'),
'SD': u('South Dakota'),
'TN': u('Tennessee'),
'TX': u('Texas'),
'UT': u('Utah'),
'VT': u('Vermont'),
'VI': u('Virgin Islands'),
'VA': u('Virginia'),
'WA': u('Washington'),
'WV': u('West Virginia'),
'WI': u('Wisconsin'),
'WY': u('Wyoming'),
}
@implementer(interfaces.ITerm)
class State(object):
__slots__ = 'value', 'title'
def __init__(self, value, title):
self.value = value
self.title = title
for v, p in _states.items():
_states[v] = State(v, p)
class IStateVocabulary(interfaces.IVocabulary):
"""Vocabularies that support the states database conform to this."""
@implementer(IStateVocabulary)
class StateVocabulary(object):
__slots__ = ()
def __init__(self, object=None):
pass
def __contains__(self, value):
return value in _states
def __iter__(self):
return iter(_states.values())
def __len__(self):
return len(_states)
def getTerm(self, value):
return _states[value]
class StateSelectionField(Choice):
vocabulary = StateVocabulary()
def __init__(self, **kw):
super(StateSelectionField, self).__init__(
vocabulary=StateSelectionField.vocabulary,
**kw)
self.vocabularyName = "states"
zope.schema-4.4.2/src/zope/schema/tests/test__field.py 0000664 0001750 0001750 00000236621 12312122016 024104 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2012 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
import unittest
class BytesTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Bytes
return Bytes
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IBytes(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IBytes
verifyClass(IBytes, self._getTargetClass())
def test_instance_conforms_to_IBytes(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IBytes
verifyObject(IBytes, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_w_invalid_default(self):
from zope.schema._compat import u
from zope.schema.interfaces import ValidationError
self.assertRaises(ValidationError, self._makeOne, default=u(''))
def test_validate_not_required(self):
from zope.schema._compat import b
field = self._makeOne(required=False)
field.validate(b(''))
field.validate(b('abc'))
field.validate(b('abc\ndef'))
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
from zope.schema._compat import b
field = self._makeOne()
field.validate(b(''))
field.validate(b('abc'))
field.validate(b('abc\ndef'))
self.assertRaises(RequiredMissing, field.validate, None)
def test_fromUnicode_miss(self):
from zope.schema._compat import u
byt = self._makeOne()
self.assertRaises(UnicodeEncodeError, byt.fromUnicode, u(chr(129)))
def test_fromUnicode_hit(self):
from zope.schema._compat import u
from zope.schema._compat import b
byt = self._makeOne()
self.assertEqual(byt.fromUnicode(u('')), b(''))
self.assertEqual(byt.fromUnicode(u('DEADBEEF')), b('DEADBEEF'))
class ASCIITests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import ASCII
return ASCII
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IASCII(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IASCII
verifyClass(IASCII, self._getTargetClass())
def test_instance_conforms_to_IASCII(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IASCII
verifyObject(IASCII, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import non_native_string
field = self._makeOne()
self.assertRaises(WrongType, field.validate, non_native_string(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test__validate_empty(self):
asc = self._makeOne()
asc._validate('') # no error
def test__validate_non_empty_miss(self):
from zope.schema.interfaces import InvalidValue
asc = self._makeOne()
self.assertRaises(InvalidValue, asc._validate, chr(129))
def test__validate_non_empty_hit(self):
asc = self._makeOne()
for i in range(128):
asc._validate(chr(i)) # doesn't raise
class BytesLineTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import BytesLine
return BytesLine
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IBytesLine(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IBytesLine
verifyClass(IBytesLine, self._getTargetClass())
def test_instance_conforms_to_IBytesLine(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IBytesLine
verifyObject(IBytesLine, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
from zope.schema._compat import b
field = self._makeOne(required=False)
field.validate(None)
field.validate(b(''))
field.validate(b('abc'))
field.validate(b('\xab\xde'))
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
from zope.schema._compat import b
field = self._makeOne()
field.validate(b(''))
field.validate(b('abc'))
field.validate(b('\xab\xde'))
self.assertRaises(RequiredMissing, field.validate, None)
def test_constraint(self):
from zope.schema._compat import b
field = self._makeOne()
self.assertEqual(field.constraint(b('')), True)
self.assertEqual(field.constraint(b('abc')), True)
self.assertEqual(field.constraint(b('abc')), True)
self.assertEqual(field.constraint(b('\xab\xde')), True)
self.assertEqual(field.constraint(b('abc\ndef')), False)
class ASCIILineTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import ASCIILine
return ASCIILine
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IASCIILine(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IASCIILine
verifyClass(IASCIILine, self._getTargetClass())
def test_instance_conforms_to_IASCIILine(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IASCIILine
verifyObject(IASCIILine, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import non_native_string
field = self._makeOne()
self.assertRaises(WrongType, field.validate, non_native_string(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
from zope.schema.interfaces import InvalidValue
field = self._makeOne(required=False)
field.validate(None)
field.validate('')
field.validate('abc')
self.assertRaises(InvalidValue, field.validate, '\xab\xde')
def test_validate_required(self):
from zope.schema.interfaces import InvalidValue
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate('')
field.validate('abc')
self.assertRaises(InvalidValue, field.validate, '\xab\xde')
self.assertRaises(RequiredMissing, field.validate, None)
def test_constraint(self):
field = self._makeOne()
self.assertEqual(field.constraint(''), True)
self.assertEqual(field.constraint('abc'), True)
self.assertEqual(field.constraint('abc'), True)
# Non-ASCII byltes get checked in '_validate'.
self.assertEqual(field.constraint('\xab\xde'), True)
self.assertEqual(field.constraint('abc\ndef'), False)
class FloatTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Float
return Float
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IFloat(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IFloat
verifyClass(IFloat, self._getTargetClass())
def test_instance_conforms_to_IFloat(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IFloat
verifyObject(IFloat, self._makeOne())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate(None)
field.validate(10.0)
field.validate(0.93)
field.validate(1000.0003)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(10.0)
field.validate(0.93)
field.validate(1000.0003)
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min(self):
from zope.schema.interfaces import TooSmall
field = self._makeOne(min=10.5)
field.validate(10.6)
field.validate(20.2)
self.assertRaises(TooSmall, field.validate, -9.0)
self.assertRaises(TooSmall, field.validate, 10.4)
def test_validate_max(self):
from zope.schema.interfaces import TooBig
field = self._makeOne(max=10.5)
field.validate(5.3)
field.validate(-9.1)
self.assertRaises(TooBig, field.validate, 10.51)
self.assertRaises(TooBig, field.validate, 20.7)
def test_validate_min_and_max(self):
from zope.schema.interfaces import TooBig
from zope.schema.interfaces import TooSmall
field = self._makeOne(min=-0.6, max=10.1)
field.validate(0.0)
field.validate(-0.03)
field.validate(10.0001)
self.assertRaises(TooSmall, field.validate, -10.0)
self.assertRaises(TooSmall, field.validate, -1.6)
self.assertRaises(TooBig, field.validate, 11.45)
self.assertRaises(TooBig, field.validate, 20.02)
def test_fromUnicode_miss(self):
from zope.schema._compat import u
flt = self._makeOne()
self.assertRaises(ValueError, flt.fromUnicode, u(''))
self.assertRaises(ValueError, flt.fromUnicode, u('abc'))
self.assertRaises(ValueError, flt.fromUnicode, u('14.G'))
def test_fromUnicode_hit(self):
from zope.schema._compat import u
flt = self._makeOne()
self.assertEqual(flt.fromUnicode(u('0')), 0.0)
self.assertEqual(flt.fromUnicode(u('1.23')), 1.23)
self.assertEqual(flt.fromUnicode(u('1.23e6')), 1230000.0)
class DecimalTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Decimal
return Decimal
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IDecimal(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IDecimal
verifyClass(IDecimal, self._getTargetClass())
def test_instance_conforms_to_IDecimal(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IDecimal
verifyObject(IDecimal, self._makeOne())
def test_validate_not_required(self):
import decimal
field = self._makeOne(required=False)
field.validate(decimal.Decimal("10.0"))
field.validate(decimal.Decimal("0.93"))
field.validate(decimal.Decimal("1000.0003"))
field.validate(None)
def test_validate_required(self):
import decimal
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(decimal.Decimal("10.0"))
field.validate(decimal.Decimal("0.93"))
field.validate(decimal.Decimal("1000.0003"))
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min(self):
import decimal
from zope.schema.interfaces import TooSmall
field = self._makeOne(min=decimal.Decimal("10.5"))
field.validate(decimal.Decimal("10.6"))
field.validate(decimal.Decimal("20.2"))
self.assertRaises(TooSmall, field.validate, decimal.Decimal("-9.0"))
self.assertRaises(TooSmall, field.validate, decimal.Decimal("10.4"))
def test_validate_max(self):
import decimal
from zope.schema.interfaces import TooBig
field = self._makeOne(max=decimal.Decimal("10.5"))
field.validate(decimal.Decimal("5.3"))
field.validate(decimal.Decimal("-9.1"))
self.assertRaises(TooBig, field.validate, decimal.Decimal("10.51"))
self.assertRaises(TooBig, field.validate, decimal.Decimal("20.7"))
def test_validate_min_and_max(self):
import decimal
from zope.schema.interfaces import TooBig
from zope.schema.interfaces import TooSmall
field = self._makeOne(min=decimal.Decimal("-0.6"),
max=decimal.Decimal("10.1"))
field.validate(decimal.Decimal("0.0"))
field.validate(decimal.Decimal("-0.03"))
field.validate(decimal.Decimal("10.0001"))
self.assertRaises(TooSmall, field.validate, decimal.Decimal("-10.0"))
self.assertRaises(TooSmall, field.validate, decimal.Decimal("-1.6"))
self.assertRaises(TooBig, field.validate, decimal.Decimal("11.45"))
self.assertRaises(TooBig, field.validate, decimal.Decimal("20.02"))
def test_fromUnicode_miss(self):
from zope.schema._compat import u
flt = self._makeOne()
self.assertRaises(ValueError, flt.fromUnicode, u(''))
self.assertRaises(ValueError, flt.fromUnicode, u('abc'))
self.assertRaises(ValueError, flt.fromUnicode, u('1.4G'))
def test_fromUnicode_hit(self):
from decimal import Decimal
from zope.schema._compat import u
flt = self._makeOne()
self.assertEqual(flt.fromUnicode(u('0')), Decimal('0.0'))
self.assertEqual(flt.fromUnicode(u('1.23')), Decimal('1.23'))
self.assertEqual(flt.fromUnicode(u('12345.6')), Decimal('12345.6'))
class DatetimeTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Datetime
return Datetime
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IDatetime(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IDatetime
verifyClass(IDatetime, self._getTargetClass())
def test_instance_conforms_to_IDatetime(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IDatetime
verifyObject(IDatetime, self._makeOne())
def test_validate_wrong_types(self):
from datetime import date
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
self.assertRaises(WrongType, field.validate, date.today())
def test_validate_not_required(self):
from datetime import datetime
field = self._makeOne(required=False)
field.validate(None) # doesn't raise
field.validate(datetime.now()) # doesn't raise
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne(required=True)
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_w_min(self):
from datetime import datetime
from zope.schema.interfaces import TooSmall
d1 = datetime(2000, 10, 1)
d2 = datetime(2000, 10, 2)
field = self._makeOne(min=d1)
field.validate(d1) # doesn't raise
field.validate(d2) # doesn't raise
self.assertRaises(TooSmall, field.validate, datetime(2000, 9, 30))
def test_validate_w_max(self):
from datetime import datetime
from zope.schema.interfaces import TooBig
d1 = datetime(2000, 10, 1)
d2 = datetime(2000, 10, 2)
d3 = datetime(2000, 10, 3)
field = self._makeOne(max=d2)
field.validate(d1) # doesn't raise
field.validate(d2) # doesn't raise
self.assertRaises(TooBig, field.validate, d3)
def test_validate_w_min_and_max(self):
from datetime import datetime
from zope.schema.interfaces import TooBig
from zope.schema.interfaces import TooSmall
d1 = datetime(2000, 10, 1)
d2 = datetime(2000, 10, 2)
d3 = datetime(2000, 10, 3)
d4 = datetime(2000, 10, 4)
d5 = datetime(2000, 10, 5)
field = self._makeOne(min=d2, max=d4)
field.validate(d2) # doesn't raise
field.validate(d3) # doesn't raise
field.validate(d4) # doesn't raise
self.assertRaises(TooSmall, field.validate, d1)
self.assertRaises(TooBig, field.validate, d5)
class DateTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Date
return Date
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IDate(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IDate
verifyClass(IDate, self._getTargetClass())
def test_instance_conforms_to_IDate(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IDate
verifyObject(IDate, self._makeOne())
def test_validate_wrong_types(self):
from datetime import datetime
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
self.assertRaises(WrongType, field.validate, datetime.now())
def test_validate_not_required(self):
from datetime import date
field = self._makeOne(required=False)
field.validate(None)
field.validate(date.today())
def test_validate_required(self):
from datetime import datetime
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(datetime.now().date())
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_w_min(self):
from datetime import date
from datetime import datetime
from zope.schema.interfaces import TooSmall
d1 = date(2000, 10, 1)
d2 = date(2000, 10, 2)
field = self._makeOne(min=d1)
field.validate(d1)
field.validate(d2)
field.validate(datetime.now().date())
self.assertRaises(TooSmall, field.validate, date(2000, 9, 30))
def test_validate_w_max(self):
from datetime import date
from zope.schema.interfaces import TooBig
d1 = date(2000, 10, 1)
d2 = date(2000, 10, 2)
d3 = date(2000, 10, 3)
field = self._makeOne(max=d2)
field.validate(d1)
field.validate(d2)
self.assertRaises(TooBig, field.validate, d3)
def test_validate_w_min_and_max(self):
from datetime import date
from zope.schema.interfaces import TooBig
from zope.schema.interfaces import TooSmall
d1 = date(2000, 10, 1)
d2 = date(2000, 10, 2)
d3 = date(2000, 10, 3)
d4 = date(2000, 10, 4)
d5 = date(2000, 10, 5)
field = self._makeOne(min=d2, max=d4)
field.validate(d2)
field.validate(d3)
field.validate(d4)
self.assertRaises(TooSmall, field.validate, d1)
self.assertRaises(TooBig, field.validate, d5)
class TimedeltaTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Timedelta
return Timedelta
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_ITimedelta(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import ITimedelta
verifyClass(ITimedelta, self._getTargetClass())
def test_instance_conforms_to_ITimedelta(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import ITimedelta
verifyObject(ITimedelta, self._makeOne())
def test_validate_not_required(self):
from datetime import timedelta
field = self._makeOne(required=False)
field.validate(None)
field.validate(timedelta(minutes=15))
def test_validate_required(self):
from datetime import timedelta
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(timedelta(minutes=15))
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min(self):
from datetime import timedelta
from zope.schema.interfaces import TooSmall
t1 = timedelta(hours=2)
t2 = timedelta(hours=3)
field = self._makeOne(min=t1)
field.validate(t1)
field.validate(t2)
self.assertRaises(TooSmall, field.validate, timedelta(hours=1))
def test_validate_max(self):
from datetime import timedelta
from zope.schema.interfaces import TooBig
t1 = timedelta(minutes=1)
t2 = timedelta(minutes=2)
t3 = timedelta(minutes=3)
field = self._makeOne(max=t2)
field.validate(t1)
field.validate(t2)
self.assertRaises(TooBig, field.validate, t3)
def test_validate_min_and_max(self):
from datetime import timedelta
from zope.schema.interfaces import TooBig
from zope.schema.interfaces import TooSmall
t1 = timedelta(days=1)
t2 = timedelta(days=2)
t3 = timedelta(days=3)
t4 = timedelta(days=4)
t5 = timedelta(days=5)
field = self._makeOne(min=t2, max=t4)
field.validate(t2)
field.validate(t3)
field.validate(t4)
self.assertRaises(TooSmall, field.validate, t1)
self.assertRaises(TooBig, field.validate, t5)
class TimeTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Time
return Time
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_ITime(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import ITime
verifyClass(ITime, self._getTargetClass())
def test_instance_conforms_to_ITime(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import ITime
verifyObject(ITime, self._makeOne())
def test_validate_not_required(self):
from datetime import time
field = self._makeOne(required=False)
field.validate(None)
field.validate(time(12, 15, 37))
def test_validate_required(self):
from datetime import time
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(time(12, 15, 37))
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min(self):
from datetime import time
from zope.schema.interfaces import TooSmall
t1 = time(12, 15, 37)
t2 = time(12, 25, 18)
t3 = time(12, 42, 43)
field = self._makeOne(min=t2)
field.validate(t2)
field.validate(t3)
self.assertRaises(TooSmall, field.validate, t1)
def test_validate_max(self):
from datetime import time
from zope.schema.interfaces import TooBig
t1 = time(12, 15, 37)
t2 = time(12, 25, 18)
t3 = time(12, 42, 43)
field = self._makeOne(max=t2)
field.validate(t1)
field.validate(t2)
self.assertRaises(TooBig, field.validate, t3)
def test_validate_min_and_max(self):
from datetime import time
from zope.schema.interfaces import TooBig
from zope.schema.interfaces import TooSmall
t1 = time(12, 15, 37)
t2 = time(12, 25, 18)
t3 = time(12, 42, 43)
t4 = time(13, 7, 12)
t5 = time(14, 22, 9)
field = self._makeOne(min=t2, max=t4)
field.validate(t2)
field.validate(t3)
field.validate(t4)
self.assertRaises(TooSmall, field.validate, t1)
self.assertRaises(TooBig, field.validate, t5)
class ChoiceTests(unittest.TestCase):
def setUp(self):
from zope.schema.vocabulary import _clear
_clear()
def tearDown(self):
from zope.schema.vocabulary import _clear
_clear()
def _getTargetClass(self):
from zope.schema._field import Choice
return Choice
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IChoice(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IChoice
verifyClass(IChoice, self._getTargetClass())
def test_instance_conforms_to_IChoice(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IChoice
verifyObject(IChoice, self._makeOne(values=[1, 2, 3]))
def test_ctor_wo_values_vocabulary_or_source(self):
self.assertRaises(ValueError, self._makeOne)
def test_ctor_invalid_vocabulary(self):
self.assertRaises(ValueError, self._makeOne, vocabulary=object())
def test_ctor_invalid_source(self):
self.assertRaises(ValueError, self._makeOne, source=object())
def test_ctor_both_vocabulary_and_source(self):
self.assertRaises(
ValueError,
self._makeOne, vocabulary='voc.name', source=object()
)
def test_ctor_both_vocabulary_and_values(self):
self.assertRaises(ValueError,
self._makeOne, vocabulary='voc.name', values=[1, 2])
def test_ctor_w_values(self):
from zope.schema.vocabulary import SimpleVocabulary
choose = self._makeOne(values=[1, 2])
self.assertTrue(isinstance(choose.vocabulary, SimpleVocabulary))
self.assertEqual(sorted(choose.vocabulary.by_value.keys()), [1, 2])
self.assertEqual(sorted(choose.source.by_value.keys()), [1, 2])
def test_ctor_w_named_vocabulary(self):
choose = self._makeOne(vocabulary="vocab")
self.assertEqual(choose.vocabularyName, 'vocab')
def test_ctor_w_preconstructed_vocabulary(self):
v = _makeSampleVocabulary()
choose = self._makeOne(vocabulary=v)
self.assertTrue(choose.vocabulary is v)
self.assertTrue(choose.vocabularyName is None)
def test_bind_w_preconstructed_vocabulary(self):
from zope.schema.interfaces import ValidationError
from zope.schema.vocabulary import setVocabularyRegistry
v = _makeSampleVocabulary()
setVocabularyRegistry(_makeDummyRegistry(v))
choose = self._makeOne(vocabulary='vocab')
bound = choose.bind(None)
self.assertEqual(bound.vocabulary, v)
self.assertEqual(bound.vocabularyName, 'vocab')
bound.default = 1
self.assertEqual(bound.default, 1)
def _provoke(bound):
bound.default = 42
self.assertRaises(ValidationError, _provoke, bound)
def test_bind_w_voc_not_ICSB(self):
from zope.interface import implementer
from zope.schema.interfaces import ISource
from zope.schema.interfaces import IBaseVocabulary
@implementer(IBaseVocabulary)
@implementer(ISource)
class Vocab(object):
def __init__(self):
pass
source = self._makeOne(vocabulary=Vocab())
instance = DummyInstance()
target = source.bind(instance)
self.assertTrue(target.vocabulary is source.vocabulary)
def test_bind_w_voc_is_ICSB(self):
from zope.interface import implementer
from zope.schema.interfaces import IContextSourceBinder
from zope.schema.interfaces import ISource
@implementer(IContextSourceBinder)
@implementer(ISource)
class Vocab(object):
def __init__(self, context):
self.context = context
def __call__(self, context):
return self.__class__(context)
# Chicken-egg
source = self._makeOne(vocabulary='temp')
source.vocabulary = Vocab(source)
source.vocabularyName = None
instance = DummyInstance()
target = source.bind(instance)
self.assertEqual(target.vocabulary.context, instance)
def test_bind_w_voc_is_ICSB_but_not_ISource(self):
from zope.interface import implementer
from zope.schema.interfaces import IContextSourceBinder
@implementer(IContextSourceBinder)
class Vocab(object):
def __init__(self, context):
self.context = context
def __call__(self, context):
return self.__class__(context)
# Chicken-egg
source = self._makeOne(vocabulary='temp')
source.vocabulary = Vocab(source)
source.vocabularyName = None
instance = DummyInstance()
self.assertRaises(ValueError, source.bind, instance)
def test_fromUnicode_miss(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema._compat import u
flt = self._makeOne(values=(u('foo'), u('bar'), u('baz')))
self.assertRaises(ConstraintNotSatisfied, flt.fromUnicode, u(''))
self.assertRaises(ConstraintNotSatisfied, flt.fromUnicode, u('abc'))
self.assertRaises(ConstraintNotSatisfied, flt.fromUnicode, u('1.4G'))
def test_fromUnicode_hit(self):
from zope.schema._compat import u
flt = self._makeOne(values=(u('foo'), u('bar'), u('baz')))
self.assertEqual(flt.fromUnicode(u('foo')), u('foo'))
self.assertEqual(flt.fromUnicode(u('bar')), u('bar'))
self.assertEqual(flt.fromUnicode(u('baz')), u('baz'))
def test__validate_int(self):
from zope.schema.interfaces import ConstraintNotSatisfied
choice = self._makeOne(values=[1, 3])
choice._validate(1) # doesn't raise
choice._validate(3) # doesn't raise
self.assertRaises(ConstraintNotSatisfied, choice._validate, 4)
def test__validate_string(self):
from zope.schema._compat import u
from zope.schema.interfaces import ConstraintNotSatisfied
choice = self._makeOne(values=['a', 'c'])
choice._validate('a') # doesn't raise
choice._validate('c') # doesn't raise
choice._validate(u('c')) # doesn't raise
self.assertRaises(ConstraintNotSatisfied, choice._validate, 'd')
def test__validate_tuple(self):
from zope.schema.interfaces import ConstraintNotSatisfied
choice = self._makeOne(values=[(1, 2), (5, 6)])
choice._validate((1, 2)) # doesn't raise
choice._validate((5, 6)) # doesn't raise
self.assertRaises(ConstraintNotSatisfied, choice._validate, [5, 6])
self.assertRaises(ConstraintNotSatisfied, choice._validate, ())
def test__validate_mixed(self):
from zope.schema.interfaces import ConstraintNotSatisfied
choice = self._makeOne(values=[1, 'b', (0.2,)])
choice._validate(1) # doesn't raise
choice._validate('b') # doesn't raise
choice._validate((0.2,)) # doesn't raise
self.assertRaises(ConstraintNotSatisfied, choice._validate, '1')
self.assertRaises(ConstraintNotSatisfied, choice._validate, 0.2)
def test__validate_w_named_vocabulary_invalid(self):
choose = self._makeOne(vocabulary='vocab')
self.assertRaises(ValueError, choose._validate, 42)
def test__validate_w_named_vocabulary(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.vocabulary import setVocabularyRegistry
v = _makeSampleVocabulary()
setVocabularyRegistry(_makeDummyRegistry(v))
choose = self._makeOne(vocabulary='vocab')
choose._validate(1)
choose._validate(3)
self.assertRaises(ConstraintNotSatisfied, choose._validate, 42)
def test__validate_source_is_ICSB_unbound(self):
from zope.interface import implementer
from zope.schema.interfaces import IContextSourceBinder
@implementer(IContextSourceBinder)
class SampleContextSourceBinder(object):
def __call__(self, context):
pass
choice = self._makeOne(source=SampleContextSourceBinder())
self.assertRaises(TypeError, choice.validate, 1)
def test__validate_source_is_ICSB_bound(self):
from zope.interface import implementer
from zope.schema.interfaces import IContextSourceBinder
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.tests.test_vocabulary import _makeSampleVocabulary
@implementer(IContextSourceBinder)
class SampleContextSourceBinder(object):
def __call__(self, context):
return _makeSampleVocabulary()
s = SampleContextSourceBinder()
choice = self._makeOne(source=s)
# raises not iterable with unbound field
self.assertRaises(TypeError, choice.validate, 1)
o = object()
clone = choice.bind(o)
clone._validate(1)
clone._validate(3)
self.assertRaises(ConstraintNotSatisfied, clone._validate, 42)
class URITests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import URI
return URI
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IURI(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IURI
verifyClass(IURI, self._getTargetClass())
def test_instance_conforms_to_IURI(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IURI
verifyObject(IURI, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import non_native_string
field = self._makeOne()
self.assertRaises(WrongType, field.validate, non_native_string(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate('http://example.com/')
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate('http://example.com/')
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_not_a_uri(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.interfaces import InvalidURI
field = self._makeOne()
self.assertRaises(InvalidURI, field.validate, '')
self.assertRaises(InvalidURI, field.validate, 'abc')
self.assertRaises(InvalidURI, field.validate, '\xab\xde')
self.assertRaises(ConstraintNotSatisfied,
field.validate, 'http://example.com/\nDAV:')
def test_fromUnicode_ok(self):
from zope.schema._compat import u
field = self._makeOne()
self.assertEqual(field.fromUnicode(u('http://example.com/')),
'http://example.com/')
def test_fromUnicode_invalid(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.interfaces import InvalidURI
from zope.schema._compat import u
field = self._makeOne()
self.assertRaises(InvalidURI, field.fromUnicode, u(''))
self.assertRaises(InvalidURI, field.fromUnicode, u('abc'))
self.assertRaises(ConstraintNotSatisfied,
field.fromUnicode, u('http://example.com/\nDAV:'))
class DottedNameTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import DottedName
return DottedName
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IDottedName(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IDottedName
verifyClass(IDottedName, self._getTargetClass())
def test_instance_conforms_to_IDottedName(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IDottedName
verifyObject(IDottedName, self._makeOne())
def test_ctor_defaults(self):
dotted = self._makeOne()
self.assertEqual(dotted.min_dots, 0)
self.assertEqual(dotted.max_dots, None)
def test_ctor_min_dots_invalid(self):
self.assertRaises(ValueError, self._makeOne, min_dots=-1)
def test_ctor_min_dots_valid(self):
dotted = self._makeOne(min_dots=1)
self.assertEqual(dotted.min_dots, 1)
def test_ctor_max_dots_invalid(self):
self.assertRaises(ValueError, self._makeOne, min_dots=2, max_dots=1)
def test_ctor_max_dots_valid(self):
dotted = self._makeOne(max_dots=2)
self.assertEqual(dotted.max_dots, 2)
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import non_native_string
field = self._makeOne()
self.assertRaises(WrongType, field.validate, non_native_string(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate('name')
field.validate('dotted.name')
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate('name')
field.validate('dotted.name')
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_w_min_dots(self):
from zope.schema.interfaces import InvalidDottedName
field = self._makeOne(min_dots=1)
self.assertRaises(InvalidDottedName, field.validate, 'name')
field.validate('dotted.name')
field.validate('moar.dotted.name')
def test_validate_w_max_dots(self):
from zope.schema.interfaces import InvalidDottedName
field = self._makeOne(max_dots=1)
field.validate('name')
field.validate('dotted.name')
self.assertRaises(InvalidDottedName,
field.validate, 'moar.dotted.name')
def test_validate_not_a_dotted_name(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.interfaces import InvalidDottedName
field = self._makeOne()
self.assertRaises(InvalidDottedName, field.validate, '')
self.assertRaises(InvalidDottedName, field.validate, '\xab\xde')
self.assertRaises(ConstraintNotSatisfied,
field.validate, 'http://example.com/\nDAV:')
def test_fromUnicode_dotted_name_ok(self):
from zope.schema._compat import u
field = self._makeOne()
self.assertEqual(field.fromUnicode(u('dotted.name')), 'dotted.name')
def test_fromUnicode_invalid(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.interfaces import InvalidDottedName
from zope.schema._compat import u
field = self._makeOne()
self.assertRaises(InvalidDottedName, field.fromUnicode, u(''))
self.assertRaises(ConstraintNotSatisfied,
field.fromUnicode, u('http://example.com/\nDAV:'))
class IdTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Id
return Id
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IId(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IId
verifyClass(IId, self._getTargetClass())
def test_instance_conforms_to_IId(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IId
verifyObject(IId, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import non_native_string
field = self._makeOne()
self.assertRaises(WrongType, field.validate, non_native_string(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate('http://example.com/')
field.validate('dotted.name')
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate('http://example.com/')
field.validate('dotted.name')
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_not_a_uri(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.interfaces import InvalidId
field = self._makeOne()
self.assertRaises(InvalidId, field.validate, '')
self.assertRaises(InvalidId, field.validate, 'abc')
self.assertRaises(InvalidId, field.validate, '\xab\xde')
self.assertRaises(ConstraintNotSatisfied,
field.validate, 'http://example.com/\nDAV:')
def test_fromUnicode_url_ok(self):
from zope.schema._compat import u
field = self._makeOne()
self.assertEqual(field.fromUnicode(u('http://example.com/')),
'http://example.com/')
def test_fromUnicode_dotted_name_ok(self):
from zope.schema._compat import u
field = self._makeOne()
self.assertEqual(field.fromUnicode(u('dotted.name')), 'dotted.name')
def test_fromUnicode_invalid(self):
from zope.schema.interfaces import ConstraintNotSatisfied
from zope.schema.interfaces import InvalidId
from zope.schema._compat import u
field = self._makeOne()
self.assertRaises(InvalidId, field.fromUnicode, u(''))
self.assertRaises(InvalidId, field.fromUnicode, u('abc'))
self.assertRaises(ConstraintNotSatisfied,
field.fromUnicode, u('http://example.com/\nDAV:'))
class InterfaceFieldTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import InterfaceField
return InterfaceField
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IInterfaceField(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IInterfaceField
verifyClass(IInterfaceField, self._getTargetClass())
def test_instance_conforms_to_IInterfaceField(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IInterfaceField
verifyObject(IInterfaceField, self._makeOne())
def test_validate_wrong_types(self):
from datetime import date
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
self.assertRaises(WrongType, field.validate, date.today())
def test_validate_not_required(self):
from zope.interface import Interface
class DummyInterface(Interface):
pass
field = self._makeOne(required=False)
field.validate(DummyInterface)
field.validate(None)
def test_validate_required(self):
from zope.interface import Interface
from zope.schema.interfaces import RequiredMissing
class DummyInterface(Interface):
pass
field = self._makeOne(required=True)
field.validate(DummyInterface)
self.assertRaises(RequiredMissing, field.validate, None)
class AbstractCollectionTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import AbstractCollection
return AbstractCollection
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_ctor_defaults(self):
absc = self._makeOne()
self.assertEqual(absc.value_type, None)
self.assertEqual(absc.unique, False)
def test_ctor_explicit(self):
from zope.schema._bootstrapfields import Text
text = Text()
absc = self._makeOne(text, True)
self.assertEqual(absc.value_type, text)
self.assertEqual(absc.unique, True)
def test_ctor_w_non_field_value_type(self):
class NotAField(object):
pass
self.assertRaises(ValueError, self._makeOne, NotAField)
def test_bind_wo_value_Type(self):
absc = self._makeOne()
context = object()
bound = absc.bind(context)
self.assertEqual(bound.context, context)
self.assertEqual(bound.value_type, None)
self.assertEqual(bound.unique, False)
def test_bind_w_value_Type(self):
from zope.schema._bootstrapfields import Text
text = Text()
absc = self._makeOne(text, True)
context = object()
bound = absc.bind(context)
self.assertEqual(bound.context, context)
self.assertEqual(isinstance(bound.value_type, Text), True)
self.assertEqual(bound.value_type.context, context)
self.assertEqual(bound.unique, True)
def test__validate_wrong_contained_type(self):
from zope.schema.interfaces import WrongContainedType
from zope.schema._bootstrapfields import Text
text = Text()
absc = self._makeOne(text)
self.assertRaises(WrongContainedType, absc.validate, [1])
def test__validate_miss_uniqueness(self):
from zope.schema.interfaces import NotUnique
from zope.schema._bootstrapfields import Text
from zope.schema._compat import u
text = Text()
absc = self._makeOne(text, True)
self.assertRaises(NotUnique, absc.validate, [u('a'), u('a')])
class TupleTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Tuple
return Tuple
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_ITuple(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import ITuple
verifyClass(ITuple, self._getTargetClass())
def test_instance_conforms_to_ITuple(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import ITuple
verifyObject(ITuple, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate(())
field.validate((1, 2))
field.validate((3,))
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(())
field.validate((1, 2))
field.validate((3,))
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min_length(self):
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=2)
field.validate((1, 2))
field.validate((1, 2, 3))
self.assertRaises(TooShort, field.validate, ())
self.assertRaises(TooShort, field.validate, (1,))
def test_validate_max_length(self):
from zope.schema.interfaces import TooLong
field = self._makeOne(max_length=2)
field.validate(())
field.validate((1, 2))
self.assertRaises(TooLong, field.validate, (1, 2, 3, 4))
self.assertRaises(TooLong, field.validate, (1, 2, 3))
def test_validate_min_length_and_max_length(self):
from zope.schema.interfaces import TooLong
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=1, max_length=2)
field.validate((1, ))
field.validate((1, 2))
self.assertRaises(TooShort, field.validate, ())
self.assertRaises(TooLong, field.validate, (1, 2, 3))
class ListTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import List
return List
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IList(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IList
verifyClass(IList, self._getTargetClass())
def test_instance_conforms_to_IList(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IList
verifyObject(IList, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate([])
field.validate([1, 2])
field.validate([3])
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate([])
field.validate([1, 2])
field.validate([3])
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min_length(self):
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=2)
field.validate([1, 2])
field.validate([1, 2, 3])
self.assertRaises(TooShort, field.validate, [])
self.assertRaises(TooShort, field.validate, [1, ])
def test_validate_max_length(self):
from zope.schema.interfaces import TooLong
field = self._makeOne(max_length=2)
field.validate([])
field.validate([1])
field.validate([1, 2])
self.assertRaises(TooLong, field.validate, [1, 2, 3, 4])
self.assertRaises(TooLong, field.validate, [1, 2, 3])
def test_validate_min_length_and_max_length(self):
from zope.schema.interfaces import TooLong
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=1, max_length=2)
field.validate([1])
field.validate([1, 2])
self.assertRaises(TooShort, field.validate, [])
self.assertRaises(TooLong, field.validate, [1, 2, 3])
class SetTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Set
return Set
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_ISet(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import ISet
verifyClass(ISet, self._getTargetClass())
def test_instance_conforms_to_ISet(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import ISet
verifyObject(ISet, self._makeOne())
def test_ctor_disallows_unique(self):
self.assertRaises(TypeError, self._makeOne, unique=False)
self.assertRaises(TypeError, self._makeOne, unique=True)
self.assertTrue(self._makeOne().unique)
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate(set())
field.validate(set((1, 2)))
field.validate(set((3,)))
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(set())
field.validate(set((1, 2)))
field.validate(set((3,)))
field.validate(set())
field.validate(set((1, 2)))
field.validate(set((3,)))
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min_length(self):
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=2)
field.validate(set((1, 2)))
field.validate(set((1, 2, 3)))
self.assertRaises(TooShort, field.validate, set())
self.assertRaises(TooShort, field.validate, set((1,)))
def test_validate_max_length(self):
from zope.schema.interfaces import TooLong
field = self._makeOne(max_length=2)
field.validate(set())
field.validate(set((1,)))
field.validate(set((1, 2)))
self.assertRaises(TooLong, field.validate, set((1, 2, 3, 4)))
self.assertRaises(TooLong, field.validate, set((1, 2, 3)))
def test_validate_min_length_and_max_length(self):
from zope.schema.interfaces import TooLong
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=1, max_length=2)
field.validate(set((1,)))
field.validate(set((1, 2)))
self.assertRaises(TooShort, field.validate, set())
self.assertRaises(TooLong, field.validate, set((1, 2, 3)))
class FrozenSetTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import FrozenSet
return FrozenSet
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IFrozenSet(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IFrozenSet
verifyClass(IFrozenSet, self._getTargetClass())
def test_instance_conforms_to_IFrozenSet(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IFrozenSet
verifyObject(IFrozenSet, self._makeOne())
def test_ctor_disallows_unique(self):
self.assertRaises(TypeError, self._makeOne, unique=False)
self.assertRaises(TypeError, self._makeOne, unique=True)
self.assertTrue(self._makeOne().unique)
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate(frozenset())
field.validate(frozenset((1, 2)))
field.validate(frozenset((3,)))
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(frozenset())
field.validate(frozenset((1, 2)))
field.validate(frozenset((3,)))
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min_length(self):
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=2)
field.validate(frozenset((1, 2)))
field.validate(frozenset((1, 2, 3)))
self.assertRaises(TooShort, field.validate, frozenset())
self.assertRaises(TooShort, field.validate, frozenset((1,)))
def test_validate_max_length(self):
from zope.schema.interfaces import TooLong
field = self._makeOne(max_length=2)
field.validate(frozenset())
field.validate(frozenset((1,)))
field.validate(frozenset((1, 2)))
self.assertRaises(TooLong, field.validate, frozenset((1, 2, 3, 4)))
self.assertRaises(TooLong, field.validate, frozenset((1, 2, 3)))
def test_validate_min_length_and_max_length(self):
from zope.schema.interfaces import TooLong
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=1, max_length=2)
field.validate(frozenset((1,)))
field.validate(frozenset((1, 2)))
self.assertRaises(TooShort, field.validate, frozenset())
self.assertRaises(TooLong, field.validate, frozenset((1, 2, 3)))
class ObjectTests(unittest.TestCase):
def setUp(self):
from zope.event import subscribers
self._before = subscribers[:]
def tearDown(self):
from zope.event import subscribers
subscribers[:] = self._before
def _getTargetClass(self):
from zope.schema._field import Object
return Object
def _makeOne(self, schema=None, *args, **kw):
if schema is None:
schema = self._makeSchema()
return self._getTargetClass()(schema, *args, **kw)
def _makeSchema(self, **kw):
from zope.interface import Interface
from zope.interface.interface import InterfaceClass
return InterfaceClass('ISchema', (Interface,), kw)
def _getErrors(self, f, *args, **kw):
from zope.schema.interfaces import WrongContainedType
try:
f(*args, **kw)
except WrongContainedType as e:
try:
return e.args[0]
except:
return []
self.fail('Expected WrongContainedType Error')
def _makeCycles(self):
from zope.interface import Interface
from zope.interface import implementer
from zope.schema import Object
from zope.schema import List
from zope.schema._messageid import _
class IUnit(Interface):
"""A schema that participate to a cycle"""
boss = Object(
schema=Interface,
title=_("Boss"),
description=_("Boss description"),
required=False,
)
members = List(
value_type=Object(schema=Interface),
title=_("Member List"),
description=_("Member list description"),
required=False,
)
class IPerson(Interface):
"""A schema that participate to a cycle"""
unit = Object(
schema=IUnit,
title=_("Unit"),
description=_("Unit description"),
required=False,
)
IUnit['boss'].schema = IPerson
IUnit['members'].value_type.schema = IPerson
@implementer(IUnit)
class Unit(object):
def __init__(self, person, person_list):
self.boss = person
self.members = person_list
@implementer(IPerson)
class Person(object):
def __init__(self, unit):
self.unit = unit
return IUnit, Person, Unit
def test_class_conforms_to_IObject(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IObject
verifyClass(IObject, self._getTargetClass())
def test_instance_conforms_to_IObject(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IObject
verifyObject(IObject, self._makeOne())
def test_ctor_w_bad_schema(self):
from zope.schema.interfaces import WrongType
self.assertRaises(WrongType, self._makeOne, object())
def test_validate_not_required(self):
schema = self._makeSchema()
objf = self._makeOne(schema, required=False)
objf.validate(None) # doesn't raise
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne(required=True)
self.assertRaises(RequiredMissing, field.validate, None)
def test__validate_w_empty_schema(self):
from zope.interface import Interface
objf = self._makeOne(Interface)
objf.validate(object()) # doesn't raise
def test__validate_w_value_not_providing_schema(self):
from zope.schema.interfaces import SchemaNotProvided
from zope.schema._bootstrapfields import Text
schema = self._makeSchema(foo=Text(), bar=Text())
objf = self._makeOne(schema)
self.assertRaises(SchemaNotProvided, objf.validate, object())
def test__validate_w_value_providing_schema_but_missing_fields(self):
from zope.interface import implementer
from zope.schema.interfaces import SchemaNotFullyImplemented
from zope.schema.interfaces import WrongContainedType
from zope.schema._bootstrapfields import Text
schema = self._makeSchema(foo=Text(), bar=Text())
@implementer(schema)
class Broken(object):
pass
objf = self._makeOne(schema)
self.assertRaises(WrongContainedType, objf.validate, Broken())
errors = self._getErrors(objf.validate, Broken())
self.assertEqual(len(errors), 2)
errors = sorted(errors,
key=lambda x: (type(x).__name__, str(x.args[0])))
err = errors[0]
self.assertTrue(isinstance(err, SchemaNotFullyImplemented))
nested = err.args[0]
self.assertTrue(isinstance(nested, AttributeError))
self.assertTrue("'bar'" in str(nested))
err = errors[1]
self.assertTrue(isinstance(err, SchemaNotFullyImplemented))
nested = err.args[0]
self.assertTrue(isinstance(nested, AttributeError))
self.assertTrue("'foo'" in str(nested))
def test__validate_w_value_providing_schema_but_invalid_fields(self):
from zope.interface import implementer
from zope.schema.interfaces import WrongContainedType
from zope.schema.interfaces import RequiredMissing
from zope.schema.interfaces import WrongType
from zope.schema._bootstrapfields import Text
from zope.schema._compat import text_type
schema = self._makeSchema(foo=Text(), bar=Text())
@implementer(schema)
class Broken(object):
foo = None
bar = 1
objf = self._makeOne(schema)
self.assertRaises(WrongContainedType, objf.validate, Broken())
errors = self._getErrors(objf.validate, Broken())
self.assertEqual(len(errors), 2)
errors = sorted(errors, key=lambda x: type(x).__name__)
err = errors[0]
self.assertTrue(isinstance(err, RequiredMissing))
self.assertEqual(err.args, ('foo',))
err = errors[1]
self.assertTrue(isinstance(err, WrongType))
self.assertEqual(err.args, (1, text_type, 'bar'))
def test__validate_w_value_providing_schema(self):
from zope.interface import implementer
from zope.schema._bootstrapfields import Text
from zope.schema._field import Choice
from zope.schema._compat import u
schema = self._makeSchema(
foo=Text(),
bar=Text(),
baz=Choice(values=[1, 2, 3]),
)
@implementer(schema)
class OK(object):
foo = u('Foo')
bar = u('Bar')
baz = 2
objf = self._makeOne(schema)
objf.validate(OK()) # doesn't raise
def test_validate_w_cycles(self):
IUnit, Person, Unit = self._makeCycles()
field = self._makeOne(schema=IUnit)
person1 = Person(None)
person2 = Person(None)
unit = Unit(person1, [person1, person2])
person1.unit = unit
person2.unit = unit
field.validate(unit) # doesn't raise
def test_validate_w_cycles_object_not_valid(self):
from zope.schema.interfaces import WrongContainedType
IUnit, Person, Unit = self._makeCycles()
field = self._makeOne(schema=IUnit)
person1 = Person(None)
person2 = Person(None)
person3 = Person(DummyInstance())
unit = Unit(person3, [person1, person2])
person1.unit = unit
person2.unit = unit
self.assertRaises(WrongContainedType, field.validate, unit)
def test_validate_w_cycles_collection_not_valid(self):
from zope.schema.interfaces import WrongContainedType
IUnit, Person, Unit = self._makeCycles()
field = self._makeOne(schema=IUnit)
person1 = Person(None)
person2 = Person(None)
person3 = Person(DummyInstance())
unit = Unit(person1, [person2, person3])
person1.unit = unit
person2.unit = unit
self.assertRaises(WrongContainedType, field.validate, unit)
def test_set_emits_IBOAE(self):
from zope.event import subscribers
from zope.interface import implementer
from zope.schema.interfaces import IBeforeObjectAssignedEvent
from zope.schema._bootstrapfields import Text
from zope.schema._field import Choice
from zope.schema._compat import u
schema = self._makeSchema(
foo=Text(),
bar=Text(),
baz=Choice(values=[1, 2, 3]),
)
@implementer(schema)
class OK(object):
foo = u('Foo')
bar = u('Bar')
baz = 2
log = []
subscribers.append(log.append)
objf = self._makeOne(schema, __name__='field')
inst = DummyInstance()
value = OK()
objf.set(inst, value)
self.assertEqual(inst.field is value, True)
self.assertEqual(len(log), 5)
self.assertEqual(IBeforeObjectAssignedEvent.providedBy(log[-1]), True)
self.assertEqual(log[-1].object, value)
self.assertEqual(log[-1].name, 'field')
self.assertEqual(log[-1].context, inst)
def test_set_allows_IBOAE_subscr_to_replace_value(self):
from zope.event import subscribers
from zope.interface import implementer
from zope.schema._bootstrapfields import Text
from zope.schema._field import Choice
from zope.schema._compat import u
schema = self._makeSchema(
foo=Text(),
bar=Text(),
baz=Choice(values=[1, 2, 3]),
)
@implementer(schema)
class OK(object):
def __init__(self, foo=u('Foo'), bar=u('Bar'), baz=2):
self.foo = foo
self.bar = bar
self.baz = baz
ok1 = OK()
ok2 = OK(u('Foo2'), u('Bar2'), 3)
log = []
subscribers.append(log.append)
def _replace(event):
event.object = ok2
subscribers.append(_replace)
objf = self._makeOne(schema, __name__='field')
inst = DummyInstance()
self.assertEqual(len(log), 4)
objf.set(inst, ok1)
self.assertEqual(inst.field is ok2, True)
self.assertEqual(len(log), 5)
self.assertEqual(log[-1].object, ok2)
self.assertEqual(log[-1].name, 'field')
self.assertEqual(log[-1].context, inst)
class DictTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import Dict
return Dict
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IDict(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IDict
verifyClass(IDict, self._getTargetClass())
def test_instance_conforms_to_IDict(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IDict
verifyObject(IDict, self._makeOne())
def test_ctor_key_type_not_IField(self):
self.assertRaises(ValueError, self._makeOne, key_type=object())
def test_ctor_value_type_not_IField(self):
self.assertRaises(ValueError, self._makeOne, value_type=object())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, u(''))
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate({})
field.validate({1: 'b', 2: 'd'})
field.validate({3: 'a'})
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate({})
field.validate({1: 'b', 2: 'd'})
field.validate({3: 'a'})
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_invalid_key_type(self):
from zope.schema.interfaces import WrongContainedType
from zope.schema._bootstrapfields import Int
field = self._makeOne(key_type=Int())
field.validate({})
field.validate({1: 'b', 2: 'd'})
field.validate({3: 'a'})
self.assertRaises(WrongContainedType, field.validate, {'a': 1})
def test_validate_invalid_value_type(self):
from zope.schema.interfaces import WrongContainedType
from zope.schema._bootstrapfields import Int
field = self._makeOne(value_type=Int())
field.validate({})
field.validate({'b': 1, 'd': 2})
field.validate({'a': 3})
self.assertRaises(WrongContainedType, field.validate, {1: 'a'})
def test_validate_min_length(self):
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=1)
field.validate({1: 'a'})
field.validate({1: 'a', 2: 'b'})
self.assertRaises(TooShort, field.validate, {})
def test_validate_max_length(self):
from zope.schema.interfaces import TooLong
field = self._makeOne(max_length=1)
field.validate({})
field.validate({1: 'a'})
self.assertRaises(TooLong, field.validate, {1: 'a', 2: 'b'})
self.assertRaises(TooLong, field.validate, {1: 'a', 2: 'b', 3: 'c'})
def test_validate_min_length_and_max_length(self):
from zope.schema.interfaces import TooLong
from zope.schema.interfaces import TooShort
field = self._makeOne(min_length=1, max_length=2)
field.validate({1: 'a'})
field.validate({1: 'a', 2: 'b'})
self.assertRaises(TooShort, field.validate, {})
self.assertRaises(TooLong, field.validate, {1: 'a', 2: 'b', 3: 'c'})
def test_bind_binds_key_and_value_types(self):
from zope.schema import Int
field = self._makeOne(key_type=Int(), value_type=Int())
context = DummyInstance()
field2 = field.bind(context)
self.assertEqual(field2.key_type.context, context)
self.assertEqual(field2.value_type.context, context)
class DummyInstance(object):
pass
def _makeSampleVocabulary():
from zope.interface import implementer
from zope.schema.interfaces import IVocabulary
class SampleTerm(object):
pass
@implementer(IVocabulary)
class SampleVocabulary(object):
def __iter__(self):
return iter([self.getTerm(x) for x in range(0, 10)])
def __contains__(self, value):
return 0 <= value < 10
def __len__(self):
return 10
def getTerm(self, value):
if value in self:
t = SampleTerm()
t.value = value
t.double = 2 * value
return t
raise LookupError("no such value: %r" % value)
return SampleVocabulary()
def _makeDummyRegistry(v):
from zope.schema.vocabulary import VocabularyRegistry
class DummyRegistry(VocabularyRegistry):
def __init__(self, vocabulary):
self._vocabulary = vocabulary
def get(self, object, name):
return self._vocabulary
return DummyRegistry(v)
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(BytesTests),
unittest.makeSuite(ASCIITests),
unittest.makeSuite(BytesLineTests),
unittest.makeSuite(ASCIILineTests),
unittest.makeSuite(FloatTests),
unittest.makeSuite(DecimalTests),
unittest.makeSuite(DatetimeTests),
unittest.makeSuite(DateTests),
unittest.makeSuite(TimedeltaTests),
unittest.makeSuite(TimeTests),
unittest.makeSuite(ChoiceTests),
unittest.makeSuite(InterfaceFieldTests),
unittest.makeSuite(AbstractCollectionTests),
unittest.makeSuite(TupleTests),
unittest.makeSuite(ListTests),
unittest.makeSuite(SetTests),
unittest.makeSuite(FrozenSetTests),
unittest.makeSuite(ObjectTests),
unittest.makeSuite(DictTests),
unittest.makeSuite(URITests),
unittest.makeSuite(IdTests),
unittest.makeSuite(DottedNameTests),
))
zope.schema-4.4.2/src/zope/schema/tests/test_vocabulary.py 0000664 0001750 0001750 00000054752 12265302416 025047 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2003 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Test of the Vocabulary and related support APIs.
"""
import unittest
class SimpleTermTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema.vocabulary import SimpleTerm
return SimpleTerm
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_ITokenizedTerm(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import ITokenizedTerm
verifyClass(ITokenizedTerm, self._getTargetClass())
def test_instance_conforms_to_ITokenizedTerm(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import ITokenizedTerm
verifyObject(ITokenizedTerm, self._makeOne('VALUE'))
def test_ctor_defaults(self):
from zope.schema.interfaces import ITitledTokenizedTerm
term = self._makeOne('VALUE')
self.assertEqual(term.value, 'VALUE')
self.assertEqual(term.token, 'VALUE')
self.assertEqual(term.title, None)
self.assertFalse(ITitledTokenizedTerm.providedBy(term))
def test_ctor_explicit(self):
from zope.schema.interfaces import ITitledTokenizedTerm
term = self._makeOne('TERM', 'TOKEN', 'TITLE')
self.assertEqual(term.value, 'TERM')
self.assertEqual(term.token, 'TOKEN')
self.assertEqual(term.title, 'TITLE')
self.assertTrue(ITitledTokenizedTerm.providedBy(term))
def test_bytes_value(self):
from zope.schema.interfaces import ITitledTokenizedTerm
term = self._makeOne(b'term')
self.assertEqual(term.value, b'term')
self.assertEqual(term.token, 'term')
self.assertFalse(ITitledTokenizedTerm.providedBy(term))
class SimpleVocabularyTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema.vocabulary import SimpleVocabulary
return SimpleVocabulary
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_IVocabularyTokenized(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import IVocabularyTokenized
verifyClass(IVocabularyTokenized, self._getTargetClass())
def test_instance_conforms_to_IVocabularyTokenized(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IVocabularyTokenized
verifyObject(IVocabularyTokenized, self._makeOne(()))
def test_ctor_additional_interfaces(self):
from zope.interface import Interface
from zope.schema.vocabulary import SimpleTerm
class IStupid(Interface):
pass
VALUES = [1, 4, 2, 9]
vocabulary = self._makeOne([SimpleTerm(x) for x in VALUES], IStupid)
self.assertTrue(IStupid.providedBy(vocabulary))
self.assertEqual(len(vocabulary), len(VALUES))
for value, term in zip(VALUES, vocabulary):
self.assertEqual(term.value, value)
for value in VALUES:
self.assertTrue(value in vocabulary)
self.assertFalse('ABC' in vocabulary)
for term in vocabulary:
self.assertTrue(vocabulary.getTerm(term.value) is term)
self.assertTrue(vocabulary.getTermByToken(term.token) is term)
def test_fromValues(self):
from zope.interface import Interface
from zope.schema.interfaces import ITokenizedTerm
class IStupid(Interface):
pass
VALUES = [1, 4, 2, 9]
vocabulary = self._getTargetClass().fromValues(VALUES)
self.assertEqual(len(vocabulary), len(VALUES))
for value, term in zip(VALUES, vocabulary):
self.assertTrue(ITokenizedTerm.providedBy(term))
self.assertEqual(term.value, value)
for value in VALUES:
self.assertTrue(value in vocabulary)
def test_fromItems(self):
from zope.interface import Interface
from zope.schema.interfaces import ITokenizedTerm
class IStupid(Interface):
pass
ITEMS = [('one', 1), ('two', 2), ('three', 3), ('fore!', 4)]
vocabulary = self._getTargetClass().fromItems(ITEMS)
self.assertEqual(len(vocabulary), len(ITEMS))
for item, term in zip(ITEMS, vocabulary):
self.assertTrue(ITokenizedTerm.providedBy(term))
self.assertEqual(term.token, item[0])
self.assertEqual(term.value, item[1])
for item in ITEMS:
self.assertTrue(item[1] in vocabulary)
def test_createTerm(self):
from zope.schema.vocabulary import SimpleTerm
VALUES = [1, 4, 2, 9]
for value in VALUES:
term = self._getTargetClass().createTerm(value)
self.assertTrue(isinstance(term, SimpleTerm))
self.assertEqual(term.value, value)
self.assertEqual(term.token, str(value))
def test_getTerm_miss(self):
vocabulary = self._makeOne(())
self.assertRaises(LookupError, vocabulary.getTerm, 'nonesuch')
def test_getTermByToken_miss(self):
vocabulary = self._makeOne(())
self.assertRaises(LookupError, vocabulary.getTermByToken, 'nonesuch')
def test_nonunique_tokens(self):
klass = self._getTargetClass()
self.assertRaises(ValueError, klass.fromValues, [2, '2'])
self.assertRaises(
ValueError,
klass.fromItems,
[(1, 'one'), ('1', 'another one')]
)
self.assertRaises(
ValueError,
klass.fromItems,
[(0, 'one'), (1, 'one')]
)
def test_nonunique_tokens_swallow(self):
klass = self._getTargetClass()
items = [(0, 'one'), (1, 'one')]
terms = [klass.createTerm(value, token) for (token, value) in items]
vocab = self._getTargetClass()(terms, swallow_duplicates=True)
self.assertEqual(vocab.getTerm('one').token, '1')
def test_nonunique_token_message(self):
try:
self._getTargetClass().fromValues([2, '2'])
except ValueError as e:
self.assertEqual(str(e), "term tokens must be unique: '2'")
def test_nonunique_token_messages(self):
try:
self._getTargetClass().fromItems([(0, 'one'), (1, 'one')])
except ValueError as e:
self.assertEqual(str(e), "term values must be unique: 'one'")
def test_overriding_createTerm(self):
class MyTerm(object):
def __init__(self, value):
self.value = value
self.token = repr(value)
self.nextvalue = value + 1
class MyVocabulary(self._getTargetClass()):
def createTerm(cls, value):
return MyTerm(value)
createTerm = classmethod(createTerm)
vocab = MyVocabulary.fromValues([1, 2, 3])
for term in vocab:
self.assertEqual(term.value + 1, term.nextvalue)
# Test _createTermTree via TreeVocabulary.fromDict
class TreeVocabularyTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema.vocabulary import TreeVocabulary
return TreeVocabulary
def tree_vocab_2(self):
region_tree = {
('regions', 'Regions'): {
('aut', 'Austria'): {
('tyr', 'Tyrol'): {
('auss', 'Ausserfern'): {},
}
},
('ger', 'Germany'): {
('bav', 'Bavaria'): {}
},
}
}
return self._getTargetClass().fromDict(region_tree)
def business_tree(self):
return {
('services', 'services', 'Services'): {
('reservations', 'reservations', 'Reservations'): {
('res_host', 'res_host', 'Res Host'): {},
('res_gui', 'res_gui', 'Res GUI'): {},
},
('check_in', 'check_in', 'Check-in'): {
('dcs_host', 'dcs_host', 'DCS Host'): {},
},
},
('infrastructure', 'infrastructure', 'Infrastructure'): {
('communication_network', 'communication_network',
'Communication/Network'): {
('messaging', 'messaging', 'Messaging'): {},
},
('data_transaction', 'data_transaction',
'Data/Transaction'): {
('database', 'database', 'Database'): {},
},
('security', 'security', 'Security'): {},
},
}
def tree_vocab_3(self):
return self._getTargetClass().fromDict(self.business_tree())
def test_implementation(self):
from zope.interface.verify import verifyObject
from zope.interface.common.mapping import IEnumerableMapping
from zope.schema.interfaces import ITreeVocabulary
from zope.schema.interfaces import IVocabulary
from zope.schema.interfaces import IVocabularyTokenized
for v in [self.tree_vocab_2(), self.tree_vocab_3()]:
self.assertTrue(verifyObject(IEnumerableMapping, v))
self.assertTrue(verifyObject(IVocabulary, v))
self.assertTrue(verifyObject(IVocabularyTokenized, v))
self.assertTrue(verifyObject(ITreeVocabulary, v))
def test_additional_interfaces(self):
from zope.interface import Interface
class IStupid(Interface):
pass
v = self._getTargetClass().fromDict({('one', '1'): {}}, IStupid)
self.assertTrue(IStupid.providedBy(v))
def test_ordering(self):
#The TreeVocabulary makes use of an OrderedDict to store it's
#internal tree representation.
#
#Check that they keys are indeed oredered.
from zope.schema._compat import OrderedDict
d = {
(1, 'new_york', 'New York'): {
(2, 'ny_albany', 'Albany'): {},
(3, 'ny_new_york', 'New York'): {},
},
(4, 'california', 'California'): {
(5, 'ca_los_angeles', 'Los Angeles'): {},
(6, 'ca_san_francisco', 'San Francisco'): {},
},
(7, 'texas', 'Texas'): {},
(8, 'florida', 'Florida'): {},
(9, 'utah', 'Utah'): {},
}
dict_ = OrderedDict(sorted(d.items(), key=lambda t: t[0]))
vocab = self._getTargetClass().fromDict(dict_)
# Test keys
self.assertEqual(
[k.token for k in vocab.keys()],
['1', '4', '7', '8', '9']
)
# Test __iter__
self.assertEqual(
[k.token for k in vocab],
['1', '4', '7', '8', '9']
)
self.assertEqual(
[k.token for k in vocab[[k for k in vocab.keys()][0]].keys()],
['2', '3']
)
self.assertEqual(
[k.token for k in vocab[[k for k in vocab.keys()][1]].keys()],
['5', '6']
)
def test_indexes(self):
# TreeVocabulary creates three indexes for quick lookups,
# term_by_value, term_by_value and path_by_value.
tv2 = self.tree_vocab_2()
self.assertEqual(
[k for k in sorted(tv2.term_by_value.keys())],
['Ausserfern', 'Austria', 'Bavaria', 'Germany', 'Regions', 'Tyrol']
)
self.assertEqual(
[k for k in sorted(tv2.term_by_token.keys())],
['auss', 'aut', 'bav', 'ger', 'regions', 'tyr']
)
self.assertEqual(
[k for k in sorted(tv2.path_by_value.keys())],
['Ausserfern', 'Austria', 'Bavaria', 'Germany', 'Regions', 'Tyrol']
)
self.assertEqual(
[k for k in sorted(tv2.path_by_value.values())],
[
['Regions'],
['Regions', 'Austria'],
['Regions', 'Austria', 'Tyrol'],
['Regions', 'Austria', 'Tyrol', 'Ausserfern'],
['Regions', 'Germany'],
['Regions', 'Germany', 'Bavaria'],
]
)
self.assertEqual(
[k for k in sorted(self.tree_vocab_3().term_by_value.keys())],
[
'check_in',
'communication_network',
'data_transaction',
'database',
'dcs_host',
'infrastructure',
'messaging',
'res_gui',
'res_host',
'reservations',
'security',
'services',
]
)
self.assertEqual(
[k for k in sorted(self.tree_vocab_3().term_by_token.keys())],
[
'check_in',
'communication_network',
'data_transaction',
'database',
'dcs_host',
'infrastructure',
'messaging',
'res_gui',
'res_host',
'reservations',
'security',
'services',
]
)
self.assertEqual(
[k for k in sorted(self.tree_vocab_3().path_by_value.values())],
[
['infrastructure'],
['infrastructure', 'communication_network'],
['infrastructure', 'communication_network', 'messaging'],
['infrastructure', 'data_transaction'],
['infrastructure', 'data_transaction', 'database'],
['infrastructure', 'security'],
['services'],
['services', 'check_in'],
['services', 'check_in', 'dcs_host'],
['services', 'reservations'],
['services', 'reservations', 'res_gui'],
['services', 'reservations', 'res_host'],
]
)
def test_termpath(self):
tv2 = self.tree_vocab_2()
tv3 = self.tree_vocab_3()
self.assertEqual(
tv2.getTermPath('Bavaria'),
['Regions', 'Germany', 'Bavaria']
)
self.assertEqual(
tv2.getTermPath('Austria'),
['Regions', 'Austria']
)
self.assertEqual(
tv2.getTermPath('Ausserfern'),
['Regions', 'Austria', 'Tyrol', 'Ausserfern']
)
self.assertEqual(
tv2.getTermPath('Non-existent'),
[]
)
self.assertEqual(
tv3.getTermPath('database'),
["infrastructure", "data_transaction", "database"]
)
def test_len(self):
# len returns the number of all nodes in the dict
self.assertEqual(len(self.tree_vocab_2()), 1)
self.assertEqual(len(self.tree_vocab_3()), 2)
def test_contains(self):
tv2 = self.tree_vocab_2()
self.assertTrue('Regions' in tv2 and
'Austria' in tv2 and
'Bavaria' in tv2)
self.assertTrue('bav' not in tv2)
self.assertTrue('foo' not in tv2)
self.assertTrue({} not in tv2) # not hashable
tv3 = self.tree_vocab_3()
self.assertTrue('database' in tv3 and
'security' in tv3 and
'services' in tv3)
self.assertTrue('Services' not in tv3)
self.assertTrue('Database' not in tv3)
self.assertTrue({} not in tv3) # not hashable
def test_values_and_items(self):
for v in (self.tree_vocab_2(), self.tree_vocab_3()):
for term in v:
self.assertEqual([i for i in v.values()],
[i for i in v._terms.values()])
self.assertEqual([i for i in v.items()],
[i for i in v._terms.items()])
def test_get(self):
for v in [self.tree_vocab_2(), self.tree_vocab_3()]:
for key, value in v.items():
self.assertEqual(v.get(key), value)
self.assertEqual(v[key], value)
def test_get_term(self):
for v in (self.tree_vocab_2(), self.tree_vocab_3()):
for term in v:
self.assertTrue(v.getTerm(term.value) is term)
self.assertTrue(v.getTermByToken(term.token) is term)
self.assertRaises(LookupError, v.getTerm, 'non-present-value')
self.assertRaises(LookupError,
v.getTermByToken, 'non-present-token')
def test_nonunique_values_and_tokens(self):
# Since we do term and value lookups, all terms' values and tokens
# must be unique. This rule applies recursively.
self.assertRaises(
ValueError, self._getTargetClass().fromDict,
{
('one', '1'): {},
('two', '1'): {},
})
self.assertRaises(
ValueError, self._getTargetClass().fromDict,
{
('one', '1'): {},
('one', '2'): {},
})
# Even nested tokens must be unique.
self.assertRaises(
ValueError, self._getTargetClass().fromDict,
{
('new_york', 'New York'): {
('albany', 'Albany'): {},
('new_york', 'New York'): {},
},
})
# The same applies to nested values.
self.assertRaises(
ValueError, self._getTargetClass().fromDict,
{
('1', 'new_york'): {
('2', 'albany'): {},
('3', 'new_york'): {},
},
})
# The title attribute does however not have to be unique.
self._getTargetClass().fromDict({
('1', 'new_york', 'New York'): {
('2', 'ny_albany', 'Albany'): {},
('3', 'ny_new_york', 'New York'): {},
},
})
self._getTargetClass().fromDict({
('one', '1', 'One'): {},
('two', '2', 'One'): {},
})
def test_nonunique_value_message(self):
try:
self._getTargetClass().fromDict({
('one', '1'): {},
('two', '1'): {},
})
except ValueError as e:
self.assertEqual(str(e), "Term values must be unique: '1'")
def test_nonunique_token_message(self):
try:
self._getTargetClass().fromDict({
('one', '1'): {},
('one', '2'): {},
})
except ValueError as e:
self.assertEqual(str(e), "Term tokens must be unique: 'one'")
def test_recursive_methods(self):
#Test the _createTermTree and _getPathToTreeNode methods
from zope.schema.vocabulary import _createTermTree
tree = _createTermTree({}, self.business_tree())
vocab = self._getTargetClass().fromDict(self.business_tree())
term_path = vocab._getPathToTreeNode(tree, "infrastructure")
vocab_path = vocab._getPathToTreeNode(vocab, "infrastructure")
self.assertEqual(term_path, vocab_path)
self.assertEqual(term_path, ["infrastructure"])
term_path = vocab._getPathToTreeNode(tree, "security")
vocab_path = vocab._getPathToTreeNode(vocab, "security")
self.assertEqual(term_path, vocab_path)
self.assertEqual(term_path, ["infrastructure", "security"])
term_path = vocab._getPathToTreeNode(tree, "database")
vocab_path = vocab._getPathToTreeNode(vocab, "database")
self.assertEqual(term_path, vocab_path)
self.assertEqual(term_path,
["infrastructure", "data_transaction", "database"])
term_path = vocab._getPathToTreeNode(tree, "dcs_host")
vocab_path = vocab._getPathToTreeNode(vocab, "dcs_host")
self.assertEqual(term_path, vocab_path)
self.assertEqual(term_path, ["services", "check_in", "dcs_host"])
term_path = vocab._getPathToTreeNode(tree, "dummy")
vocab_path = vocab._getPathToTreeNode(vocab, "dummy")
self.assertEqual(term_path, vocab_path)
self.assertEqual(term_path, [])
class RegistryTests(unittest.TestCase):
#Tests of the simple vocabulary and presentation registries.
def setUp(self):
from zope.schema.vocabulary import _clear
_clear()
def tearDown(self):
from zope.schema.vocabulary import _clear
_clear()
def test_setVocabularyRegistry(self):
from zope.schema.vocabulary import setVocabularyRegistry
from zope.schema.vocabulary import getVocabularyRegistry
r = _makeDummyRegistry()
setVocabularyRegistry(r)
self.assertTrue(getVocabularyRegistry() is r)
def test_getVocabularyRegistry(self):
from zope.schema.interfaces import IVocabularyRegistry
from zope.schema.vocabulary import getVocabularyRegistry
r = getVocabularyRegistry()
self.assertTrue(IVocabularyRegistry.providedBy(r))
# TODO: still need to test the default implementation
def _makeSampleVocabulary():
from zope.interface import implementer
from zope.schema.interfaces import IVocabulary
class SampleTerm(object):
pass
@implementer(IVocabulary)
class SampleVocabulary(object):
def __iter__(self):
return iter([self.getTerm(x) for x in range(0, 10)])
def __contains__(self, value):
return 0 <= value < 10
def __len__(self):
return 10
def getTerm(self, value):
if value in self:
t = SampleTerm()
t.value = value
t.double = 2 * value
return t
raise LookupError("no such value: %r" % value)
return SampleVocabulary()
def _makeDummyRegistry():
from zope.schema.vocabulary import VocabularyRegistry
class DummyRegistry(VocabularyRegistry):
def get(self, object, name):
v = _makeSampleVocabulary()
v.object = object
v.name = name
return v
return DummyRegistry()
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(SimpleTermTests),
unittest.makeSuite(SimpleVocabularyTests),
unittest.makeSuite(TreeVocabularyTests),
unittest.makeSuite(RegistryTests),
))
zope.schema-4.4.2/src/zope/schema/tests/test_states.py 0000664 0001750 0001750 00000007466 12265302416 024203 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2003 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Tests of the states example.
"""
import unittest
class StateSelectionTest(unittest.TestCase):
def setUp(self):
from zope.schema.vocabulary import _clear
from zope.schema.vocabulary import getVocabularyRegistry
from zope.schema.tests.states import StateVocabulary
_clear()
vr = getVocabularyRegistry()
vr.register("states", StateVocabulary)
def tearDown(self):
from zope.schema.vocabulary import _clear
_clear()
def _makeSchema(self):
from zope.schema._compat import u
from zope.interface import Interface
from zope.schema import Choice
from zope.schema.tests.states import StateVocabulary
class IBirthInfo(Interface):
state1 = Choice(
title=u('State of Birth'),
description=u('The state in which you were born.'),
vocabulary="states",
default="AL",
)
state2 = Choice(
title=u('State of Birth'),
description=u('The state in which you were born.'),
vocabulary="states",
default="AL",
)
state3 = Choice(
title=u('Favorite State'),
description=u('The state you like the most.'),
vocabulary=StateVocabulary(),
)
state4 = Choice(
title=u("Name"),
description=u("The name of your new state"),
vocabulary="states",
)
return IBirthInfo
def test_default_presentation(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IVocabulary
schema = self._makeSchema()
field = schema.getDescriptionFor("state1")
bound = field.bind(object())
self.assertTrue(verifyObject(IVocabulary, bound.vocabulary))
self.assertEqual(bound.vocabulary.getTerm("VA").title, "Virginia")
def test_contains(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IVocabulary
from zope.schema.tests.states import StateVocabulary
vocab = StateVocabulary()
self.assertTrue(verifyObject(IVocabulary, vocab))
count = 0
L = list(vocab)
for term in L:
count += 1
self.assertTrue(term.value in vocab)
self.assertEqual(count, len(vocab))
# make sure we get the same values the second time around:
L = [term.value for term in L]
L.sort()
L2 = [term.value for term in vocab]
L2.sort()
self.assertEqual(L, L2)
def test_prebound_vocabulary(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import IVocabulary
schema = self._makeSchema()
field = schema.getDescriptionFor("state3")
bound = field.bind(None)
self.assertTrue(bound.vocabularyName is None)
self.assertTrue(verifyObject(IVocabulary, bound.vocabulary))
self.assertTrue("AL" in bound.vocabulary)
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(StateSelectionTest),
))
zope.schema-4.4.2/src/zope/schema/tests/test_fieldproperty.py 0000664 0001750 0001750 00000050770 12312122016 025551 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Field Properties tests
"""
import unittest
class _Base(unittest.TestCase):
def _makeOne(self, field=None, name=None):
from zope.schema import Text
if field is None:
field = Text(__name__='testing')
if name is None:
return self._getTargetClass()(field)
return self._getTargetClass()(field, name)
class _Integration(object):
def _makeImplementer(self):
schema = _getSchema()
class _Implementer(object):
title = self._makeOne(schema['title'])
weight = self._makeOne(schema['weight'])
code = self._makeOne(schema['code'])
date = self._makeOne(schema['date'])
return _Implementer()
def test_basic(self):
from zope.schema._compat import b
from zope.schema._compat import u
from zope.schema.interfaces import ValidationError
c = self._makeImplementer()
self.assertEqual(c.title, u('say something'))
self.assertEqual(c.weight, None)
self.assertEqual(c.code, b('xxxxxx'))
self.assertRaises(ValidationError, setattr, c, 'title', b('foo'))
self.assertRaises(ValidationError, setattr, c, 'weight', b('foo'))
self.assertRaises(ValidationError, setattr, c, 'weight', -1.0)
self.assertRaises(ValidationError, setattr, c, 'weight', 2)
self.assertRaises(ValidationError, setattr, c, 'code', -1)
self.assertRaises(ValidationError, setattr, c, 'code', b('xxxx'))
self.assertRaises(ValidationError, setattr, c, 'code', u('xxxxxx'))
c.title = u('c is good')
c.weight = 10.0
c.code = b('abcdef')
self.assertEqual(c.title, u('c is good'))
self.assertEqual(c.weight, 10)
self.assertEqual(c.code, b('abcdef'))
def test_readonly(self):
c = self._makeImplementer()
# The date should be only settable once
c.date = 0.0
# Setting the value a second time should fail.
self.assertRaises(ValueError, setattr, c, 'date', 1.0)
class FieldPropertyTests(_Base, _Integration):
def _getTargetClass(self):
from zope.schema.fieldproperty import FieldProperty
return FieldProperty
def test_ctor_defaults(self):
from zope.schema import Text
field = Text(__name__='testing')
cname = self._getTargetClass().__name__
prop = self._makeOne(field)
self.assertTrue(getattr(prop, '_%s__field' % cname) is field)
self.assertEqual(getattr(prop, '_%s__name' % cname), 'testing')
self.assertEqual(prop.__name__, 'testing')
self.assertEqual(prop.description, field.description)
self.assertEqual(prop.default, field.default)
self.assertEqual(prop.readonly, field.readonly)
self.assertEqual(prop.required, field.required)
def test_ctor_explicit(self):
from zope.schema import Text
from zope.schema._compat import u
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
default=u('DEFAULT'),
readonly=True,
required=True,
)
cname = self._getTargetClass().__name__
prop = self._makeOne(field, name='override')
self.assertTrue(getattr(prop, '_%s__field' % cname) is field)
self.assertEqual(getattr(prop, '_%s__name' % cname), 'override')
self.assertEqual(prop.description, field.description)
self.assertEqual(prop.default, field.default)
self.assertEqual(prop.readonly, field.readonly)
self.assertEqual(prop.required, field.required)
def test_query_value_with_default(self):
from zope.schema import Text
from zope.schema._compat import u
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
default=u('DEFAULT'),
readonly=True,
required=True,
)
prop = self._makeOne(field=field)
class Foo(object):
testing = prop
foo = Foo()
self.assertEqual(prop.queryValue(foo, 'test'), u('DEFAULT'))
foo.testing = u('NO')
self.assertEqual(prop.queryValue(foo, 'test'), u('NO'))
def test_query_value_without_default(self):
from zope.schema import Text
from zope.schema._compat import u
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
readonly=True,
required=True,
)
prop = self._makeOne(field=field)
class Foo(object):
testing = prop
foo = Foo()
# field initialize its default to None if it hasn't any default
# it should be zope.schema.NO_VALUE as 'None' has another semantic
self.assertEqual(prop.queryValue(foo, 'test'), None)
def test___get___from_class(self):
prop = self._makeOne()
class Foo(object):
testing = prop
self.assertTrue(Foo.testing is prop)
def test___get___from_instance_pseudo_field_wo_default(self):
class _Faux(object):
def bind(self, other):
return self
prop = self._makeOne(_Faux(), 'nonesuch')
class Foo(object):
testing = prop
foo = Foo()
self.assertRaises(AttributeError, getattr, foo, 'testing')
def test___get___from_instance_miss_uses_field_default(self):
prop = self._makeOne()
class Foo(object):
testing = prop
foo = Foo()
self.assertEqual(foo.testing, None)
def test___get___from_instance_hit(self):
prop = self._makeOne(name='other')
class Foo(object):
testing = prop
foo = Foo()
foo.other = '123'
self.assertEqual(foo.testing, '123')
def test___get___from_instance_hit_after_bind(self):
class _Faux(object):
default = '456'
def bind(self, other):
return self
prop = self._makeOne(_Faux(), 'testing')
class Foo(object):
testing = prop
foo = Foo()
self.assertEqual(foo.testing, '456')
def test___set___not_readonly(self):
class _Faux(object):
readonly = False
default = '456'
def bind(self, other):
return self
faux = _Faux()
_validated = []
faux.validate = _validated.append
prop = self._makeOne(faux, 'testing')
class Foo(object):
testing = prop
foo = Foo()
foo.testing = '123'
self.assertEqual(foo.__dict__['testing'], '123')
def test___set___w_readonly_not_already_set(self):
class _Faux(object):
readonly = True
default = '456'
def bind(self, other):
return self
faux = _Faux()
_validated = []
faux.validate = _validated.append
prop = self._makeOne(faux, 'testing')
class Foo(object):
testing = prop
foo = Foo()
foo.testing = '123'
self.assertEqual(foo.__dict__['testing'], '123')
self.assertEqual(_validated, ['123'])
def test___set___w_readonly_and_already_set(self):
class _Faux(object):
readonly = True
default = '456'
def bind(self, other):
return self
faux = _Faux()
_validated = []
faux.validate = _validated.append
prop = self._makeOne(faux, 'testing')
class Foo(object):
testing = prop
foo = Foo()
foo.__dict__['testing'] = '789'
self.assertRaises(ValueError, setattr, foo, 'testing', '123')
self.assertEqual(_validated, ['123'])
def test_field_event(self):
from zope.schema import Text
from zope.schema._compat import u
from zope.event import subscribers
from zope.schema.fieldproperty import FieldUpdatedEvent
log = []
subscribers.append(log.append)
self.assertEqual(log, [])
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
default=u('DEFAULT'),
readonly=True,
required=True,
)
self.assertEqual(len(log), 6)
event = log[0]
self.assertTrue(isinstance(event, FieldUpdatedEvent))
self.assertEqual(event.inst, field)
self.assertEqual(event.old_value, 0)
self.assertEqual(event.new_value, 0)
self.assertEqual(
[ev.field.__name__ for ev in log],
['min_length', 'max_length', 'title', 'description', 'required', 'readonly'])
def test_field_event_update(self):
from zope.schema import Text
from zope.schema._compat import u
from zope.event import subscribers
from zope.schema.fieldproperty import FieldUpdatedEvent
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
default=u('DEFAULT'),
required=True,
)
prop = self._makeOne(field=field)
class Foo(object):
testing = prop
foo = Foo()
log = []
subscribers.append(log.append)
foo.testing = u('Bar')
foo.testing = u('Foo')
self.assertEqual(len(log), 2)
event = log[1]
self.assertTrue(isinstance(event, FieldUpdatedEvent))
self.assertEqual(event.inst, foo)
self.assertEqual(event.field, field)
self.assertEqual(event.old_value, u('Bar'))
self.assertEqual(event.new_value, u('Foo'))
class FieldPropertyStoredThroughFieldTests(_Base, _Integration):
def _getTargetClass(self):
from zope.schema.fieldproperty import FieldPropertyStoredThroughField
return FieldPropertyStoredThroughField
def test_ctor_defaults(self):
from zope.schema import Text
field = Text(__name__='testing')
cname = self._getTargetClass().__name__
prop = self._makeOne(field)
self.assertTrue(isinstance(prop.field, field.__class__))
self.assertFalse(prop.field is field)
self.assertEqual(prop.field.__name__, '__st_testing_st')
self.assertEqual(prop.__name__, '__st_testing_st')
self.assertEqual(getattr(prop, '_%s__name' % cname), 'testing')
self.assertEqual(prop.description, field.description)
self.assertEqual(prop.default, field.default)
self.assertEqual(prop.readonly, field.readonly)
self.assertEqual(prop.required, field.required)
def test_ctor_explicit(self):
from zope.schema import Text
from zope.schema._compat import u
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
default=u('DEFAULT'),
readonly=True,
required=True,
)
cname = self._getTargetClass().__name__
prop = self._makeOne(field, name='override')
self.assertTrue(isinstance(prop.field, field.__class__))
self.assertFalse(prop.field is field)
self.assertEqual(prop.field.__name__, '__st_testing_st')
self.assertEqual(prop.__name__, '__st_testing_st')
self.assertEqual(getattr(prop, '_%s__name' % cname), 'override')
self.assertEqual(prop.description, field.description)
self.assertEqual(prop.default, field.default)
self.assertEqual(prop.readonly, field.readonly)
self.assertEqual(prop.required, field.required)
def test_setValue(self):
from zope.schema import Text
class Foo(object):
pass
foo = Foo()
prop = self._makeOne()
field = Text(__name__='testing')
prop.setValue(foo, field, '123')
self.assertEqual(foo.testing, '123')
def test_getValue_miss(self):
from zope.schema import Text
from zope.schema.fieldproperty import _marker
class Foo(object):
pass
foo = Foo()
prop = self._makeOne()
field = Text(__name__='testing')
value = prop.getValue(foo, field)
self.assertTrue(value is _marker)
def test_getValue_hit(self):
from zope.schema import Text
class Foo(object):
pass
foo = Foo()
foo.testing = '123'
prop = self._makeOne()
field = Text(__name__='testing')
value = prop.getValue(foo, field)
self.assertEqual(value, '123')
def test_queryValue_miss(self):
from zope.schema import Text
class Foo(object):
pass
foo = Foo()
prop = self._makeOne()
field = Text(__name__='testing')
default = object()
value = prop.queryValue(foo, field, default)
self.assertTrue(value is default)
def test_queryValue_hit(self):
from zope.schema import Text
class Foo(object):
pass
foo = Foo()
foo.testing = '123'
prop = self._makeOne()
field = Text(__name__='testing')
default = object()
value = prop.queryValue(foo, field, default)
self.assertEqual(value, '123')
def test___get___from_class(self):
prop = self._makeOne()
class Foo(object):
testing = prop
self.assertTrue(Foo.testing is prop)
def test___get___from_instance_pseudo_field_wo_default(self):
class _Faux(object):
__name__ = 'Faux'
def bind(self, other):
return self
def query(self, inst, default):
return default
prop = self._makeOne(_Faux(), 'nonesuch')
class Foo(object):
testing = prop
foo = Foo()
self.assertRaises(AttributeError, getattr, foo, 'testing')
def test___get___from_instance_miss_uses_field_default(self):
prop = self._makeOne()
class Foo(object):
testing = prop
foo = Foo()
self.assertEqual(foo.testing, None)
def test___get___from_instance_hit(self):
from zope.schema import Text
field = Text(__name__='testing')
prop = self._makeOne(field, name='other')
class Foo(object):
testing = prop
foo = Foo()
foo.__dict__['__st_testing_st'] = '456'
foo.other = '123'
self.assertEqual(foo.testing, '456')
def test___set___not_readonly(self):
class _Faux(object):
__name__ = 'Faux'
readonly = False
default = '456'
def query(self, inst, default):
return default
def bind(self, other):
return self
def set(self, inst, value):
setattr(inst, 'faux', value)
faux = _Faux()
_validated = []
faux.validate = _validated.append
prop = self._makeOne(faux, 'testing')
class Foo(object):
testing = prop
foo = Foo()
foo.testing = '123'
self.assertEqual(foo.__dict__['faux'], '123')
self.assertEqual(_validated, ['123'])
def test___set___w_readonly_not_already_set(self):
class _Faux(object):
__name__ = 'Faux'
readonly = True
default = '456'
def bind(self, other):
return self
def query(self, inst, default):
return default
def set(self, inst, value):
if self.readonly:
raise ValueError
setattr(inst, 'faux', value)
faux = _Faux()
_validated = []
faux.validate = _validated.append
prop = self._makeOne(faux, 'testing')
class Foo(object):
testing = prop
foo = Foo()
foo.testing = '123'
self.assertEqual(foo.__dict__['faux'], '123')
self.assertEqual(_validated, ['123'])
def test___set___w_readonly_and_already_set(self):
class _Faux(object):
__name__ = 'Faux'
readonly = True
default = '456'
def bind(self, other):
return self
def query(self, inst, default):
return '789'
faux = _Faux()
_validated = []
faux.validate = _validated.append
prop = self._makeOne(faux, 'testing')
class Foo(object):
testing = prop
foo = Foo()
foo.__dict__['testing'] = '789'
self.assertRaises(ValueError, setattr, foo, 'testing', '123')
def test_field_event_update(self):
from zope.schema import Text
from zope.schema._compat import u
from zope.event import subscribers
from zope.schema.fieldproperty import FieldUpdatedEvent
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
default=u('DEFAULT'),
required=True,
)
prop = self._makeOne(field=field)
class Foo(object):
testing = prop
foo = Foo()
log = []
subscribers.append(log.append)
foo.testing = u('Bar')
foo.testing = u('Foo')
self.assertEqual(len(log), 2)
event = log[1]
self.assertTrue(isinstance(event, FieldUpdatedEvent))
self.assertEqual(event.inst, foo)
self.assertEqual(event.field, field)
self.assertEqual(event.old_value, u('Bar'))
self.assertEqual(event.new_value, u('Foo'))
def test_field_event(self):
# fieldproperties are everywhere including in field themselfs
# so event are triggered
from zope.schema import Text
from zope.schema._compat import u
from zope.event import subscribers
from zope.schema.fieldproperty import FieldUpdatedEvent
log = []
subscribers.append(log.append)
self.assertEqual(log, [])
field = Text(
__name__='testing',
description=u('DESCRIPTION'),
default=u('DEFAULT'),
readonly=True,
required=True,
)
self.assertEqual(len(log), 6)
# these are fieldproperties in the field
self.assertEqual(
[ev.field.__name__ for ev in log],
['min_length', 'max_length', 'title', 'description', 'required', 'readonly'])
event = log[0]
self.assertTrue(isinstance(event, FieldUpdatedEvent))
self.assertEqual(event.inst, field)
self.assertEqual(event.old_value, 0)
self.assertEqual(event.new_value, 0)
def _getSchema():
from zope.interface import Interface
from zope.schema import Bytes
from zope.schema import Float
from zope.schema import Text
from zope.schema._compat import b
from zope.schema._compat import u
class Schema(Interface):
title = Text(description=u("Short summary"),
default=u('say something'))
weight = Float(min=0.0)
code = Bytes(min_length=6, max_length=6, default=b('xxxxxx'))
date = Float(title=u('Date'), readonly=True)
return Schema
class CreateFieldPropertiesTests(unittest.TestCase):
"""Testing ..fieldproperty.createFieldProperties."""
def test_creates_fieldproperties_on_class(self):
from zope.schema.fieldproperty import createFieldProperties
from zope.schema.fieldproperty import FieldProperty
schema = _getSchema()
class Dummy(object):
createFieldProperties(schema)
self.assertTrue(isinstance(Dummy.title, FieldProperty))
self.assertTrue(isinstance(Dummy.date, FieldProperty))
self.assertTrue(Dummy.date._FieldProperty__field is schema['date'])
def test_fields_in_omit_are_not_created_on_class(self):
from zope.schema.fieldproperty import createFieldProperties
class Dummy(object):
createFieldProperties(_getSchema(), omit=['date', 'code'])
self.assertFalse(hasattr(Dummy, 'date'))
self.assertFalse(hasattr(Dummy, 'code'))
self.assertTrue(hasattr(Dummy, 'title'))
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(FieldPropertyTests),
unittest.makeSuite(FieldPropertyStoredThroughFieldTests),
unittest.makeSuite(CreateFieldPropertiesTests),
))
zope.schema-4.4.2/src/zope/schema/tests/test__bootstrapinterfaces.py 0000664 0001750 0001750 00000004075 12265302416 027111 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2012 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
import unittest
def _skip_under_py3(testcase):
from zope.schema._compat import PY3
if not PY3:
return testcase
class ValidationErrorTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapinterfaces import ValidationError
return ValidationError
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_doc(self):
class Derived(self._getTargetClass()):
"""DERIVED"""
inst = Derived()
self.assertEqual(inst.doc(), 'DERIVED')
@_skip_under_py3
def test___cmp___no_args(self):
# Py3k??
ve = self._makeOne()
self.assertEqual(cmp(ve, object()), -1)
@_skip_under_py3
def test___cmp___hit(self):
# Py3k??
left = self._makeOne('abc')
right = self._makeOne('def')
self.assertEqual(cmp(left, right), -1)
self.assertEqual(cmp(left, left), 0)
self.assertEqual(cmp(right, left), 1)
def test___eq___no_args(self):
ve = self._makeOne()
self.assertEqual(ve == object(), False)
def test___eq___w_args(self):
left = self._makeOne('abc')
right = self._makeOne('def')
self.assertEqual(left == right, False)
self.assertEqual(left == left, True)
self.assertEqual(right == right, True)
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(ValidationErrorTests),
))
zope.schema-4.4.2/src/zope/schema/tests/test_accessors.py 0000664 0001750 0001750 00000024341 12265302416 024654 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2003 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Test Interface accessor methods.
"""
import unittest
class FieldReadAccessorTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema.accessors import FieldReadAccessor
return FieldReadAccessor
def _makeOne(self, field=None):
from zope.schema import Text
if field is None:
field = Text(__name__='testing')
return self._getTargetClass()(field)
def test_ctor_not_created_inside_interface(self):
from zope.schema import Text
from zope.schema._compat import u
field = Text(title=u('Hmm'))
wrapped = self._makeOne(field)
self.assertTrue(wrapped.field is field)
self.assertEqual(wrapped.__name__, '') # __name__ set when in iface
self.assertEqual(wrapped.__doc__, 'get Hmm')
def test_ctor_created_inside_interface(self):
from zope.interface import Interface
from zope.schema import Text
from zope.schema._compat import u
field = Text(title=u('Hmm'))
class IFoo(Interface):
getter = self._makeOne(field)
getter = IFoo['getter']
self.assertEqual(getter.__name__, 'getter')
self.assertEqual(getter.__doc__, 'get Hmm')
def test___provides___w_field_no_provides(self):
from zope.interface import implementedBy
from zope.interface import providedBy
wrapped = self._makeOne(object())
self.assertEqual(list(providedBy(wrapped)),
list(implementedBy(self._getTargetClass())))
def test___provides___w_field_w_provides(self):
from zope.interface import implementedBy
from zope.interface import providedBy
from zope.schema import Text
field = Text()
field_provides = list(providedBy(field))
wrapped = self._makeOne(field)
wrapped_provides = list(providedBy(wrapped))
self.assertEqual(wrapped_provides[:len(field_provides)],
list(providedBy(field)))
for iface in list(implementedBy(self._getTargetClass())):
self.assertTrue(iface in wrapped_provides)
def test_getSignatureString(self):
wrapped = self._makeOne()
self.assertEqual(wrapped.getSignatureString(), '()')
def test_getSignatureInfo(self):
wrapped = self._makeOne()
info = wrapped.getSignatureInfo()
self.assertEqual(info['positional'], ())
self.assertEqual(info['required'], ())
self.assertEqual(info['optional'], ())
self.assertEqual(info['varargs'], None)
self.assertEqual(info['kwargs'], None)
def test_get_miss(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
class Foo(object):
pass
self.assertRaises(AttributeError, getter.get, Foo())
def test_get_hit(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
class Foo(object):
def getter(self):
return '123'
self.assertEqual(getter.get(Foo()), '123')
def test_query_miss_implicit_default(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
class Foo(object):
pass
self.assertEqual(getter.query(Foo()), None)
def test_query_miss_explicit_default(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
class Foo(object):
pass
self.assertEqual(getter.query(Foo(), 234), 234)
def test_query_hit(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
class Foo(object):
def getter(self):
return '123'
self.assertEqual(getter.query(Foo()), '123')
def test_set_readonly(self):
from zope.interface import Interface
from zope.schema import Text
field = Text(readonly=True)
class IFoo(Interface):
getter = self._makeOne(field)
getter = IFoo['getter']
class Foo(object):
def getter(self):
return '123'
self.assertRaises(TypeError, getter.set, Foo(), '456')
def test_set_no_writer(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
class Foo(object):
def getter(self):
return '123'
self.assertRaises(AttributeError, getter.set, Foo(), '456')
def test_set_w_writer(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
_called_with = []
class Writer(object):
pass
writer = Writer()
writer.__name__ = 'setMe'
getter.writer = writer
class Foo(object):
def setMe(self, value):
_called_with.append(value)
getter.set(Foo(), '456')
self.assertEqual(_called_with, ['456'])
def test_bind(self):
from zope.interface import Interface
class IFoo(Interface):
getter = self._makeOne()
getter = IFoo['getter']
context = object()
bound = getter.bind(context)
self.assertEqual(bound.__name__, 'getter')
self.assertTrue(isinstance(bound.field, getter.field.__class__))
self.assertTrue(bound.field.context is context)
class FieldWriteAccessorTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema.accessors import FieldWriteAccessor
return FieldWriteAccessor
def _makeOne(self, field=None):
from zope.schema import Text
if field is None:
field = Text(__name__='testing')
return self._getTargetClass()(field)
def test_ctor_not_created_inside_interface(self):
from zope.schema import Text
from zope.schema._compat import u
field = Text(title=u('Hmm'))
wrapped = self._makeOne(field)
self.assertTrue(wrapped.field is field)
self.assertEqual(wrapped.__name__, '') # __name__ set when in iface
self.assertEqual(wrapped.__doc__, 'set Hmm')
def test_ctor_created_inside_interface(self):
from zope.interface import Interface
from zope.schema import Text
from zope.schema._compat import u
field = Text(title=u('Hmm'))
class IFoo(Interface):
setter = self._makeOne(field)
setter = IFoo['setter']
self.assertEqual(setter.__name__, 'setter')
self.assertEqual(setter.__doc__, 'set Hmm')
def test_getSignatureString(self):
wrapped = self._makeOne()
self.assertEqual(wrapped.getSignatureString(), '(newvalue)')
def test_getSignatureInfo(self):
wrapped = self._makeOne()
info = wrapped.getSignatureInfo()
self.assertEqual(info['positional'], ('newvalue',))
self.assertEqual(info['required'], ('newvalue',))
self.assertEqual(info['optional'], ())
self.assertEqual(info['varargs'], None)
self.assertEqual(info['kwargs'], None)
class Test_accessors(unittest.TestCase):
def _callFUT(self, *args, **kw):
from zope.schema.accessors import accessors
return accessors(*args, **kw)
def test_w_only_read_accessor(self):
from zope.interface import Interface
from zope.schema import Text
from zope.schema._compat import u
field = Text(title=u('Hmm'), readonly=True)
class IFoo(Interface):
getter, = self._callFUT(field)
getter = IFoo['getter']
self.assertEqual(getter.__name__, 'getter')
self.assertEqual(getter.__doc__, 'get Hmm')
self.assertEqual(getter.getSignatureString(), '()')
info = getter.getSignatureInfo()
self.assertEqual(info['positional'], ())
self.assertEqual(info['required'], ())
self.assertEqual(info['optional'], ())
self.assertEqual(info['varargs'], None)
self.assertEqual(info['kwargs'], None)
def test_w_read_and_write_accessors(self):
from zope.interface import Interface
from zope.schema import Text
from zope.schema._compat import u
field = Text(title=u('Hmm'))
class IFoo(Interface):
getter, setter = self._callFUT(field)
getter = IFoo['getter']
self.assertEqual(getter.__name__, 'getter')
self.assertEqual(getter.getSignatureString(), '()')
info = getter.getSignatureInfo()
self.assertEqual(info['positional'], ())
self.assertEqual(info['required'], ())
self.assertEqual(info['optional'], ())
self.assertEqual(info['varargs'], None)
self.assertEqual(info['kwargs'], None)
setter = IFoo['setter']
self.assertEqual(setter.__name__, 'setter')
self.assertEqual(setter.getSignatureString(), '(newvalue)')
info = setter.getSignatureInfo()
self.assertEqual(info['positional'], ('newvalue',))
self.assertEqual(info['required'], ('newvalue',))
self.assertEqual(info['optional'], ())
self.assertEqual(info['varargs'], None)
self.assertEqual(info['kwargs'], None)
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(FieldReadAccessorTests),
unittest.makeSuite(FieldWriteAccessorTests),
unittest.makeSuite(Test_accessors),
))
zope.schema-4.4.2/src/zope/schema/tests/test__bootstrapfields.py 0000664 0001750 0001750 00000067011 12265302416 026233 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2012 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
import unittest
class ValidatedPropertyTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import ValidatedProperty
return ValidatedProperty
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test___set___not_missing_w_check(self):
_checked = []
def _check(inst, value):
_checked.append((inst, value))
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop', _check)
inst = Test()
inst.prop = 'PROP'
self.assertEqual(inst._prop, 'PROP')
self.assertEqual(_checked, [(inst, 'PROP')])
def test___set___not_missing_wo_check(self):
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop')
inst = Test(ValueError)
def _provoke(inst):
inst.prop = 'PROP'
self.assertRaises(ValueError, _provoke, inst)
self.assertEqual(inst._prop, None)
def test___set___w_missing_wo_check(self):
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop')
inst = Test(ValueError)
inst.prop = DummyInst.missing_value
self.assertEqual(inst._prop, DummyInst.missing_value)
def test___get__(self):
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop')
inst = Test()
inst._prop = 'PROP'
self.assertEqual(inst.prop, 'PROP')
class DefaultPropertyTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import DefaultProperty
return DefaultProperty
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test___get___wo_defaultFactory_miss(self):
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop')
inst = Test()
inst.defaultFactory = None
def _provoke(inst):
return inst.prop
self.assertRaises(KeyError, _provoke, inst)
def test___get___wo_defaultFactory_hit(self):
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop')
inst = Test()
inst.defaultFactory = None
inst._prop = 'PROP'
self.assertEqual(inst.prop, 'PROP')
def test__get___wo_defaultFactory_in_dict(self):
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop')
inst = Test()
inst._prop = 'PROP'
self.assertEqual(inst.prop, 'PROP')
def test___get___w_defaultFactory_not_ICAF_no_check(self):
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop')
inst = Test(ValueError)
def _factory():
return 'PROP'
inst.defaultFactory = _factory
def _provoke(inst):
return inst.prop
self.assertRaises(ValueError, _provoke, inst)
def test___get___w_defaultFactory_w_ICAF_w_check(self):
from zope.interface import directlyProvides
from zope.schema._bootstrapinterfaces \
import IContextAwareDefaultFactory
_checked = []
def _check(inst, value):
_checked.append((inst, value))
class Test(DummyInst):
_prop = None
prop = self._makeOne('_prop', _check)
inst = Test(ValueError)
inst.context = object()
_called_with = []
def _factory(context):
_called_with.append(context)
return 'PROP'
directlyProvides(_factory, IContextAwareDefaultFactory)
inst.defaultFactory = _factory
self.assertEqual(inst.prop, 'PROP')
self.assertEqual(_checked, [(inst, 'PROP')])
self.assertEqual(_called_with, [inst.context])
class FieldTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Field
return Field
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_ctor_defaults(self):
from zope.schema._compat import u
field = self._makeOne()
self.assertEqual(field.__name__, u(''))
self.assertEqual(field.__doc__, u(''))
self.assertEqual(field.title, u(''))
self.assertEqual(field.description, u(''))
self.assertEqual(field.required, True)
self.assertEqual(field.readonly, False)
self.assertEqual(field.constraint(object()), True)
self.assertEqual(field.default, None)
self.assertEqual(field.defaultFactory, None)
self.assertEqual(field.missing_value, None)
self.assertEqual(field.context, None)
def test_ctor_w_title_wo_description(self):
from zope.schema._compat import u
field = self._makeOne(u('TITLE'))
self.assertEqual(field.__name__, u(''))
self.assertEqual(field.__doc__, u('TITLE'))
self.assertEqual(field.title, u('TITLE'))
self.assertEqual(field.description, u(''))
def test_ctor_wo_title_w_description(self):
from zope.schema._compat import u
field = self._makeOne(description=u('DESC'))
self.assertEqual(field.__name__, u(''))
self.assertEqual(field.__doc__, u('DESC'))
self.assertEqual(field.title, u(''))
self.assertEqual(field.description, u('DESC'))
def test_ctor_w_both_title_and_description(self):
from zope.schema._compat import u
field = self._makeOne(u('TITLE'), u('DESC'), u('NAME'))
self.assertEqual(field.__name__, u('NAME'))
self.assertEqual(field.__doc__, u('TITLE\n\nDESC'))
self.assertEqual(field.title, u('TITLE'))
self.assertEqual(field.description, u('DESC'))
def test_ctor_order_madness(self):
klass = self._getTargetClass()
order_before = klass.order
field = self._makeOne()
order_after = klass.order
self.assertEqual(order_after, order_before + 1)
self.assertEqual(field.order, order_after)
def test_explicit_required_readonly_missingValue(self):
obj = object()
field = self._makeOne(required=False, readonly=True, missing_value=obj)
self.assertEqual(field.required, False)
self.assertEqual(field.readonly, True)
self.assertEqual(field.missing_value, obj)
def test_explicit_constraint_default(self):
_called_with = []
obj = object()
def _constraint(value):
_called_with.append(value)
return value is obj
field = self._makeOne(
required=False, readonly=True, constraint=_constraint, default=obj
)
self.assertEqual(field.required, False)
self.assertEqual(field.readonly, True)
self.assertEqual(_called_with, [obj])
self.assertEqual(field.constraint(self), False)
self.assertEqual(_called_with, [obj, self])
self.assertEqual(field.default, obj)
def test_explicit_defaultFactory(self):
_called_with = []
obj = object()
def _constraint(value):
_called_with.append(value)
return value is obj
def _factory():
return obj
field = self._makeOne(
required=False,
readonly=True,
constraint=_constraint,
defaultFactory=_factory,
)
self.assertEqual(field.required, False)
self.assertEqual(field.readonly, True)
self.assertEqual(field.constraint(self), False)
self.assertEqual(_called_with, [self])
self.assertEqual(field.default, obj)
self.assertEqual(_called_with, [self, obj])
self.assertEqual(field.defaultFactory, _factory)
def test_explicit_defaultFactory_returning_missing_value(self):
def _factory():
return None
field = self._makeOne(required=True,
defaultFactory=_factory)
self.assertEqual(field.default, None)
def test_bind(self):
obj = object()
field = self._makeOne()
bound = field.bind(obj)
self.assertEqual(bound.context, obj)
expected = dict(field.__dict__)
found = dict(bound.__dict__)
found.pop('context')
self.assertEqual(found, expected)
self.assertEqual(bound.__class__, field.__class__)
def test_validate_missing_not_required(self):
missing = object()
def _fail(value):
return False
field = self._makeOne(
required=False, missing_value=missing, constraint=_fail,
)
self.assertEqual(field.validate(missing), None) # doesn't raise
def test_validate_missing_and_required(self):
from zope.schema._bootstrapinterfaces import RequiredMissing
missing = object()
def _fail(value):
return False
field = self._makeOne(
required=True, missing_value=missing, constraint=_fail,
)
self.assertRaises(RequiredMissing, field.validate, missing)
def test_validate_wrong_type(self):
from zope.schema._bootstrapinterfaces import WrongType
def _fail(value):
return False
field = self._makeOne(required=True, constraint=_fail)
field._type = str
self.assertRaises(WrongType, field.validate, 1)
def test_validate_constraint_fails(self):
from zope.schema._bootstrapinterfaces import ConstraintNotSatisfied
def _fail(value):
return False
field = self._makeOne(required=True, constraint=_fail)
field._type = int
self.assertRaises(ConstraintNotSatisfied, field.validate, 1)
def test_validate_constraint_raises_StopValidation(self):
from zope.schema._bootstrapinterfaces import StopValidation
def _fail(value):
raise StopValidation
field = self._makeOne(required=True, constraint=_fail)
field._type = int
field.validate(1) # doesn't raise
def test___eq___different_type(self):
left = self._makeOne()
class Derived(self._getTargetClass()):
pass
right = Derived()
self.assertEqual(left == right, False)
self.assertEqual(left != right, True)
def test___eq___same_type_different_attrs(self):
left = self._makeOne(required=True)
right = self._makeOne(required=False)
self.assertEqual(left == right, False)
self.assertEqual(left != right, True)
def test___eq___same_type_same_attrs(self):
left = self._makeOne()
right = self._makeOne()
self.assertEqual(left == right, True)
self.assertEqual(left != right, False)
def test_get_miss(self):
field = self._makeOne(__name__='nonesuch')
inst = DummyInst()
self.assertRaises(AttributeError, field.get, inst)
def test_get_hit(self):
field = self._makeOne(__name__='extant')
inst = DummyInst()
inst.extant = 'EXTANT'
self.assertEqual(field.get(inst), 'EXTANT')
def test_query_miss_no_default(self):
field = self._makeOne(__name__='nonesuch')
inst = DummyInst()
self.assertEqual(field.query(inst), None)
def test_query_miss_w_default(self):
field = self._makeOne(__name__='nonesuch')
inst = DummyInst()
self.assertEqual(field.query(inst, 'DEFAULT'), 'DEFAULT')
def test_query_hit(self):
field = self._makeOne(__name__='extant')
inst = DummyInst()
inst.extant = 'EXTANT'
self.assertEqual(field.query(inst), 'EXTANT')
def test_set_readonly(self):
field = self._makeOne(__name__='lirame', readonly=True)
inst = DummyInst()
self.assertRaises(TypeError, field.set, inst, 'VALUE')
def test_set_hit(self):
field = self._makeOne(__name__='extant')
inst = DummyInst()
inst.extant = 'BEFORE'
field.set(inst, 'AFTER')
self.assertEqual(inst.extant, 'AFTER')
class ContainerTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Container
return Container
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
self.assertRaises(RequiredMissing, field.validate, None)
def test__validate_not_collection_not_iterable(self):
from zope.schema._bootstrapinterfaces import NotAContainer
cont = self._makeOne()
self.assertRaises(NotAContainer, cont._validate, object())
def test__validate_collection_but_not_iterable(self):
cont = self._makeOne()
class Dummy(object):
def __contains__(self, item):
return False
cont._validate(Dummy()) # doesn't raise
def test__validate_not_collection_but_iterable(self):
cont = self._makeOne()
class Dummy(object):
def __iter__(self):
return iter(())
cont._validate(Dummy()) # doesn't raise
def test__validate_w_collections(self):
cont = self._makeOne()
cont._validate(()) # doesn't raise
cont._validate([]) # doesn't raise
cont._validate('') # doesn't raise
cont._validate({}) # doesn't raise
class IterableTests(ContainerTests):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Iterable
return Iterable
def test__validate_collection_but_not_iterable(self):
from zope.schema._bootstrapinterfaces import NotAnIterator
itr = self._makeOne()
class Dummy(object):
def __contains__(self, item):
return False
self.assertRaises(NotAnIterator, itr._validate, Dummy())
class OrderableTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Orderable
return Orderable
def _makeOne(self, *args, **kw):
# Orderable is a mixin for a type derived from Field
from zope.schema._bootstrapfields import Field
class Mixed(self._getTargetClass(), Field):
pass
return Mixed(*args, **kw)
def test_ctor_defaults(self):
ordb = self._makeOne()
self.assertEqual(ordb.min, None)
self.assertEqual(ordb.max, None)
self.assertEqual(ordb.default, None)
def test_ctor_default_too_small(self):
# This test exercises _validate, too
from zope.schema._bootstrapinterfaces import TooSmall
self.assertRaises(TooSmall, self._makeOne, min=0, default=-1)
def test_ctor_default_too_large(self):
# This test exercises _validate, too
from zope.schema._bootstrapinterfaces import TooBig
self.assertRaises(TooBig, self._makeOne, max=10, default=11)
class MinMaxLenTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import MinMaxLen
return MinMaxLen
def _makeOne(self, *args, **kw):
# MinMaxLen is a mixin for a type derived from Field
from zope.schema._bootstrapfields import Field
class Mixed(self._getTargetClass(), Field):
pass
return Mixed(*args, **kw)
def test_ctor_defaults(self):
mml = self._makeOne()
self.assertEqual(mml.min_length, 0)
self.assertEqual(mml.max_length, None)
def test_validate_too_short(self):
from zope.schema._bootstrapinterfaces import TooShort
mml = self._makeOne(min_length=1)
self.assertRaises(TooShort, mml._validate, ())
def test_validate_too_long(self):
from zope.schema._bootstrapinterfaces import TooLong
mml = self._makeOne(max_length=2)
self.assertRaises(TooLong, mml._validate, (0, 1, 2))
class TextTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Text
return Text
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_ctor_defaults(self):
from zope.schema._compat import text_type
txt = self._makeOne()
self.assertEqual(txt._type, text_type)
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_w_invalid_default(self):
from zope.schema._compat import b
from zope.schema.interfaces import ValidationError
self.assertRaises(ValidationError, self._makeOne, default=b(''))
def test_validate_not_required(self):
from zope.schema._compat import u
field = self._makeOne(required=False)
field.validate(u(''))
field.validate(u('abc'))
field.validate(u('abc\ndef'))
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
from zope.schema._compat import u
field = self._makeOne()
field.validate(u(''))
field.validate(u('abc'))
field.validate(u('abc\ndef'))
self.assertRaises(RequiredMissing, field.validate, None)
def test_fromUnicode_miss(self):
from zope.schema._bootstrapinterfaces import WrongType
from zope.schema._compat import b
deadbeef = b('DEADBEEF')
txt = self._makeOne()
self.assertRaises(WrongType, txt.fromUnicode, deadbeef)
def test_fromUnicode_hit(self):
from zope.schema._compat import u
deadbeef = u('DEADBEEF')
txt = self._makeOne()
self.assertEqual(txt.fromUnicode(deadbeef), deadbeef)
class TextLineTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._field import TextLine
return TextLine
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_class_conforms_to_ITextLine(self):
from zope.interface.verify import verifyClass
from zope.schema.interfaces import ITextLine
verifyClass(ITextLine, self._getTargetClass())
def test_instance_conforms_to_ITextLine(self):
from zope.interface.verify import verifyObject
from zope.schema.interfaces import ITextLine
verifyObject(ITextLine, self._makeOne())
def test_validate_wrong_types(self):
from zope.schema.interfaces import WrongType
from zope.schema._compat import b
field = self._makeOne()
self.assertRaises(WrongType, field.validate, b(''))
self.assertRaises(WrongType, field.validate, 1)
self.assertRaises(WrongType, field.validate, 1.0)
self.assertRaises(WrongType, field.validate, ())
self.assertRaises(WrongType, field.validate, [])
self.assertRaises(WrongType, field.validate, {})
self.assertRaises(WrongType, field.validate, set())
self.assertRaises(WrongType, field.validate, frozenset())
self.assertRaises(WrongType, field.validate, object())
def test_validate_not_required(self):
from zope.schema._compat import u
field = self._makeOne(required=False)
field.validate(u(''))
field.validate(u('abc'))
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
from zope.schema._compat import u
field = self._makeOne()
field.validate(u(''))
field.validate(u('abc'))
self.assertRaises(RequiredMissing, field.validate, None)
def test_constraint(self):
from zope.schema._compat import u
field = self._makeOne()
self.assertEqual(field.constraint(u('')), True)
self.assertEqual(field.constraint(u('abc')), True)
self.assertEqual(field.constraint(u('abc\ndef')), False)
class PasswordTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Password
return Password
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_set_unchanged(self):
klass = self._getTargetClass()
pw = self._makeOne()
inst = DummyInst()
before = dict(inst.__dict__)
pw.set(inst, klass.UNCHANGED_PASSWORD) # doesn't raise, doesn't write
after = dict(inst.__dict__)
self.assertEqual(after, before)
def test_set_normal(self):
pw = self._makeOne(__name__='password')
inst = DummyInst()
pw.set(inst, 'PASSWORD')
self.assertEqual(inst.password, 'PASSWORD')
def test_validate_not_required(self):
from zope.schema._compat import u
field = self._makeOne(required=False)
field.validate(u(''))
field.validate(u('abc'))
field.validate(None)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
from zope.schema._compat import u
field = self._makeOne()
field.validate(u(''))
field.validate(u('abc'))
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_unchanged_not_already_set(self):
from zope.schema._bootstrapinterfaces import WrongType
klass = self._getTargetClass()
inst = DummyInst()
pw = self._makeOne(__name__='password').bind(inst)
self.assertRaises(WrongType,
pw.validate, klass.UNCHANGED_PASSWORD)
def test_validate_unchanged_already_set(self):
klass = self._getTargetClass()
inst = DummyInst()
inst.password = 'foobar'
pw = self._makeOne(__name__='password').bind(inst)
pw.validate(klass.UNCHANGED_PASSWORD) # doesn't raise
def test_constraint(self):
from zope.schema._compat import u
field = self._makeOne()
self.assertEqual(field.constraint(u('')), True)
self.assertEqual(field.constraint(u('abc')), True)
self.assertEqual(field.constraint(u('abc\ndef')), False)
class BoolTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Bool
return Bool
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_ctor_defaults(self):
txt = self._makeOne()
self.assertEqual(txt._type, bool)
def test__validate_w_int(self):
boo = self._makeOne()
boo._validate(0) # doesn't raise
boo._validate(1) # doesn't raise
def test_set_w_int(self):
boo = self._makeOne(__name__='boo')
inst = DummyInst()
boo.set(inst, 0)
self.assertEqual(inst.boo, False)
boo.set(inst, 1)
self.assertEqual(inst.boo, True)
def test_fromUnicode_miss(self):
from zope.schema._compat import u
txt = self._makeOne()
self.assertEqual(txt.fromUnicode(u('')), False)
self.assertEqual(txt.fromUnicode(u('0')), False)
self.assertEqual(txt.fromUnicode(u('1')), False)
self.assertEqual(txt.fromUnicode(u('False')), False)
self.assertEqual(txt.fromUnicode(u('false')), False)
def test_fromUnicode_hit(self):
from zope.schema._compat import u
txt = self._makeOne()
self.assertEqual(txt.fromUnicode(u('True')), True)
self.assertEqual(txt.fromUnicode(u('true')), True)
class IntTests(unittest.TestCase):
def _getTargetClass(self):
from zope.schema._bootstrapfields import Int
return Int
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_ctor_defaults(self):
from zope.schema._compat import integer_types
txt = self._makeOne()
self.assertEqual(txt._type, integer_types)
def test_validate_not_required(self):
field = self._makeOne(required=False)
field.validate(None)
field.validate(10)
field.validate(0)
field.validate(-1)
def test_validate_required(self):
from zope.schema.interfaces import RequiredMissing
field = self._makeOne()
field.validate(10)
field.validate(0)
field.validate(-1)
self.assertRaises(RequiredMissing, field.validate, None)
def test_validate_min(self):
from zope.schema.interfaces import TooSmall
field = self._makeOne(min=10)
field.validate(10)
field.validate(20)
self.assertRaises(TooSmall, field.validate, 9)
self.assertRaises(TooSmall, field.validate, -10)
def test_validate_max(self):
from zope.schema.interfaces import TooBig
field = self._makeOne(max=10)
field.validate(5)
field.validate(9)
field.validate(10)
self.assertRaises(TooBig, field.validate, 11)
self.assertRaises(TooBig, field.validate, 20)
def test_validate_min_and_max(self):
from zope.schema.interfaces import TooBig
from zope.schema.interfaces import TooSmall
field = self._makeOne(min=0, max=10)
field.validate(0)
field.validate(5)
field.validate(10)
self.assertRaises(TooSmall, field.validate, -10)
self.assertRaises(TooSmall, field.validate, -1)
self.assertRaises(TooBig, field.validate, 11)
self.assertRaises(TooBig, field.validate, 20)
def test_fromUnicode_miss(self):
from zope.schema._compat import u
txt = self._makeOne()
self.assertRaises(ValueError, txt.fromUnicode, u(''))
self.assertRaises(ValueError, txt.fromUnicode, u('False'))
self.assertRaises(ValueError, txt.fromUnicode, u('True'))
def test_fromUnicode_hit(self):
from zope.schema._compat import u
txt = self._makeOne()
self.assertEqual(txt.fromUnicode(u('0')), 0)
self.assertEqual(txt.fromUnicode(u('1')), 1)
self.assertEqual(txt.fromUnicode(u('-1')), -1)
class DummyInst(object):
missing_value = object()
def __init__(self, exc=None):
self._exc = exc
def validate(self, value):
if self._exc is not None:
raise self._exc()
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(ValidatedPropertyTests),
unittest.makeSuite(DefaultPropertyTests),
unittest.makeSuite(FieldTests),
unittest.makeSuite(ContainerTests),
unittest.makeSuite(IterableTests),
unittest.makeSuite(OrderableTests),
unittest.makeSuite(MinMaxLenTests),
unittest.makeSuite(TextTests),
unittest.makeSuite(TextLineTests),
unittest.makeSuite(PasswordTests),
unittest.makeSuite(BoolTests),
unittest.makeSuite(IntTests),
))
zope.schema-4.4.2/src/zope/schema/tests/test_interfaces.py 0000664 0001750 0001750 00000006605 12265302416 025015 0 ustar tseaver tseaver 0000000 0000000 import unittest
class Test__is_field(unittest.TestCase):
def _callFUT(self, value):
from zope.schema.interfaces import _is_field
return _is_field(value)
def test_non_fields(self):
from zope.schema._compat import b
from zope.schema._compat import u
self.assertEqual(self._callFUT(None), False)
self.assertEqual(self._callFUT(0), False)
self.assertEqual(self._callFUT(0.0), False)
self.assertEqual(self._callFUT(True), False)
self.assertEqual(self._callFUT(b('')), False)
self.assertEqual(self._callFUT(u('')), False)
self.assertEqual(self._callFUT(()), False)
self.assertEqual(self._callFUT([]), False)
self.assertEqual(self._callFUT({}), False)
self.assertEqual(self._callFUT(set()), False)
self.assertEqual(self._callFUT(frozenset()), False)
self.assertEqual(self._callFUT(object()), False)
def test_w_normal_fields(self):
from zope.schema import Text
from zope.schema import Bytes
from zope.schema import Int
from zope.schema import Float
from zope.schema import Decimal
self.assertEqual(self._callFUT(Text()), True)
self.assertEqual(self._callFUT(Bytes()), True)
self.assertEqual(self._callFUT(Int()), True)
self.assertEqual(self._callFUT(Float()), True)
self.assertEqual(self._callFUT(Decimal()), True)
def test_w_explicitly_provided(self):
from zope.interface import directlyProvides
from zope.schema.interfaces import IField
class Foo(object):
pass
foo = Foo()
self.assertEqual(self._callFUT(foo), False)
directlyProvides(foo, IField)
self.assertEqual(self._callFUT(foo), True)
class Test__fields(unittest.TestCase):
def _callFUT(self, values):
from zope.schema.interfaces import _fields
return _fields(values)
def test_empty_containers(self):
self.assertEqual(self._callFUT(()), True)
self.assertEqual(self._callFUT([]), True)
def test_w_non_fields(self):
self.assertEqual(self._callFUT([None]), False)
self.assertEqual(self._callFUT(['']), False)
self.assertEqual(self._callFUT([object()]), False)
def test_w_fields(self):
from zope.schema import Text
from zope.schema import Bytes
from zope.schema import Int
from zope.schema import Float
from zope.schema import Decimal
self.assertEqual(self._callFUT([Text()]), True)
self.assertEqual(self._callFUT([Bytes()]), True)
self.assertEqual(self._callFUT([Int()]), True)
self.assertEqual(self._callFUT([Float()]), True)
self.assertEqual(self._callFUT([Decimal()]), True)
self.assertEqual(
self._callFUT([Text(), Bytes(), Int(), Float(), Decimal()]),
True
)
def test_w_mixed(self):
from zope.schema import Text
from zope.schema import Bytes
from zope.schema import Int
from zope.schema import Float
from zope.schema import Decimal
self.assertEqual(self._callFUT([Text(), 0]), False)
self.assertEqual(
self._callFUT([Text(), Bytes(), Int(), Float(), Decimal(), 0]),
False
)
def test_suite():
return unittest.TestSuite((
unittest.makeSuite(Test__is_field),
unittest.makeSuite(Test__fields),
))
zope.schema-4.4.2/src/zope/schema/_bootstrapfields.py 0000664 0001750 0001750 00000033426 12265302416 024035 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Bootstrapping fields
"""
__docformat__ = 'restructuredtext'
from zope.interface import Attribute
from zope.interface import providedBy
from zope.interface import implementer
from zope.schema._bootstrapinterfaces import ConstraintNotSatisfied
from zope.schema._bootstrapinterfaces import IContextAwareDefaultFactory
from zope.schema._bootstrapinterfaces import IFromUnicode
from zope.schema._bootstrapinterfaces import NotAContainer
from zope.schema._bootstrapinterfaces import NotAnIterator
from zope.schema._bootstrapinterfaces import RequiredMissing
from zope.schema._bootstrapinterfaces import StopValidation
from zope.schema._bootstrapinterfaces import TooBig
from zope.schema._bootstrapinterfaces import TooLong
from zope.schema._bootstrapinterfaces import TooShort
from zope.schema._bootstrapinterfaces import TooSmall
from zope.schema._bootstrapinterfaces import WrongType
from zope.schema._compat import u
from zope.schema._compat import text_type
from zope.schema._compat import integer_types
from zope.schema._schema import getFields
class ValidatedProperty(object):
def __init__(self, name, check=None):
self._info = name, check
def __set__(self, inst, value):
name, check = self._info
if value != inst.missing_value:
if check is not None:
check(inst, value)
else:
inst.validate(value)
inst.__dict__[name] = value
def __get__(self, inst, owner):
name, check = self._info
return inst.__dict__[name]
class DefaultProperty(ValidatedProperty):
def __get__(self, inst, owner):
name, check = self._info
defaultFactory = inst.__dict__.get('defaultFactory')
# If there is no default factory, simply return the default.
if defaultFactory is None:
return inst.__dict__[name]
# Get the default value by calling the factory. Some factories might
# require a context to produce a value.
if IContextAwareDefaultFactory.providedBy(defaultFactory):
value = defaultFactory(inst.context)
else:
value = defaultFactory()
# Check that the created value is valid.
if check is not None:
check(inst, value)
elif value != inst.missing_value:
inst.validate(value)
return value
class Field(Attribute):
# Type restrictions, if any
_type = None
context = None
# If a field has no assigned value, it will be set to missing_value.
missing_value = None
# This is the default value for the missing_value argument to the
# Field constructor. A marker is helpful since we don't want to
# overwrite missing_value if it is set differently on a Field
# subclass and isn't specified via the constructor.
__missing_value_marker = object()
# Note that the "order" field has a dual existance:
# 1. The class variable Field.order is used as a source for the
# monotonically increasing values used to provide...
# 2. The instance variable self.order which provides a
# monotonically increasing value that tracks the creation order
# of Field (including Field subclass) instances.
order = 0
default = DefaultProperty('default')
# These were declared as slots in zope.interface, we override them here to
# get rid of the dedcriptors so they don't break .bind()
__name__ = None
interface = None
_Element__tagged_values = None
def __init__(self, title=u(''), description=u(''), __name__='',
required=True, readonly=False, constraint=None, default=None,
defaultFactory=None, missing_value=__missing_value_marker):
"""Pass in field values as keyword parameters.
Generally, you want to pass either a title and description, or
a doc string. If you pass no doc string, it will be computed
from the title and description. If you pass a doc string that
follows the Python coding style (title line separated from the
body by a blank line), the title and description will be
computed from the doc string. Unfortunately, the doc string
must be passed as a positional argument.
Here are some examples:
>>> from zope.schema._compat import u
>>> f = Field()
>>> f.__doc__, f.title, f.description
('', u'', u'')
>>> f = Field(title=u('sample'))
>>> f.__doc__, f.title, f.description
(u'sample', u'sample', u'')
>>> f = Field(title=u('sample'), description=u('blah blah\\nblah'))
>>> f.__doc__, f.title, f.description
(u'sample\\n\\nblah blah\\nblah', u'sample', u'blah blah\\nblah')
"""
__doc__ = ''
if title:
if description:
__doc__ = "%s\n\n%s" % (title, description)
else:
__doc__ = title
elif description:
__doc__ = description
super(Field, self).__init__(__name__, __doc__)
self.title = title
self.description = description
self.required = required
self.readonly = readonly
if constraint is not None:
self.constraint = constraint
self.default = default
self.defaultFactory = defaultFactory
# Keep track of the order of field definitions
Field.order += 1
self.order = Field.order
if missing_value is not self.__missing_value_marker:
self.missing_value = missing_value
def constraint(self, value):
return True
def bind(self, object):
clone = self.__class__.__new__(self.__class__)
clone.__dict__.update(self.__dict__)
clone.context = object
return clone
def validate(self, value):
if value == self.missing_value:
if self.required:
raise RequiredMissing(self.__name__)
else:
try:
self._validate(value)
except StopValidation:
pass
def __eq__(self, other):
# should be the same type
if type(self) != type(other):
return False
# should have the same properties
names = {} # used as set of property names, ignoring values
for interface in providedBy(self):
names.update(getFields(interface))
# order will be different always, don't compare it
if 'order' in names:
del names['order']
for name in names:
if getattr(self, name) != getattr(other, name):
return False
return True
def __ne__(self, other):
return not self.__eq__(other)
def _validate(self, value):
if self._type is not None and not isinstance(value, self._type):
raise WrongType(value, self._type, self.__name__)
if not self.constraint(value):
raise ConstraintNotSatisfied(value, self.__name__)
def get(self, object):
return getattr(object, self.__name__)
def query(self, object, default=None):
return getattr(object, self.__name__, default)
def set(self, object, value):
if self.readonly:
raise TypeError("Can't set values on read-only fields "
"(name=%s, class=%s.%s)"
% (self.__name__,
object.__class__.__module__,
object.__class__.__name__))
setattr(object, self.__name__, value)
class Container(Field):
def _validate(self, value):
super(Container, self)._validate(value)
if not hasattr(value, '__contains__'):
try:
iter(value)
except TypeError:
raise NotAContainer(value)
# XXX This class violates the Liskov Substituability Principle: it
# is derived from Container, but cannot be used everywhere an instance
# of Container could be, because it's '_validate' is more restrictive.
class Iterable(Container):
def _validate(self, value):
super(Iterable, self)._validate(value)
# See if we can get an iterator for it
try:
iter(value)
except TypeError:
raise NotAnIterator(value)
class Orderable(object):
"""Values of ordered fields can be sorted.
They can be restricted to a range of values.
Orderable is a mixin used in combination with Field.
"""
min = ValidatedProperty('min')
max = ValidatedProperty('max')
def __init__(self, min=None, max=None, default=None, **kw):
# Set min and max to None so that we can validate if
# one of the super methods invoke validation.
self.min = None
self.max = None
super(Orderable, self).__init__(**kw)
# Now really set min and max
self.min = min
self.max = max
# We've taken over setting default so it can be limited by min
# and max.
self.default = default
def _validate(self, value):
super(Orderable, self)._validate(value)
if self.min is not None and value < self.min:
raise TooSmall(value, self.min)
if self.max is not None and value > self.max:
raise TooBig(value, self.max)
class MinMaxLen(object):
"""Expresses constraints on the length of a field.
MinMaxLen is a mixin used in combination with Field.
"""
min_length = 0
max_length = None
def __init__(self, min_length=0, max_length=None, **kw):
self.min_length = min_length
self.max_length = max_length
super(MinMaxLen, self).__init__(**kw)
def _validate(self, value):
super(MinMaxLen, self)._validate(value)
if self.min_length is not None and len(value) < self.min_length:
raise TooShort(value, self.min_length)
if self.max_length is not None and len(value) > self.max_length:
raise TooLong(value, self.max_length)
@implementer(IFromUnicode)
class Text(MinMaxLen, Field):
"""A field containing text used for human discourse."""
_type = text_type
def __init__(self, *args, **kw):
super(Text, self).__init__(*args, **kw)
def fromUnicode(self, str):
"""
>>> from zope.schema._compat import u
>>> from zope.schema._compat import b
>>> t = Text(constraint=lambda v: 'x' in v)
>>> t.fromUnicode(b("foo x spam"))
Traceback (most recent call last):
...
WrongType: ('foo x spam', , '')
>>> t.fromUnicode(u("foo x spam"))
u'foo x spam'
>>> t.fromUnicode(u("foo spam"))
Traceback (most recent call last):
...
ConstraintNotSatisfied: (u'foo spam', '')
"""
self.validate(str)
return str
class TextLine(Text):
"""A text field with no newlines."""
def constraint(self, value):
return '\n' not in value and '\r' not in value
class Password(TextLine):
"""A text field containing a text used as a password."""
UNCHANGED_PASSWORD = object()
def set(self, context, value):
"""Update the password.
We use a special marker value that a widget can use
to tell us that the password didn't change. This is
needed to support edit forms that don't display the
existing password and want to work together with
encryption.
"""
if value is self.UNCHANGED_PASSWORD:
return
super(Password, self).set(context, value)
def validate(self, value):
try:
existing = bool(self.get(self.context))
except AttributeError:
existing = False
if value is self.UNCHANGED_PASSWORD and existing:
# Allow the UNCHANGED_PASSWORD value, if a password is set already
return
return super(Password, self).validate(value)
class Bool(Field):
"""A field representing a Bool."""
_type = bool
def _validate(self, value):
# Convert integers to bools to they don't get mis-flagged
# by the type check later.
if isinstance(value, int):
value = bool(value)
Field._validate(self, value)
def set(self, object, value):
if isinstance(value, int):
value = bool(value)
Field.set(self, object, value)
def fromUnicode(self, str):
"""
>>> from zope.schema._compat import b
>>> b = Bool()
>>> IFromUnicode.providedBy(b)
True
>>> b.fromUnicode('True')
True
>>> b.fromUnicode('')
False
>>> b.fromUnicode('true')
True
>>> b.fromUnicode('false') or b.fromUnicode('False')
False
"""
v = str == 'True' or str == 'true'
self.validate(v)
return v
@implementer(IFromUnicode)
class Int(Orderable, Field):
"""A field representing an Integer."""
_type = integer_types
def __init__(self, *args, **kw):
super(Int, self).__init__(*args, **kw)
def fromUnicode(self, str):
"""
>>> f = Int()
>>> f.fromUnicode("125")
125
>>> f.fromUnicode("125.6") #doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
ValueError: invalid literal for int(): 125.6
"""
v = int(str)
self.validate(v)
return v
zope.schema-4.4.2/src/zope/schema/_messageid.py 0000664 0001750 0001750 00000001510 12265302416 022557 0 ustar tseaver tseaver 0000000 0000000 ##############################################################################
#
# Copyright (c) 2000 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
try:
from zope.i18nmessageid import MessageFactory
except ImportError: # pragma: no cover
from zope.schema._compat import text_type as _
else: # pragma: no cover
_ = MessageFactory("zope")
zope.schema-4.4.2/COPYRIGHT.txt 0000664 0001750 0001750 00000000040 12072655571 017220 0 ustar tseaver tseaver 0000000 0000000 Zope Foundation and Contributors zope.schema-4.4.2/CHANGES.rst 0000664 0001750 0001750 00000023017 12402106204 016677 0 ustar tseaver tseaver 0000000 0000000 zope.schema Changelog
=====================
4.4.2 (2014-09-04)
------------------
- Fix description of min max field: max value is included, not excluded.
4.4.1 (2014-03-19)
------------------
- Added support for Python 3.4.
4.4.0 (2014-01-22)
------------------
- Add an event on field properties to notify that a field has been updated.
This event enables definition of subscribers based on an event, a context
and a field. The event contains also the old value and the new value.
(also see package ``zope.schemaevent`` that define a field event handler)
4.3.3 (2014-01-06)
------------------
- PEP 8 cleanup.
- Don't raise RequiredMissing if a field's defaultFactory returns the field's
missing_value.
- Updated ``boostrap.py`` to version 2.2.
- Add the ability to swallow ValueErrors when rendering a SimpleVocabulary,
allowing for cases where vocabulary items may be duplicated (e.g., due to
user input).
- It was a pain that ``ConstraintNotSatisfied`` did not tell the field name.
4.3.2 (2013-02-24)
------------------
- Fix Python 2.6 support. (Forgot to run tox with all environments before last
release.)
4.3.1 (2013-02-24)
------------------
- Make sure that we do not fail during bytes decoding of term token when
generated from a bytes value by ignoring all errors. (Another option would
have been to hexlify the value, but that would break way too many tests.)
4.3.0 (2013-02-24)
------------------
- Fixed a bug where bytes values were turned into tokens inproperly in
Python 3.
- Added ``createFieldProperties()`` function which maps schema fields into
``FieldProperty`` instances.
4.2.2 (2012-11-21)
------------------
- Added support for Python 3.3.
4.2.1 (2012-11-09)
------------------
- Fix the default property of fields that have no defaultFactory attribute.
4.2.0 (2012-05-12)
------------------
- Automated build of Sphinx HTML docs and running doctest snippets via tox.
- Dropped explicit support for Python 3.1.
- Introduce NativeString and NativeStringLine which are equal to Bytes and
BytesLine on Python 2 and Text and TextLine on Python 3.
- Change IURI from a Bytes string to a "native" string. This is a backwards
incompatibility which only affects Python 3.
- 100% unit test coverage.
- Doctests moved from the package and wired up as normal Sphinx documentation.
- Added explicit support for PyPy.
- Added support for continuous integration using ``tox`` and ``jenkins``.
- Dropped the external ``six`` dependency in favor of a much-trimmed
``zope.schema._compat`` module.
- Tests now pass when run under ``nose``.
- Added ``setup.py dev`` alias (runs ``setup.py develop`` plus installs
``nose`` and ``coverage``).
- Added ``setup.py docs`` alias (installs ``Sphinx`` and dependencies).
4.1.1 (2012-03-23)
------------------
- Remove trailing slash in MANIFEST.in, it causes Winbot to crash.
4.1.0 (2012-03-23)
------------------
- Add TreeVocabulary for nested tree-like vocabularies.
- Fix broken Object field validation where the schema contains a Choice with
ICountextSourceBinder source. In this case the vocabulary was not iterable
because the field was not bound and the source binder didn't return the
real vocabulary. Added simple test for IContextSourceBinder validation. But a
test with an Object field with a schema using a Choice with
IContextSourceBinder is still missing.
4.0.1 (2011-11-14)
------------------
- Fix bug in ``fromUnicode`` method of ``DottedName`` which would fail
validation on being given unicode. Introduced in 4.0.0.
4.0.0 (2011-11-09)
------------------
- Fix deprecated unittest methods.
- Port to Python 3. This adds a dependency on six and removes support for
Python 2.5.
3.8.1 (2011-09-23)
------------------
- fix broken Object field validation. Previous version was using a volatile
property on object field values which ends in a ForbiddenAttribute error
on security proxied objects.
3.8.0 (2011-03-18)
------------------
- Implemented a ``defaultFactory`` attribute for all fields. It is a callable
that can be used to compute default values. The simplest case is::
Date(defaultFactory=datetime.date.today)
If the factory needs a context to compute a sensible default value, then it
must provide ``IContextAwareDefaultFactory``, which can be used as follows::
@provider(IContextAwareDefaultFactory)
def today(context):
return context.today()
Date(defaultFactory=today)
3.7.1 (2010-12-25)
------------------
- The validation token, used in the validation of schema with Object
Field to avoid infinite recursion, has been renamed.
``__schema_being_validated`` became ``_v_schema_being_validated``,
a volatile attribute, to avoid persistency and therefore,
read/write conflicts.
- Don't allow "[\]^`" in DottedName.
https://bugs.launchpad.net/zope.schema/+bug/191236
3.7.0 (2010-09-12)
------------------
- Improve error messages when term tokens or values are duplicates.
- Fix the buildout so the tests run.
3.6.4 (2010-06-08)
------------------
- fix validation of schema with Object Field that specify Interface schema.
3.6.3 (2010-04-30)
------------------
- Prefer the standard libraries doctest module to the one from zope.testing.
3.6.2 (2010-04-30)
------------------
- Avoid maximum recursion when validating Object field that points to cycles
- Made the dependency on ``zope.i18nmessageid`` optional.
3.6.1 (2010-01-05)
------------------
- Allow "setup.py test" to run at least a subset of the tests runnable
via ``bin/test`` (227 for ``setup.py test`` vs. 258. for
``bin/test``)
- Make ``zope.schema._bootstrapfields.ValidatedProperty`` descriptor
work under Jython.
- Make "setup.py test" tests pass on Jython.
3.6.0 (2009-12-22)
------------------
- Prefer zope.testing.doctest over doctestunit.
- Extend validation error to hold the field name.
- Add FieldProperty class that uses Field.get and Field.set methods
instead of storing directly on the instance __dict__.
3.5.4 (2009-03-25)
------------------
- Don't fail trying to validate default value for Choice fields with
IContextSourceBinder object given as a source. See
https://bugs.launchpad.net/zope3/+bug/340416.
- Add an interface for ``DottedName`` field.
- Add ``vocabularyName`` attribute to the ``IChoice`` interface, change
"vocabulary" attribute description to be more sensible, making it
``zope.schema.Field`` instead of plain ``zope.interface.Attribute``.
- Make IBool interface of Bool more important than IFromUnicode so adapters
registered for IBool take precendence over adapters registered for
IFromUnicode.
3.5.3 (2009-03-10)
------------------
- Make Choice and Bool fields implement IFromUnicode interface, because
they do provide the ``fromUnicode`` method.
- Change package's mailing list address to zope-dev at zope.org, as
zope3-dev at zope.org is now retired.
- Fix package's documentation formatting. Change package's description.
- Add buildout part that builds Sphinx-generated documentation.
- Remove zpkg-related file.
3.5.2 (2009-02-04)
------------------
- Made validation tests compatible with Python 2.5 again (hopefully not
breaking Python 2.4)
- Added an __all__ package attribute to expose documentation.
3.5.1 (2009-01-31)
------------------
- Stop using the old old set type.
- Make tests compatible and silent with Python 2.4.
- Fix __cmp__ method in ValidationError. Show some side effects based on the
existing __cmp__ implementation. See validation.txt
- Make 'repr' of the ValidationError and its subclasses more sensible. This
may require you to adapt your doctests for the new style, but now it makes
much more sense for debugging for developers.
3.5.0a2 (2008-12-11)
--------------------
- Move zope.testing to "test" extras_require, as it is not needed
for zope.schema itself.
- Change the order of classes in SET_TYPES tuple, introduced in
previous release to one that was in 3.4 (SetType, set), because
third-party code could be dependent on that order. The one
example is z3c.form's converter.
3.5.0a1 (2008-10-10)
--------------------
- Added the doctests to the long description.
- Removed use of deprecated 'sets' module when running under Python 2.6.
- Removed spurious doctest failure when running under Python 2.6.
- Added support to bootstrap on Jython.
- Added helper methods for schema validation: ``getValidationErrors``
and ``getSchemaValidationErrors``.
- zope.schema now works on Python2.5
3.4.0 (2007-09-28)
------------------
Added BeforeObjectAssignedEvent that is triggered before the object
field sets a value.
3.3.0 (2007-03-15)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.3.0 release.
3.2.1 (2006-03-26)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.2.1 release.
Fixed missing import of 'VocabularyRegistryError'. See
http://www.zope.org/Collectors/Zope3-dev/544 .
3.2.0 (2006-01-05)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.2.0 release.
Added "iterable" sources to replace vocabularies, which are now deprecated
and scheduled for removal in Zope 3.3.
3.1.0 (2005-10-03)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope 3.1.0 release.
Allowed 'Choice' fields to take either a 'vocabulary' or a 'source'
argument (sources are a simpler implementation).
Added 'TimeDelta' and 'ASCIILine' field types.
3.0.0 (2004-11-07)
------------------
Corresponds to the version of the zope.schema package shipped as part of
the Zope X3.0.0 release.
zope.schema-4.4.2/LICENSE.txt 0000664 0001750 0001750 00000004026 12072655571 016742 0 ustar tseaver tseaver 0000000 0000000 Zope Public License (ZPL) Version 2.1
A copyright notice accompanies this license document that identifies the
copyright holders.
This license has been certified as open source. It has also been designated as
GPL compatible by the Free Software Foundation (FSF).
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions in source code must retain the accompanying copyright
notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the accompanying copyright
notice, this list of conditions, and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Names of the copyright holders must not be used to endorse or promote
products derived from this software without prior written permission from the
copyright holders.
4. The right to distribute this software or to use it for any purpose does not
give you the right to use Servicemarks (sm) or Trademarks (tm) of the
copyright
holders. Use of them is covered by separate agreement with the copyright
holders.
5. If any files are modified, you must cause the modified files to carry
prominent notices stating that you changed the files and the date of any
change.
Disclaimer
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
zope.schema-4.4.2/README.rst 0000664 0001750 0001750 00000001102 12072655571 016576 0 ustar tseaver tseaver 0000000 0000000 zope.schema README
==================
Schemas extend the notion of interfaces to detailed descriptions of
Attributes (but not methods). Every schema is an interface and
specifies the public fields of an object. A *field* roughly
corresponds to an attribute of a Python object. But a Field provides
space for at least a title and a description. It can also constrain
its value and provide a validation method. Besides you can optionally
specify characteristics such as its value being read-only or not
required.
See http://docs.zope.org/zope.schema/ for more information.
zope.schema-4.4.2/docs/ 0000775 0001750 0001750 00000000000 12402106344 016027 5 ustar tseaver tseaver 0000000 0000000 zope.schema-4.4.2/docs/sources.rst 0000664 0001750 0001750 00000006067 12072655571 020273 0 ustar tseaver tseaver 0000000 0000000 =======
Sources
=======
Concepts
--------
Sources are designed with three concepts:
- The source itself - an iterable
This can return any kind of object it wants. It doesn't have to care
for browser representation, encoding, ...
- A way to map a value from the iterable to something that can be used
for form *values* - this is called a token. A token is commonly a
(unique) 7bit representation of the value.
- A way to map a value to something that can be displayed to the user -
this is called a title
The last two elements are dispatched using a so called `term`. The
ITitledTokenizedTerm interface contains a triple of (value, token, title).
Additionally there are some lookup functions to perform the mapping
between values and terms and tokens and terms.
Sources that require context use a special factory: a context source
binder that is called with the context and instanciates the source when
it is actually used.
Sources in Fields
-----------------
A choice field can be constructed with a source or source name. When a source
is used, it will be used as the source for valid values.
Create a source for all odd numbers.
.. doctest::
>>> from zope import interface
>>> from zope.schema.interfaces import ISource, IContextSourceBinder
>>> @interface.implementer(ISource)
... class MySource(object):
... divisor = 2
... def __contains__(self, value):
... return bool(value % self.divisor)
>>> my_source = MySource()
>>> 1 in my_source
True
>>> 2 in my_source
False
>>> from zope.schema import Choice
>>> choice = Choice(__name__='number', source=my_source)
>>> bound = choice.bind(object())
>>> bound.vocabulary
<...MySource...>
If a IContextSourceBinder is passed as the `source` argument to Choice, it's
`bind` method will be called with the context as its only argument. The
result must implement ISource and will be used as the source.
.. doctest::
>>> _my_binder_called = []
>>> def my_binder(context):
... _my_binder_called.append(context)
... source = MySource()
... source.divisor = context.divisor
... return source
>>> interface.directlyProvides(my_binder, IContextSourceBinder)
>>> class Context(object):
... divisor = 3
>>> choice = Choice(__name__='number', source=my_binder)
>>> bound = choice.bind(Context())
>>> len(_my_binder_called)
1
>>> bound.vocabulary
<...MySource...>
>>> bound.vocabulary.divisor
3
When using IContextSourceBinder together with default value, it's
impossible to validate it on field initialization. Let's check if
initalization doesn't fail in that case.
.. doctest::
>>> choice = Choice(__name__='number', source=my_binder, default=2)
>>> del _my_binder_called[:]
>>> bound = choice.bind(Context())
>>> len(_my_binder_called)
1
>>> bound.validate(bound.default)
>>> bound.validate(3)
Traceback (most recent call last):
...
ConstraintNotSatisfied: 3
It's developer's responsibility to provide a default value that fits the
constraints when using context-based sources.
zope.schema-4.4.2/docs/make.bat 0000664 0001750 0001750 00000011760 12072655571 017457 0 ustar tseaver tseaver 0000000 0000000 @ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^` where ^ is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\zopeschema.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\zopeschema.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
:end
zope.schema-4.4.2/docs/Makefile 0000664 0001750 0001750 00000012714 12072655571 017512 0 ustar tseaver tseaver 0000000 0000000 # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make ' where is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/zopeschema.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/zopeschema.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/zopeschema"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/zopeschema"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
zope.schema-4.4.2/docs/conf.py 0000664 0001750 0001750 00000017316 12072655571 017354 0 ustar tseaver tseaver 0000000 0000000 # -*- coding: utf-8 -*-
#
# zope.schema documentation build configuration file, created by
# sphinx-quickstart on Fri Apr 20 15:00:47 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'zope.schema'
copyright = u'2012, Zope Foundation Contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '4.2'
# The full version, including alpha/beta/rc tags.
release = '4.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'zopeschemadoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'zopeschema.tex', u'zope.schema Documentation',
u'Zope Foundation Contributors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'zopeschema', u'zope.schema Documentation',
[u'Zope Foundation Contributors'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'zopeschema', u'zope.schema Documentation',
u'Zope Foundation Contributors', 'zopeschema', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
zope.schema-4.4.2/docs/index.rst 0000664 0001750 0001750 00000000414 12072655571 017705 0 ustar tseaver tseaver 0000000 0000000 Welcome to zope.schema's documentation!
=======================================
Contents:
.. toctree::
:maxdepth: 2
narr
fields
sources
validation
hacking
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
zope.schema-4.4.2/docs/validation.rst 0000664 0001750 0001750 00000011524 12312122016 020710 0 ustar tseaver tseaver 0000000 0000000 =================
Schema Validation
=================
There are two helper methods to verify schemas and interfaces:
getValidationErrors
first validates via the zope.schema field validators. If that succeeds the
invariants are checked.
getSchemaValidationErrors
*only* validates via the zope.schema field validators. The invariants are
*not* checked.
Create an interface to validate against:
.. doctest::
>>> import zope.interface
>>> import zope.schema
>>> _a_greater_b_called = []
>>> class ITwoInts(zope.interface.Interface):
... a = zope.schema.Int(max=10)
... b = zope.schema.Int(min=5)
...
... @zope.interface.invariant
... def a_greater_b(obj):
... _a_greater_b_called.append(obj)
... if obj.a <= obj.b:
... raise zope.interface.Invalid("%s<=%s" % (obj.a, obj.b))
...
Create a silly model:
.. doctest::
>>> class TwoInts(object):
... pass
Create an instance of TwoInts but do not set attributes. We get two errors:
.. doctest::
>>> ti = TwoInts()
>>> r = zope.schema.getValidationErrors(ITwoInts, ti)
>>> r.sort()
>>> len(r)
2
>>> r[0][0]
'a'
>>> r[0][1].__class__.__name__
'SchemaNotFullyImplemented'
>>> r[0][1].args[0].args
("'TwoInts' object has no attribute 'a'",)
>>> r[1][0]
'b'
>>> r[1][1].__class__.__name__
'SchemaNotFullyImplemented'
>>> r[1][1].args[0].args
("'TwoInts' object has no attribute 'b'",)
The `getSchemaValidationErrors` function returns the same result:
.. doctest::
>>> r = zope.schema.getSchemaValidationErrors(ITwoInts, ti)
>>> r.sort()
>>> len(r)
2
>>> r[0][0]
'a'
>>> r[0][1].__class__.__name__
'SchemaNotFullyImplemented'
>>> r[0][1].args[0].args
("'TwoInts' object has no attribute 'a'",)
>>> r[1][0]
'b'
>>> r[1][1].__class__.__name__
'SchemaNotFullyImplemented'
>>> r[1][1].args[0].args
("'TwoInts' object has no attribute 'b'",)
Note that see no error from the invariant because the invariants are not
validated if there are other schema errors.
When we set a valid value for `a` we still get the same error for `b`:
.. doctest::
>>> ti.a = 11
>>> errors = zope.schema.getValidationErrors(ITwoInts, ti)
>>> errors.sort()
>>> len(errors)
2
>>> errors[0][0]
'a'
>>> errors[0][1].doc()
u'Value is too big'
>>> errors[0][1].__class__.__name__
'TooBig'
>>> errors[0][1].args
(11, 10)
>>> errors[1][0]
'b'
>>> errors[1][1].__class__.__name__
'SchemaNotFullyImplemented'
>>> errors[1][1].args[0].args
("'TwoInts' object has no attribute 'b'",)
After setting a valid value for `a` there is only the error for the missing `b`
left:
.. doctest::
>>> ti.a = 8
>>> r = zope.schema.getValidationErrors(ITwoInts, ti)
>>> r
[('b', SchemaNotFullyImplemented(...AttributeError...))]
>>> r[0][1].args[0].args
("'TwoInts' object has no attribute 'b'",)
After setting valid value for `b` the schema is valid so the invariants are
checked. As `b>a` the invariant fails:
.. doctest::
>>> ti.b = 10
>>> errors = zope.schema.getValidationErrors(ITwoInts, ti)
>>> len(errors)
1
>>> errors[0][0] is None
True
>>> errors[0][1].__class__.__name__
'Invalid'
>>> len(_a_greater_b_called)
1
When using `getSchemaValidationErrors` we do not get an error any more:
.. doctest::
>>> zope.schema.getSchemaValidationErrors(ITwoInts, ti)
[]
Set `b=5` so everything is fine:
.. doctest::
>>> ti.b = 5
>>> del _a_greater_b_called[:]
>>> zope.schema.getValidationErrors(ITwoInts, ti)
[]
>>> len(_a_greater_b_called)
1
Compare ValidationError
-----------------------
There was an issue with compare validation error with something else then an
exceptions. Let's test if we can compare ValidationErrors with different things
.. doctest::
>>> from zope.schema._bootstrapinterfaces import ValidationError
>>> v1 = ValidationError('one')
>>> v2 = ValidationError('one')
>>> v3 = ValidationError('another one')
A ValidationError with the same arguments compares:
.. doctest::
>>> v1 == v2
True
but not with an error with different arguments:
.. doctest::
>>> v1 == v3
False
We can also compare validation errors with other things then errors. This
was running into an AttributeError in previous versions of zope.schema. e.g.
AttributeError: 'NoneType' object has no attribute 'args'
.. doctest::
>>> v1 == None
False
>>> v1 == object()
False
>>> v1 == False
False
>>> v1 == True
False
>>> v1 == 0
False
>>> v1 == 1
False
>>> v1 == int
False
If we compare a ValidationError with another validation error based class,
we will get the following result:
.. doctest::
>>> from zope.schema._bootstrapinterfaces import RequiredMissing
>>> r1 = RequiredMissing('one')
>>> v1 == r1
True
zope.schema-4.4.2/docs/narr.rst 0000664 0001750 0001750 00000023273 12072655571 017550 0 ustar tseaver tseaver 0000000 0000000 ==============
Zope 3 Schemas
==============
Introduction
------------
*This package is intended to be independently reusable in any Python
project. It is maintained by the* `Zope Toolkit project `_.
Schemas extend the notion of interfaces to detailed descriptions of Attributes
(but not methods). Every schema is an interface and specifies the public
fields of an object. A *field* roughly corresponds to an attribute of a
python object. But a Field provides space for at least a title and a
description. It can also constrain its value and provide a validation method.
Besides you can optionally specify characteristics such as its value being
read-only or not required.
Zope 3 schemas were born when Jim Fulton and Martijn Faassen thought
about Formulator for Zope 3 and ``PropertySets`` while at the `Zope 3
sprint`_ at the Zope BBQ in Berlin. They realized that if you strip
all view logic from forms then you have something similar to interfaces. And
thus schemas were born.
.. _Zope 3 sprint: http://dev.zope.org/Zope3/ZopeBBQ2002Sprint
Simple Usage
------------
Let's have a look at a simple example. First we write an interface as usual,
but instead of describing the attributes of the interface with ``Attribute``
instances, we now use schema fields:
.. doctest::
>>> import zope.interface
>>> import zope.schema
>>> from zope.schema._compat import u, b
>>> class IBookmark(zope.interface.Interface):
... title = zope.schema.TextLine(
... title=u('Title'),
... description=u('The title of the bookmark'),
... required=True)
...
... url = zope.schema.URI(
... title=u('Bookmark URL'),
... description=u('URL of the Bookmark'),
... required=True)
...
Now we create a class that implements this interface and create an instance of
it:
.. doctest::
>>> @zope.interface.implementer(IBookmark)
... class Bookmark(object):
...
... title = None
... url = None
>>> bm = Bookmark()
We would now like to only add validated values to the class. This can be done
by first validating and then setting the value on the object. The first step
is to define some data:
.. doctest::
>>> title = u('Zope 3 Website')
>>> url = b('http://dev.zope.org/Zope3')
Now we, get the fields from the interface:
.. doctest::
>>> title_field = IBookmark.get('title')
>>> url_field = IBookmark.get('url')
Next we have to bind these fields to the context, so that instance-specific
information can be used for validation:
.. doctest::
>>> title_bound = title_field.bind(bm)
>>> url_bound = url_field.bind(bm)
Now that the fields are bound, we can finally validate the data:
.. doctest::
>>> title_bound.validate(title)
>>> url_bound.validate(url)
If the validation is successful, ``None`` is returned. If a validation error
occurs a ``ValidationError`` will be raised; for example:
.. doctest::
>>> from zope.schema._compat import non_native_string
>>> url_bound.validate(non_native_string('http://zope.org/foo'))
Traceback (most recent call last):
...
WrongType: ...
>>> url_bound.validate('foo.bar')
Traceback (most recent call last):
...
InvalidURI: foo.bar
Now that the data has been successfully validated, we can set it on the
object:
.. doctest::
>>> title_bound.set(bm, title)
>>> url_bound.set(bm, url)
That's it. You still might think this is a lot of work to validate and set a
value for an object. Note, however, that it is very easy to write helper
functions that automate these tasks. If correctly designed, you will never
have to worry explicitly about validation again, since the system takes care
of it automatically.
What is a schema, how does it compare to an interface?
------------------------------------------------------
A schema is an extended interface which defines fields. You can validate that
the attributes of an object conform to their fields defined on the schema.
With plain interfaces you can only validate that methods conform to their
interface specification.
So interfaces and schemas refer to different aspects of an object
(respectively its code and state).
A schema starts out like an interface but defines certain fields to
which an object's attributes must conform. Let's look at a stripped
down example from the programmer's tutorial:
.. doctest::
>>> import re
>>> class IContact(zope.interface.Interface):
... """Provides access to basic contact information."""
...
... first = zope.schema.TextLine(title=u("First name"))
...
... last = zope.schema.TextLine(title=u("Last name"))
...
... email = zope.schema.TextLine(title=u("Electronic mail address"))
...
... address = zope.schema.Text(title=u("Postal address"))
...
... postalCode = zope.schema.TextLine(
... title=u("Postal code"),
... constraint=re.compile("\d{5,5}(-\d{4,4})?$").match)
``TextLine`` is a field and expresses that an attribute is a single line
of Unicode text. ``Text`` expresses an arbitrary Unicode ("text")
object. The most interesting part is the last attribute
specification. It constrains the ``postalCode`` attribute to only have
values that are US postal codes.
Now we want a class that adheres to the ``IContact`` schema:
.. doctest::
>>> class Contact(object):
... zope.interface.implements(IContact)
...
... def __init__(self, first, last, email, address, pc):
... self.first = first
... self.last = last
... self.email = email
... self.address = address
... self.postalCode = pc
Now you can see if an instance of ``Contact`` actually implements the
schema:
.. doctest::
>>> someone = Contact(u('Tim'), u('Roberts'), u('tim@roberts'), u(''),
... u('12032-3492'))
>>> for field in zope.schema.getFields(IContact).values():
... bound = field.bind(someone)
... bound.validate(bound.get(someone))
Data Modeling Concepts
-----------------------
The ``zope.schema`` package provides a core set of field types,
including single- and multi-line text fields, binary data fields,
integers, floating-point numbers, and date/time values.
Selection issues; field type can specify:
- "Raw" data value
Simple values not constrained by a selection list.
- Value from enumeration (options provided by schema)
This models a single selection from a list of possible values
specified by the schema. The selection list is expected to be the
same for all values of the type. Changes to the list are driven by
schema evolution.
This is done by mixing-in the ``IEnumerated`` interface into the field
type, and the Enumerated mix-in for the implementation (or emulating
it in a concrete class).
- Value from selection list (options provided by an object)
This models a single selection from a list of possible values
specified by a source outside the schema. The selection list
depends entirely on the source of the list, and may vary over time
and from object to object. Changes to the list are not related to
the schema, but changing how the list is determined is based on
schema evolution.
There is not currently a spelling of this, but it could be
facilitated using alternate mix-ins similar to IEnumerated and
Enumerated.
- Whether or not the field is read-only
If a field value is read-only, it cannot be changed once the object is
created.
- Whether or not the field is required
If a field is designated as required, assigned field values must always
be non-missing. See the next section for a description of missing values.
- A value designated as ``missing``
Missing values, when assigned to an object, indicate that there is 'no
data' for that field. Missing values are analogous to null values in
relational databases. For example, a boolean value can be True, False, or
missing, in which case its value is unknown.
While Python's None is the most likely value to signify 'missing', some
fields may use different values. For example, it is common for text fields
to use the empty string ('') to signify that a value is missing. Numeric
fields may use 0 or -1 instead of None as their missing value.
A field that is 'required' signifies that missing values are invalid and
should not be assigned.
- A default value
Default field values are assigned to objects when they are first created. A
default factory can be specified to dynamically compute default values.
Fields and Widgets
------------------
Widgets are components that display field values and, in the case of
writable fields, allow the user to edit those values.
Widgets:
- Display current field values, either in a read-only format, or in a
format that lets the user change the field value.
- Update their corresponding field values based on values provided by users.
- Manage the relationships between their representation of a field value
and the object's field value. For example, a widget responsible for
editing a number will likely represent that number internally as a string.
For this reason, widgets must be able to convert between the two value
formats. In the case of the number-editing widget, string values typed
by the user need to be converted to numbers such as int or float.
- Support the ability to assign a missing value to a field. For example,
a widget may present a ``None`` option for selection that, when selected,
indicates that the object should be updated with the field's ``missing``
value.
References
----------
- Use case list, http://dev.zope.org/Zope3/Zope3SchemasUseCases
- Documented interfaces, zope/schema/interfaces.py
- Jim Fulton's Programmers Tutorial; in CVS:
Docs/ZopeComponentArchitecture/PythonProgrammerTutorial/Chapter2
zope.schema-4.4.2/docs/fields.rst 0000664 0001750 0001750 00000037340 12164373076 020053 0 ustar tseaver tseaver 0000000 0000000 ======
Fields
======
This document highlights unusual and subtle aspects of various fields and
field classes, and is not intended to be a general introduction to schema
fields. Please see README.txt for a more general introduction.
While many field types, such as Int, TextLine, Text, and Bool are relatively
straightforward, a few have some subtlety. We will explore the general
class of collections and discuss how to create a custom creation field; discuss
Choice fields, vocabularies, and their use with collections; and close with a
look at the standard zope.app approach to using these fields to find views
("widgets").
Scalars
-------
Scalar fields represent simple. immutable Python types.
Bytes
#####
:class:`zope.schema._field.Bytes` fields contain binary data, represented
as a sequence of bytes (``str`` in Python2, ``bytes`` in Python3).
Conversion from Unicode:
.. doctest::
>>> from zope.schema._compat import b
>>> from zope.schema._compat import u
>>> from zope.schema._field import Bytes
>>> obj = Bytes(constraint=lambda v: b('x') in v)
>>> obj.fromUnicode(u(" foo x.y.z bat"))
' foo x.y.z bat'
>>> obj.fromUnicode(u(" foo y.z bat"))
Traceback (most recent call last):
...
ConstraintNotSatisfied: foo y.z bat
ASCII
#####
:class:`zope.schema._field.ASCII` fields are a restricted form of
:class:`zope.schema._field.Bytes`: they can contain only 7-bit bytes.
Validation accepts empty strings:
.. doctest::
>>> from zope.schema._field import ASCII
>>> ascii = ASCII()
>>> empty = ''
>>> ascii._validate(empty)
and all kinds of alphanumeric strings:
.. doctest::
>>> alphanumeric = "Bob\'s my 23rd uncle"
>>> ascii._validate(alphanumeric)
but fails with 8-bit (encoded) strings:
.. doctest::
>>> umlauts = "Köhlerstraße"
>>> ascii._validate(umlauts)
Traceback (most recent call last):
...
InvalidValue
BytesLine
#########
:class:`zope.schema._field.BytesLine` fields are a restricted form of
:class:`zope.schema._field.Bytes`: they cannot contain newlines.
ASCIILine
#########
:class:`zope.schema._field.BytesLine` fields are a restricted form of
:class:`zope.schema._field.ASCII`: they cannot contain newlines.
Float
#####
:class:`zope.schema._field.Float` fields contain binary data, represented
as a a Python ``float``.
Conversion from Unicode:
.. doctest::
>>> from zope.schema._field import Float
>>> f = Float()
>>> f.fromUnicode("1.25")
1.25
>>> f.fromUnicode("1.25.6") #doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
ValueError: invalid literal for float(): 1.25.6
Decimal
#######
:class:`zope.schema._field.Decimal` fields contain binary data, represented
as a a Python ``decimal.Decimal``.
Conversion from Unicode:
.. doctest::
>>> from zope.schema._field import Decimal
>>> f = Decimal()
>>> import decimal
>>> isinstance(f.fromUnicode("1.25"), decimal.Decimal)
True
>>> float(f.fromUnicode("1.25"))
1.25
>>> f.fromUnicode("1.25.6")
Traceback (most recent call last):
...
ValueError: invalid literal for Decimal(): 1.25.6
DateTime
########
:class:`zope.schema._field.DateTime` fields contain binary data, represented
as a a Python ``datetime.DateTime``.
Date
####
:class:`zope.schema._field.Date` fields contain binary data, represented
as a a Python ``datetime.Date``.
TimeDelta
#########
:class:`zope.schema._field.TimeDelta` fields contain binary data, represented
as a a Python ``datetime.TimeDelta``.
Time
####
:class:`zope.schema._field.Time` fields contain binary data, represented
as a a Python ``datetime.Time``.
Choice
######
:class:`zope.schema._field.Choice` fields are constrained to values drawn
from a specified set, which can be static or dynamic.
Conversion from Unicode enforces the constraint:
.. doctest::
>>> from zope.schema.interfaces import IFromUnicode
>>> from zope.schema.vocabulary import SimpleVocabulary
>>> from zope.schema._field import Choice
>>> t = Choice(
... vocabulary=SimpleVocabulary.fromValues([u('foo'),u('bar')]))
>>> IFromUnicode.providedBy(t)
True
>>> t.fromUnicode(u("baz"))
Traceback (most recent call last):
...
ConstraintNotSatisfied: baz
>>> t.fromUnicode(u("foo"))
u'foo'
By default, ValueErrors are thrown if duplicate values or tokens
are passed in. If you are using this vocabulary as part of a form
that is generated from non-pristine data, this may not be the
desired behavior. If you want to swallow these exceptions, pass
in swallow_duplicates=True when initializing the vocabulary. See
the test cases for an example.
URI
###
:class:`zope.schema._field.URI` fields contain native Python strings
(``str``), matching the "scheme:data" pattern.
Validation ensures that the pattern is matched:
.. doctest::
>>> from zope.schema._field import URI
>>> uri = URI(__name__='test')
>>> uri.validate(b("http://www.python.org/foo/bar"))
>>> uri.validate(b("DAV:"))
>>> uri.validate(b("www.python.org/foo/bar"))
Traceback (most recent call last):
...
InvalidURI: www.python.org/foo/bar
Conversion from Unicode:
.. doctest::
>>> uri = URI(__name__='test')
>>> uri.fromUnicode("http://www.python.org/foo/bar")
'http://www.python.org/foo/bar'
>>> uri.fromUnicode(" http://www.python.org/foo/bar")
'http://www.python.org/foo/bar'
>>> uri.fromUnicode(" \n http://www.python.org/foo/bar\n")
'http://www.python.org/foo/bar'
>>> uri.fromUnicode("http://www.python.org/ foo/bar")
Traceback (most recent call last):
...
InvalidURI: http://www.python.org/ foo/bar
DottedName
##########
:class:`zope.schema._field.DottedName` fields contain native Python strings
(``str``), containing zero or more "dots" separating elements of the
name. The minimum and maximum number of dots can be passed to the
constructor:
.. doctest::
>>> from zope.schema._field import DottedName
>>> DottedName(min_dots=-1)
Traceback (most recent call last):
...
ValueError: min_dots cannot be less than zero
>>> DottedName(max_dots=-1)
Traceback (most recent call last):
...
ValueError: max_dots cannot be less than min_dots
>>> DottedName(max_dots=1, min_dots=2)
Traceback (most recent call last):
...
ValueError: max_dots cannot be less than min_dots
>>> dotted_name = DottedName(max_dots=1, min_dots=1)
>>> from zope.interface.verify import verifyObject
>>> from zope.schema.interfaces import IDottedName
>>> verifyObject(IDottedName, dotted_name)
True
>>> dotted_name = DottedName(max_dots=1)
>>> dotted_name.min_dots
0
>>> dotted_name = DottedName(min_dots=1)
>>> dotted_name.max_dots
>>> dotted_name.min_dots
1
Validation ensures that the pattern is matched:
.. doctest::
>>> dotted_name = DottedName(__name__='test')
>>> dotted_name.validate("a.b.c")
>>> dotted_name.validate("a")
>>> dotted_name.validate(" a")
Traceback (most recent call last):
...
InvalidDottedName: a
>>> dotted_name = DottedName(__name__='test', min_dots=1)
>>> dotted_name.validate('a.b')
>>> dotted_name.validate('a.b.c.d')
>>> dotted_name.validate('a')
Traceback (most recent call last):
...
InvalidDottedName: ('too few dots; 1 required', 'a')
>>> dotted_name = DottedName(__name__='test', max_dots=0)
>>> dotted_name.validate('a')
>>> dotted_name.validate('a.b')
Traceback (most recent call last):
...
InvalidDottedName: ('too many dots; no more than 0 allowed', 'a.b')
>>> dotted_name = DottedName(__name__='test', max_dots=2)
>>> dotted_name.validate('a')
>>> dotted_name.validate('a.b')
>>> dotted_name.validate('a.b.c')
>>> dotted_name.validate('a.b.c.d')
Traceback (most recent call last):
...
InvalidDottedName: ('too many dots; no more than 2 allowed', 'a.b.c.d')
>>> dotted_name = DottedName(__name__='test', max_dots=1, min_dots=1)
>>> dotted_name.validate('a.b')
>>> dotted_name.validate('a')
Traceback (most recent call last):
...
InvalidDottedName: ('too few dots; 1 required', 'a')
>>> dotted_name.validate('a.b.c')
Traceback (most recent call last):
...
InvalidDottedName: ('too many dots; no more than 1 allowed', 'a.b.c')
Id
##
:class:`zope.schema._field.Id` fields contain native Python strings
(``str``), matching either the URI pattern or a "dotted name".
Validation ensures that the pattern is matched:
.. doctest::
>>> from zope.schema._field import Id
>>> id = Id(__name__='test')
>>> id.validate("http://www.python.org/foo/bar")
>>> id.validate("zope.app.content")
>>> id.validate("zope.app.content/a")
Traceback (most recent call last):
...
InvalidId: zope.app.content/a
>>> id.validate("http://zope.app.content x y")
Traceback (most recent call last):
...
InvalidId: http://zope.app.content x y
Conversion from Unicode:
.. doctest::
>>> id = Id(__name__='test')
>>> id.fromUnicode("http://www.python.org/foo/bar")
'http://www.python.org/foo/bar'
>>> id.fromUnicode(u(" http://www.python.org/foo/bar "))
'http://www.python.org/foo/bar'
>>> id.fromUnicode("http://www.python.org/ foo/bar")
Traceback (most recent call last):
...
InvalidId: http://www.python.org/ foo/bar
>>> id.fromUnicode(" \n x.y.z \n")
'x.y.z'
Collections
-----------
Normal fields typically describe the API of the attribute -- does it behave as a
Python Int, or a Float, or a Bool -- and various constraints to the model, such
as a maximum or minimum value. Collection fields have additional requirements
because they contain other types, which may also be described and constrained.
For instance, imagine a list that contains non-negative floats and enforces
uniqueness. In a schema, this might be written as follows:
.. doctest::
>>> from zope.interface import Interface
>>> from zope.schema import List, Float
>>> from zope.schema._compat import u
>>> class IInventoryItem(Interface):
... pricePoints = List(
... title=u("Price Points"),
... unique=True,
... value_type=Float(title=u("Price"), min=0.0)
... )
This indicates several things.
- pricePoints is an attribute of objects that implement IInventoryItem.
- The contents of pricePoints can be accessed and manipulated via a Python list
API.
- Each member of pricePoints must be a non-negative float.
- Members cannot be duplicated within pricePoints: each must be must be unique.
- The attribute and its contents have descriptive titles. Typically these
would be message ids.
This declaration creates a field that implements a number of interfaces, among
them these:
.. doctest::
>>> from zope.schema.interfaces import IList, ISequence, ICollection
>>> IList.providedBy(IInventoryItem['pricePoints'])
True
>>> ISequence.providedBy(IInventoryItem['pricePoints'])
True
>>> ICollection.providedBy(IInventoryItem['pricePoints'])
True
Creating a custom collection field
----------------------------------
Ideally, custom collection fields have interfaces that inherit appropriately
from either zope.schema.interfaces.ISequence or
zope.schema.interfaces.IUnorderedCollection. Most collection fields should be
able to subclass zope.schema._field.AbstractCollection to get the necessary
behavior. Notice the behavior of the Set field in zope.schema._field: this
would also be necessary to implement a Bag.
Choices and Vocabularies
------------------------
Choice fields are the schema way of spelling enumerated fields and more. By
providing a dynamically generated vocabulary, the choices available to a
choice field can be contextually calculated.
Simple choices do not have to explicitly use vocabularies:
.. doctest::
>>> from zope.schema import Choice
>>> f = Choice((640, 1028, 1600))
>>> f.validate(640)
>>> f.validate(960)
Traceback (most recent call last):
...
ConstraintNotSatisfied: 960
>>> f.validate('bing')
Traceback (most recent call last):
...
ConstraintNotSatisfied: bing
More complex choices will want to use registered vocabularies. Vocabularies
have a simple interface, as defined in
zope.schema.interfaces.IBaseVocabulary. A vocabulary must minimally be able
to determine whether it contains a value, to create a term object for a value,
and to return a query interface (or None) to find items in itself. Term
objects are an abstraction that wraps a vocabulary value.
The Zope application server typically needs a fuller interface that provides
"tokens" on its terms: ASCII values that have a one-to-one relationship to the
values when the vocabulary is asked to "getTermByToken". If a vocabulary is
small, it can also support the IIterableVocabulary interface.
If a vocabulary has been registered, then the choice merely needs to pass the
vocabulary identifier to the "vocabulary" argument of the choice during
instantiation.
A start to a vocabulary implementation that may do all you need for many simple
tasks may be found in zope.schema.vocabulary.SimpleVocabulary. Because
registered vocabularies are simply callables passed a context, many
registered vocabularies can simply be functions that rely on SimpleVocabulary:
.. doctest::
>>> from zope.schema.vocabulary import SimpleVocabulary
>>> def myDynamicVocabulary(context):
... v = dynamic_context_calculation_that_returns_an_iterable(context)
... return SimpleVocabulary.fromValues(v)
...
The vocabulary interface is simple enough that writing a custom vocabulary is
not too difficult itself.
See zope.schema.vocabulary.TreeVocabulary for another
IBaseVocabulary supporting vocabulary that provides a nested, tree-like
structure.
Choices and Collections
-----------------------
Choices are a field type and can be used as a value_type for collections. Just
as a collection of an "Int" value_type constrains members to integers, so a
choice-based value type constrains members to choices within the Choice's
vocabulary. Typically in the Zope application server widgets are found not
only for the collection and the choice field but also for the vocabulary on
which the choice is based.
Using Choice and Collection Fields within a Widget Framework
------------------------------------------------------------
While fields support several use cases, including code documentation and data
description and even casting, a significant use case influencing their design is
to support form generation -- generating widgets for a field. Choice and
collection fields are expected to be used within widget frameworks. The
zope.app approach typically (but configurably) uses multiple dispatches to
find widgets on the basis of various aspects of the fields.
Widgets for all fields are found by looking up a browser view of the field
providing an input or display widget view. Typically there is only a single
"widget" registered for Choice fields. When it is looked up, it performs
another dispatch -- another lookup -- for a widget registered for both the field
and the vocabulary. This widget typically has enough information to render
without a third dispatch.
Collection fields may fire several dispatches. The first is the usual lookup
by field. A single "widget" should be registered for ICollection, which does
a second lookup by field and value_type constraint, if any, or, theoretically,
if value_type is None, renders some absolutely generic collection widget that
allows input of any value imaginable: a check-in of such a widget would be
unexpected. This second lookup may find a widget that knows how to render,
and stop. However, the value_type may be a choice, which will usually fire a
third dispatch: a search for a browser widget for the collection field, the
value_type field, and the vocabulary. Further lookups may even be configured
on the basis of uniqueness and other constraints.
This level of indirection may be unnecessary for some applications, and can be
disabled with simple ZCML changes within `zope.app`.
zope.schema-4.4.2/docs/hacking.rst 0000664 0001750 0001750 00000023271 12072655571 020210 0 ustar tseaver tseaver 0000000 0000000 Hacking on :mod:`zope.schema`
============================
Getting the Code
-----------------
The main repository for :mod:`zope.schema` is in the Zope Subversion
repository:
http://svn.zope.org/zope.schema
You can get a read-only Subversion checkout from there:
.. code-block:: sh
$ svn checkout svn://svn.zope.org/repos/main/zope.schema/trunk zope.schema
The project also mirrors the trunk from the Subversion repository as a
Bazaar branch on Launchpad:
https://code.launchpad.net/zope.schema
You can branch the trunk from there using Bazaar:
.. code-block:: sh
$ bzr branch lp:zope.schema
Running the tests in a ``virtualenv``
-------------------------------------
If you use the ``virtualenv`` package to create lightweight Python
development environments, you can run the tests using nothing more
than the ``python`` binary in a virtualenv. First, create a scratch
environment:
.. code-block:: sh
$ /path/to/virtualenv --no-site-packages /tmp/hack-zope.schema
Next, get this package registered as a "development egg" in the
environment:
.. code-block:: sh
$ /tmp/hack-zope.schema/bin/python setup.py develop
Finally, run the tests using the build-in ``setuptools`` testrunner:
.. code-block:: sh
$ /tmp/hack-zope.schema/bin/python setup.py test
running test
........
----------------------------------------------------------------------
Ran 400 tests in 0.152s
OK
If you have the :mod:`nose` package installed in the virtualenv, you can
use its testrunner too:
.. code-block:: sh
$ /tmp/hack-zope.schema/bin/easy_install nose
...
$ /tmp/hack-zope.schema/bin/python setup.py nosetests
running nosetests
.......
----------------------------------------------------------------------
Ran 400 tests in 0.152s
OK
or:
.. code-block:: sh
$ /tmp/hack-zope.schema/bin/nosetests
.......
----------------------------------------------------------------------
Ran 400 tests in 0.152s
OK
If you have the :mod:`coverage` pacakge installed in the virtualenv,
you can see how well the tests cover the code:
.. code-block:: sh
$ /tmp/hack-zope.schema/bin/easy_install nose coverage
...
$ /tmp/hack-zope.schema/bin/python setup.py nosetests \
--with coverage --cover-package=zope.schema
running nosetests
...
Name Stmts Miss Cover Missing
----------------------------------------------------------------
zope.schema 43 0 100%
zope.schema._bootstrapfields 213 0 100%
zope.schema._bootstrapinterfaces 40 0 100%
zope.schema._compat 4 0 100%
zope.schema._field 425 0 100%
zope.schema._messageid 2 0 100%
zope.schema._schema 45 0 100%
zope.schema.accessors 50 0 100%
zope.schema.fieldproperty 63 0 100%
zope.schema.interfaces 156 0 100%
zope.schema.vocabulary 166 0 100%
----------------------------------------------------------------
TOTAL 1207 0 100%
----------------------------------------------------------------------
Ran 410 tests in 1.677s
OK
Building the documentation in a ``virtualenv``
----------------------------------------------
:mod:`zope.schema` uses the nifty :mod:`Sphinx` documentation system
for building its docs. Using the same virtualenv you set up to run the
tests, you can build the docs:
.. code-block:: sh
$ /tmp/hack-zope.schema/bin/easy_install Sphinx
...
$ bin/sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
...
build succeeded.
You can also test the code snippets in the documentation:
.. code-block:: sh
$ bin/sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
...
Doctest summary
===============
130 tests
0 failures in tests
0 failures in setup code
build succeeded.
Testing of doctests in the sources finished, look at the \
results in _build/doctest/output.txt.
Running the tests using :mod:`zc.buildout`
-------------------------------------------
:mod:`zope.schema` ships with its own :file:`buildout.cfg` file and
:file:`bootstrap.py` for setting up a development buildout:
.. code-block:: sh
$ /path/to/python2.6 bootstrap.py
...
Generated script '.../bin/buildout'
$ bin/buildout
Develop: '/home/tseaver/projects/Zope/BTK/schema/.'
...
Generated script '.../bin/sphinx-quickstart'.
Generated script '.../bin/sphinx-build'.
You can now run the tests:
.. code-block:: sh
$ bin/test --all
Running zope.testing.testrunner.layer.UnitTests tests:
Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
Ran 400 tests with 0 failures and 0 errors in 0.366 seconds.
Tearing down left over layers:
Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
Building the documentation using :mod:`zc.buildout`
---------------------------------------------------
The :mod:`zope.schema` buildout installs the Sphinx scripts required to build
the documentation, including testing its code snippets:
.. code-block:: sh
$ cd docs
$ bin/sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
...
Doctest summary
===============
140 tests
0 failures in tests
0 failures in setup code
build succeeded.
Testing of doctests in the sources finished, look at the results in .../docs/_build/doctest/output.txt.
.../bin/sphinx-build -b html -d .../docs/_build/doctrees .../docs .../docs/_build/html
...
build succeeded.
Running Tests on Multiple Python Versions via :mod:`tox`
--------------------------------------------------------
`tox `_ is a Python-based test automation
tool designed to run tests against multiple Python versions. It creates
a ``virtualenv`` for each configured version, installs the current package
and configured dependencies into each ``virtualenv``, and then runs the
configured commands.
:mod:`zope.schema` configures the following :mod:`tox` environments via
its ``tox.ini`` file:
- The ``py26`` environment builds a ``virtualenv`` with ``python2.6``,
installs :mod:`zope.schema`, and runs the tests
via ``python setup.py test -q``.
- The ``py27`` environment builds a ``virtualenv`` with ``python2.7``,
installs :mod:`zope.schema`, and runs the tests
via ``python setup.py test -q``.
- The ``py32`` environment builds a ``virtualenv`` with ``python3.2``,
installs :mod:`zope.schema` and dependencies, and runs the tests
via ``python setup.py test -q``.
- The ``pypy`` environment builds a ``virtualenv`` with ``pypy``,
installs :mod:`zope.schema`, and runs the tests
via ``python setup.py test -q``.
- The ``coverage`` environment builds a ``virtualenv`` with ``python2.6``,
installs :mod:`zope.schema`, installs
:mod:`nose` and :mod:`coverage`, and runs ``nosetests`` with statement
coverage.
- The ``docs`` environment builds a virtualenv with ``python2.6``, installs
:mod:`zope.schema`, installs ``Sphinx`` and
dependencies, and then builds the docs and exercises the doctest snippets.
This example requires that you have a working ``python2.6`` on your path,
as well as installing ``tox``:
.. code-block:: sh
$ tox -e py26
GLOB sdist-make: .../zope.interface/setup.py
py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
py26 runtests: commands[0]
..........
----------------------------------------------------------------------
Ran 400 tests in 0.152s
OK
___________________________________ summary ____________________________________
py26: commands succeeded
congratulations :)
Running ``tox`` with no arguments runs all the configured environments,
including building the docs and testing their snippets:
.. code-block:: sh
$ tox
GLOB sdist-make: .../zope.interface/setup.py
py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
py26 runtests: commands[0]
...
Doctest summary
===============
140 tests
0 failures in tests
0 failures in setup code
0 failures in cleanup code
build succeeded.
___________________________________ summary ____________________________________
py26: commands succeeded
py27: commands succeeded
py32: commands succeeded
pypy: commands succeeded
coverage: commands succeeded
docs: commands succeeded
congratulations :)
Submitting a Bug Report
-----------------------
:mod:`zope.schema` tracks its bugs on Launchpad:
https://bugs.launchpad.net/zope.schema
Please submit bug reports and feature requests there.
Sharing Your Changes
--------------------
.. note::
Please ensure that all tests are passing before you submit your code.
If possible, your submission should include new tests for new features
or bug fixes, although it is possible that you may have tested your
new code by updating existing tests.
If you got a read-only checkout from the Subversion repository, and you
have made a change you would like to share, the best route is to let
Subversion help you make a patch file:
.. code-block:: sh
$ svn diff > zope.schema-cool_feature.patch
You can then upload that patch file as an attachment to a Launchpad bug
report.
If you branched the code from Launchpad using Bazaar, you have another
option: you can "push" your branch to Launchpad:
.. code-block:: sh
$ bzr push lp:~tseaver/zope.schema/cool_feature
After pushing your branch, you can link it to a bug report on Launchpad,
or request that the maintainers merge your branch using the Launchpad
"merge request" feature.
zope.schema-4.4.2/MANIFEST.in 0000664 0001750 0001750 00000000406 12265302416 016642 0 ustar tseaver tseaver 0000000 0000000 include *.rst
include *.txt
recursive-include docs *
recursive-include src *
global-exclude *.dll
global-exclude *.pyc
global-exclude *.pyo
global-exclude *.so
# added by check_manifest.py
include *.py
include .travis.yml
include buildout.cfg
include tox.ini