plone.registry

Name	plone.registry JSON
Version	2.0.1 JSON
	download
home_page	https://pypi.org/project/plone.registry
Summary	Registry for application settings (like debconf/ about:config)
upload_time	2024-01-22 19:52:32
maintainer
docs_url	None
author	Martin Aspeli, Wichert Akkerman, Hanno Schlichting
requires_python	>=3.8
license	GPL
keywords	configuration registry
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ============
Introduction
============
This package provides debconf-like (or about:config-like) settings registries
for Zope applications. A ``registry``, with a dict-like API, is used to get and
set values stored in ``records``. Each record contains the actual value, as
well as a ``field`` that describes the record in more detail. At a minimum, the
field contains information about the type of value allowed, as well as a short
title describing the record's purpose.

.. contents:: Table of Contents


================
Using registries
================

You can create a new registry simply by instantiating the Registry class.
The class and its data structures are persistent, so you can store them in the ZODB.
You may want to provide the registry object as local utility for easy access as well, though we won't do that here.

::

    >>> from plone.registry import Registry
    >>> registry = Registry()

The registry starts out empty.
To access the registry's records, you can use the ``records`` property.
This exposes a dict API where keys are strings and values are objects providing ``IRecords``.

::

    >>> len(registry.records)
    0

Simple records
==============

Let's now create a record.
A record must have a name.
This should be a dotted name, and contain ASCII characters only.
By convention, it should be all lowercase and start with the name of the package that defines the record.

It is also possible to create a  number of records based on a single schema interface - see below.
For now, we will focus on simple records.

Before we can create the record, we must create the field that describes it.
Fields are based on the venerable ``zope.schema`` package.
``plone.registry`` only supports certain fields, and disallows use of a few properties even of those.
As a rule of thumb, so long as a field stores a Python primitive, it is supported; the same goes for attributes of fields.

Thus:

* Fields like ``Object``, ``InterfaceField`` and so on are *not* supported.
* A custom ``constraint`` method is *not* supported.
* The ``order`` attribute will *always* be set to ``-1``.
* For Choice fields, *only named vocabularies* are supported:
  you can *not* reference a particular *source* or *source binder*.
* The ``key_type`` and ``value_type`` properties of ``Dict``, ``List``, ``Tuple``, ``Set`` and ``Frozenset`` may *only* contain persistent fields.

See section "Persistent fields" for more details.

Creating a record
-----------------

The supported field types are found in the module ``plone.registry.field``.
These are named the same as the equivalent field in ``zope.schema``, and have the same constructors.
You must use one of these fields when creating records directly::

    >>> from plone.registry import field
    >>> age_field = field.Int(title=u"Age", min=0, default=18)

    >>> from plone.registry import Record
    >>> age_record = Record(age_field)

Note that in this case, we did not supply a value.
The value will therefore be the field default::

    >>> age_record.value
    18

We can set a different value, either in the ``Record`` constructor or via the ``value`` attribute::

    >>> age_record.value = 2
    >>> age_record.value
    2

Note that the value is validated against the field::

    >>> age_record.value = -1
    Traceback (most recent call last):
    ...
    zope.schema._bootstrapinterfaces.TooSmall: (-1, 0)

    >>> age_record.value
    2

We can now add the field to the registry.
This is done via the ``record`` dictionary::

    >>> 'plone.registry.tests.age' in registry
    False
    >>> registry.records['plone.registry.tests.age'] = age_record

At this point, the record will gain ``__name__`` and ``__parent__`` attributes::

    >>> age_record.__name__
    'plone.registry.tests.age'

    >>> age_record.__parent__ is registry
    True

Creating a record with an initial value
---------------------------------------

We can create records more succinctly in *one go* by

1. creating the field,
2. creating the Record and setting its value as and
3. assigning it to the registry,

like this::

    >>> registry.records['plone.registry.tests.cms'] = \
    ...     Record(field.TextLine(title=u"CMS of choice"), u"Plone")

The record can now be obtained.
Note that it has a nice ``__repr__`` to help debugging.

    >>> registry.records['plone.registry.tests.cms']
    <Record plone.registry.tests.cms>

Accessing and manipulating record values
----------------------------------------

Once a record has been created and added to the registry,
you can access its value through dict-like operations on the registry itself::

    >>> 'plone.registry.tests.cms' in registry
    True

    >>> registry['plone.registry.tests.cms']  # doctest: +IGNORE_U
    u'Plone'

    >>> registry['plone.registry.tests.cms'] = u"Plone 3.x"

Again, values are validated::

    >>> registry['plone.registry.tests.cms'] = b'Joomla'
    Traceback (most recent call last):
    ...
    zope.schema._bootstrapinterfaces.WrongType: (b'Joomla', <class 'str'>, 'value')

There is also a ``get()`` method::

    >>> registry.get('plone.registry.tests.cms')  # doctest: +IGNORE_U
    u'Plone 3.x'
    >>> registry.get('non-existent-key') is None
    True

Deleting records
----------------

Records may be deleted from the ``records`` property::

    >>> del registry.records['plone.registry.tests.cms']
    >>> 'plone.registry.tests.cms' in registry.records
    False
    >>> 'plone.registry.tests.cms' in registry
    False

Creating records from interfaces
================================

As an application developer, it is often desirable to define settings as traditional interfaces with ``zope.schema fields``.
``plone.registry`` includes support for creating a set of records from a single interface.

To test this, we have created an interface, ``IMailSettings``.
It has two fields: ``sender`` and ``smtp_host``::

    >>> from plone.registry.tests import IMailSettings

Note that this contains standard fields::

    >>> IMailSettings['sender']
    <zope.schema._bootstrapfields.TextLine object at ...>

    >>> IMailSettings['smtp_host']
    <zope.schema._field.URI object at ...>

We can create records from this interface like this::

    >>> registry.registerInterface(IMailSettings)

One record for each field in the interface has now been created.
Their names are the full dotted names to those fields::

    >>> sender_record = registry.records['plone.registry.tests.IMailSettings.sender']
    >>> smtp_host_record = registry.records['plone.registry.tests.IMailSettings.smtp_host']

The fields used in the records will be the equivalent persistent versions of the fields from the original interface::

    >>> sender_record.field
    <plone.registry.field.TextLine object at ...>

    >>> smtp_host_record.field
    <plone.registry.field.URI object at ...>

This feat is accomplished internally by adapting the field to the ``IPersistentField`` interface.
There is a default adapter factory that works for all fields defined in ``plone.registry.field``.
You can of course define your own adapter if you have a custom field type.
But bear in mind the golden rules of any persistent field::

* The field must store only primitives or other persistent fields
* It must not reference a function, class, interface or other method that could break if a package is uninstalled.

If we have a field for which there is no ``IPersistentField`` adapter, we will get an error::

    >>> from plone.registry.tests import IMailPreferences
    >>> IMailPreferences['settings']
    <zope.schema._bootstrapfields.Object object at ...>

    >>> registry.registerInterface(IMailPreferences)
    Traceback (most recent call last):
    ...
    TypeError: There is no persistent field equivalent for the field `settings` of type `Object`.

Whoops!
We can, however, tell ``registerInterface()`` to ignore one or more fields::

    >>> registry.registerInterface(IMailPreferences, omit=('settings',))

Once an interface's records have been registered, we can get and set their values as normal::

    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U
    u'root@localhost'

    >>> registry['plone.registry.tests.IMailSettings.sender'] = u"webmaster@localhost"
    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U
    u'webmaster@localhost'

If we sub-sequently re-register the same interface, the value will be retained if possible::

    >>> registry.registerInterface(IMailSettings)
    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U
    u'webmaster@localhost'

However, if the value is no longer valid, we will revert to the default.
To test that, let's sneakily modify the field for a while::

    >>> old_field = IMailSettings['sender']
    >>> IMailSettings._InterfaceClass__attrs['sender'] = field.Int(title=u"Definitely not a string", default=2)
    >>> if hasattr(IMailSettings, '_v_attrs'):
    ...     del IMailSettings._v_attrs['sender']
    >>> registry.registerInterface(IMailSettings)
    >>> registry['plone.registry.tests.IMailSettings.sender']
    2

But let's put it back the way it was::

    >>> IMailSettings._InterfaceClass__attrs['sender'] = old_field
    >>> if hasattr(IMailSettings, '_v_attrs'):
    ...     del IMailSettings._v_attrs['sender']
    >>> registry.registerInterface(IMailSettings)
    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U
    u'root@localhost'

Sometimes, you may want to use an interface as a template for multiple instances of a set of fields, rather than defining them all by hand.
This is especially useful when you want to allow third-party packages to provide information.
To accomplish this, we can provide a prefix with the ``registerInterface`` call.
This will take precedence over the ``__identifier__`` that is usually used.

    >>> registry.registerInterface(IMailSettings, prefix="plone.registry.tests.alternativesettings")

These values are now available in the same way as the original settings::

    >>> sender_record = registry.records['plone.registry.tests.alternativesettings.sender']
    >>> smtp_host_record = registry.records['plone.registry.tests.alternativesettings.smtp_host']
    >>> registry['plone.registry.tests.alternativesettings.sender'] = u'alt@example.org'

Accessing the original interface
--------------------------------

Now that we have these records, we can look up the original interface.
This does not break the golden rules:
internally, we only store the name of the interface, and resolve it at runtime.

Records that know about interfaces are marked with ``IInterfaceAwareRecord`` and have two additional properties:
``interface`` and ``fieldName``::

    >>> from plone.registry.interfaces import IInterfaceAwareRecord
    >>> IInterfaceAwareRecord.providedBy(age_record)
    False
    >>> IInterfaceAwareRecord.providedBy(sender_record)
    True

    >>> sender_record.interfaceName
    'plone.registry.tests.IMailSettings'

    >>> sender_record.interface is IMailSettings
    True

Using the records proxy
-----------------------

Once the records for an interface has been created, it is possible to obtain a proxy object that provides the given interface, but reads and writes its values to the registry.
This is useful, for example, to create a form using ``zope.formlib`` or  ``z3c.form`` that is configured with widgets based on the
interface.
Or simply as a more convenient API when working with multiple, related settings.

::

    >>> proxy = registry.forInterface(IMailSettings)
    >>> proxy
    <RecordsProxy for plone.registry.tests.IMailSettings>

If you use your registry values in code which might be encountered on normal HTML rendering paths (e.g. in a viewlet) you need to be aware that records might not exist or they are invalid.
``forInterface()`` will raise KeyError on this kind of situations::

    try:
        proxy = registry.forInterface(IMailSettings)
    except KeyError:
        # Gracefully handled cases
        # when GenericSetup installer has not been run or rerun
        # e.g. by returning or using some default values
        pass

The proxy is not a persistent object on its own::

    >>> from persistent.interfaces import IPersistent
    >>> IPersistent.providedBy(proxy)
    False

It does, however, provide the requisite interface::

    >>> IMailSettings.providedBy(proxy)
    True

You can distinguish between the proxy and a 'normal' object by checking for the ``IRecordsProxy`` marker interface::

    >>> from plone.registry.interfaces import IRecordsProxy
    >>> IRecordsProxy.providedBy(proxy)
    True

When we set a value, it is stored in the registry::

    >>> proxy.smtp_host = 'http://mail.server.com'
    >>> registry['plone.registry.tests.IMailSettings.smtp_host']
    'http://mail.server.com'

    >>> registry['plone.registry.tests.IMailSettings.smtp_host'] = 'smtp://mail.server.com'
    >>> proxy.smtp_host
    'smtp://mail.server.com'

Values not in the interface will raise an ``AttributeError``::

    >>> proxy.age
    Traceback (most recent call last):
    ...
    AttributeError: age

Note that by default, the forInterface() method will check that the necessary records have been registered.
For example, we cannot use any old interface::

    >>> registry.forInterface(IInterfaceAwareRecord)
    Traceback (most recent call last):
    ...
    KeyError: 'Interface `plone.registry.interfaces.IInterfaceAwareRecord` defines a field `...`, for which there is no record.'

By default, we also cannot use an interface for which only some records exist::

    >>> registry.forInterface(IMailPreferences)
    Traceback (most recent call last):
    ...
    KeyError: 'Interface `plone.registry.tests.IMailPreferences` defines a field `settings`, for which there is no record.'

It is possible to disable this check, however.
This will be a bit more efficient::

    >>> registry.forInterface(IMailPreferences, check=False)
    <RecordsProxy for plone.registry.tests.IMailPreferences>

A better way, however, is to explicitly declare that some fields are omitted::

    >>> pref_proxy = registry.forInterface(IMailPreferences, omit=('settings',))

In this case, the omitted fields will default to their 'missing' value::

    >>> pref_proxy.settings ==  IMailPreferences['settings'].missing_value
    True

However, trying to set the value will result in a ``AttributeError``::

    >>> pref_proxy.settings = None
    Traceback (most recent call last):
    ...
    AttributeError: settings

To access another instance of the field, supply the prefix::

    >>> alt_proxy = registry.forInterface(IMailSettings,
    ...     prefix="plone.registry.tests.alternativesettings")
    >>> alt_proxy.sender  # doctest: +IGNORE_U
    u'alt@example.org'

Collections of records proxies
------------------------------

A collection of record sets may be accessed using ``collectionOfInterface``::

    >>> collection = registry.collectionOfInterface(IMailSettings)

You can create a new record set::

    >>> proxy = collection.setdefault('example')
    >>> proxy.sender = u'collection@example.org'
    >>> proxy.smtp_host = 'smtp://mail.example.org'

Record sets are stored based under the prefix::

    >>> prefix = IMailSettings.__identifier__
    >>> registry.records.values(prefix+'/', prefix+'0')
    [<Record plone.registry.tests.IMailSettings/example.sender>,
     <Record plone.registry.tests.IMailSettings/example.smtp_host>]
    >>> registry['plone.registry.tests.IMailSettings/example.sender']  # doctest: +IGNORE_U
    u'collection@example.org'

Records may be set from an existing object::

    >>> class MailSettings:
    ...     sender = u'someone@example.com'
    ...     smtp_host = 'smtp://mail.example.com'
    >>> collection['example_com'] = MailSettings()
    >>> registry.records.values(prefix+'/', prefix+'0')
    [<Record plone.registry.tests.IMailSettings/example.sender>,
     <Record plone.registry.tests.IMailSettings/example.smtp_host>,
     <Record plone.registry.tests.IMailSettings/example_com.sender>,
     <Record plone.registry.tests.IMailSettings/example_com.smtp_host>]

The collection may be iterated over::

    >>> for name in collection: print(name)
    example
    example_com

And may be deleted::

    >>> del collection['example_com']
    >>> registry.records.values(prefix+'/', prefix+'0')
    [<Record plone.registry.tests.IMailSettings/example.sender>,
     <Record plone.registry.tests.IMailSettings/example.smtp_host>]

Using field references
======================

It is possible for one record to refer to another record's field.
This can be used to provide a simple "override" mechanism,
for example, where one record defines the field and a default value,
whilst another provides an override validated against the same field.

Let us first create the base record and set its value::

    >>> timeout_field = field.Int(title=u"Timeout", min=0)
    >>> registry.records['plone.registry.tests.timeout'] = Record(timeout_field, 10)

    >>> timeout_record = registry.records['plone.registry.tests.timeout']
    >>> timeout_record.value
    10

Next, we create a field reference for this record::

    >>> from plone.registry import FieldRef
    >>> timeout_override_field = FieldRef(timeout_record.__name__, timeout_record.field)

We can use this to create a new record::

    >>> registry.records['plone.registry.tests.timeout.override'] = Record(timeout_override_field, 20)
    >>> timeout_override_record = registry.records['plone.registry.tests.timeout.override']

The two values are separate::

    >>> timeout_record.value
    10
    >>> timeout_override_record.value
    20

    >>> registry['plone.registry.tests.timeout']
    10
    >>> registry['plone.registry.tests.timeout.override']
    20

Validation uses the underlying field::

    >>> registry['plone.registry.tests.timeout.override'] = -1
    Traceback (most recent call last):
    ...
    zope.schema._bootstrapinterfaces.TooSmall: (-1, 0)

The reference field exposes the standard field properties, e.g.::

    >>> timeout_override_record.field.title
    'Timeout'
    >>> timeout_override_record.field.min
    0

To look up the underlying record name, we can use the ``recordName`` property::

    >>> timeout_override_record.field.recordName
    'plone.registry.tests.timeout'


===============
Registry events
===============

The registry fires certain events. These are:

``plone.registry.interfaces.IRecordAddedEvent``
    when a record has been added to the registry.

``plone.registry.interfaces.IRecordRemovedEvent``
    when a record has been removed from the registry.

``plone.registry.interfaces.IRecordModifiedEvent``,
    when a record's value is modified.

To test these events, we will create, modify and remove a few records::

    >>> from zope.component.eventtesting import clearEvents
    >>> clearEvents()
    >>> from plone.registry import Registry, Record, field
    >>> registry = Registry()

Adding a new record to the registry should fire ``IRecordAddedEvents``::

    >>> registry.records['plone.registry.tests.age'] = \
    ...     Record(field.Int(title=u"Age", min=0, default=18))

    >>> registry.records['plone.registry.tests.cms'] = \
    ...     Record(field.TextLine(title=u"Preferred CMS"), value=u"Plone")

When creating records from an interface, one event is fired for each field in the interface::

    >>> from plone.registry.tests import IMailSettings
    >>> registry.registerInterface(IMailSettings)

Deleting a record should fire an ``IRecordRemovedEvent``::

    >>> del registry.records['plone.registry.tests.cms']

Changing a record should fire an ``IRecordModifiedEvent``::

    >>> registry['plone.registry.tests.age'] = 25
    >>> registry.records['plone.registry.tests.age'].value = 24

Let's take a look at the events that were just fired::

    >>> from plone.registry.interfaces import IRecordEvent
    >>> from zope.component.eventtesting import getEvents
    >>> getEvents(IRecordEvent)
    [<RecordAddedEvent for plone.registry.tests.age>,
     <RecordAddedEvent for plone.registry.tests.cms>,
     <RecordAddedEvent for plone.registry.tests.IMailSettings.sender>,
     <RecordAddedEvent for plone.registry.tests.IMailSettings.smtp_host>,
     <RecordRemovedEvent for plone.registry.tests.cms>,
     <RecordModifiedEvent for plone.registry.tests.age>,
     <RecordModifiedEvent for plone.registry.tests.age>]

For the modified events, we can also check the value before and after the change::

    >>> from plone.registry.interfaces import IRecordModifiedEvent
    >>> [(repr(e), e.oldValue, e.newValue,) for e in getEvents(IRecordModifiedEvent)]
    [('<RecordModifiedEvent for plone.registry.tests.age>', 18, 25),
     ('<RecordModifiedEvent for plone.registry.tests.age>', 25, 24)]

IObjectEvent-style redispatchers
================================

There is a special event handler.
It takes care of re-dispatching registry events based on the schema interface prescribed by the record.

Let's re-set the event testing framework and register the re-dispatching event subscriber.
Normally, this would happen automatically by including this package's ZCML.

::

    >>> clearEvents()
    >>> from zope.component import provideHandler
    >>> from plone.registry.events import redispatchInterfaceAwareRecordEvents
    >>> provideHandler(redispatchInterfaceAwareRecordEvents)

We'll then register a schema interface::

    >>> from plone.registry.tests import IMailSettings
    >>> registry.registerInterface(IMailSettings)

We could now register an event handler to print any record event occurring on an ``IMailSettings`` record.
More specialised event handlers for e.g. ``IRecordModifiedEvent`` or ``IRecordRemovedEvent`` are of course also possible.
Note that it is not possible to re-dispatch ``IRecordAddedEvents``, so these are never caught.

    >>> from zope.component import adapter
    >>> @adapter(IMailSettings, IRecordEvent)
    ... def print_mail_settings_events(proxy, event):
    ...     print("Got %s for %s" % (event, proxy))
    >>> provideHandler(print_mail_settings_events)

Let's now modify one of the records for this interface.
The event handler should react immediately::

    >>> registry['plone.registry.tests.IMailSettings.sender'] = u"Some sender"
    Got <RecordModifiedEvent for plone.registry.tests.IMailSettings.sender> for <RecordsProxy for plone.registry.tests.IMailSettings>

Let's also modify a non-interface-aware record, for comparison's sake.
Here, there is nothing printed::

    >>> registry['plone.registry.tests.age'] = 3

We can try a record-removed event as well::

    >>> del registry.records['plone.registry.tests.IMailSettings.sender']
    Got <RecordRemovedEvent for plone.registry.tests.IMailSettings.sender> for <RecordsProxy for plone.registry.tests.IMailSettings>

The basic events that have been dispatched are::

    >>> getEvents(IRecordEvent)
    [<RecordAddedEvent for plone.registry.tests.IMailSettings.sender>,
     <RecordAddedEvent for plone.registry.tests.IMailSettings.smtp_host>,
     <RecordModifiedEvent for plone.registry.tests.IMailSettings.sender>,
     <RecordModifiedEvent for plone.registry.tests.age>,
     <RecordRemovedEvent for plone.registry.tests.IMailSettings.sender>]


=================
Persistent fields
=================

The persistent fields that are found in ``plone.registry.field`` are siblings of the ones found in zope.schema,
with persistence mixed in.
To avoid potentially breaking the registry with persistent references to symbols that may go away,
we purposefully limit the number of fields supported.
We also disallow some properties, and add some additional checks on others.

The standard fields
===================

We will show each supported field in turn. For all fields, note that:

* the ``order`` property will return ``-1`` no matter what setting the ``constraint`` property is diallowed
* the ``key_type`` and ``value_type`` properties, where applicable, must be set to a persistent field.
* for ``Choice`` fields, only named vocabularies and vocabularies based on simple values are supported:
  sources and ``IVocabulary`` objects are not.

Imports needed::

    >>> from plone.registry import field
    >>> from zope import schema
    >>> from persistent import Persistent

Bytes
-----

The bytes field describes a string of bytes::

    >>> f = field.Bytes(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.Bytes)
    True

    >>> f.order
    -1

    >>> field.Bytes(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint('ABC')
    True

BytesLine
---------

The bytes field describes a string of bytes, disallowing newlines::

    >>> f = field.BytesLine(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.BytesLine)
    True

    >>> f.order
    -1

    >>> field.BytesLine(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(b'AB\nC')
    False

ASCII
-----

The ASCII field describes a string containing only ASCII characters::

    >>> f = field.ASCII(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.ASCII)
    True

    >>> f.order
    -1

    >>> field.ASCII(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint('ab\nc')
    True

ASCIILine
---------

The ASCII line field describes a string containing only ASCII characters and disallowing newlines::

    >>> f = field.ASCIILine(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.ASCIILine)
    True

    >>> f.order
    -1

    >>> field.ASCIILine(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint('ab\nc')
    False

Text
----

The text field describes a unicode string::

    >>> f = field.Text(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.Text)
    True

    >>> f.order
    -1

    >>> field.Text(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(u'ab\nc')
    True

TextLine
--------

The text line field describes a unicode string, disallowing newlines::

    >>> f = field.TextLine(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.TextLine)
    True

    >>> f.order
    -1

    >>> field.TextLine(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(u'ab\nc')
    False

Bool
----

The bool field describes a boolean::

    >>> f = field.Bool(title=u"Test")
    >>> isinstance(f, schema.Bool)
    True

    >>> f.order
    -1

    >>> field.Bool(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(False)
    True

Int
---

The int field describes an integer or long::

    >>> f = field.Int(title=u"Test", min=-123, max=1234)
    >>> isinstance(f, schema.Int)
    True

    >>> f.order
    -1

    >>> field.Int(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(123)
    True

Float
-----

The float field describes a float::

    >>> f = field.Float(title=u"Test", min=-123.0, max=1234.0)
    >>> isinstance(f, schema.Float)
    True

    >>> f.order
    -1

    >>> field.Float(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(123)
    True

Decimal
-------

The decimal field describes a decimal::

    >>> import decimal
    >>> f = field.Decimal(title=u"Test", min=decimal.Decimal('-123.0'), max=decimal.Decimal('1234.0'))
    >>> isinstance(f, schema.Decimal)
    True

    >>> f.order
    -1

    >>> field.Decimal(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(123)
    True

Password
--------

The password field describes a unicode string used for a password::

    >>> f = field.Password(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.Password)
    True

    >>> f.order
    -1

    >>> field.Password(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(u'ab\nc')
    False

SourceText
----------

The source  text field describes a unicode string with source code::

    >>> f = field.SourceText(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.SourceText)
    True

    >>> f.order
    -1

    >>> field.SourceText(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(u'ab\nc')
    True

URI
---

The URI field describes a URI string::

    >>> f = field.URI(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.URI)
    True

    >>> f.order
    -1

    >>> field.URI(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(u'abc')
    True

Id
--

The id field describes a URI string or a dotted name::

    >>> f = field.Id(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.Id)
    True

    >>> f.order
    -1

    >>> field.Id(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(u'abc')
    True

DottedName
----------

The dotted name field describes a Python dotted name::

    >>> f = field.DottedName(title=u"Test", min_length=0, max_length=10)
    >>> isinstance(f, schema.DottedName)
    True

    >>> f.order
    -1

    >>> field.DottedName(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(u'abc')
    True

Datetime
--------

The date/time field describes a Python datetime object::

    >>> f = field.Datetime(title=u"Test")
    >>> isinstance(f, schema.Datetime)
    True

    >>> f.order
    -1

    >>> field.Datetime(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> import datetime
    >>> f.constraint(datetime.datetime.now())
    True

Date
----

The date field describes a Python date object::

    >>> f = field.Date(title=u"Test")
    >>> isinstance(f, schema.Date)
    True

    >>> f.order
    -1

    >>> field.Date(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> import datetime
    >>> f.constraint(datetime.date.today())
    True

Timedelta
---------

The time-delta field describes a Python timedelta object::

    >>> f = field.Timedelta(title=u"Test")
    >>> isinstance(f, schema.Timedelta)
    True

    >>> f.order
    -1

    >>> field.Timedelta(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> import datetime
    >>> f.constraint(datetime.timedelta(1))
    True

Tuple
-----

The tuple field describes a tuple::

    >>> f = field.Tuple(title=u"Test", min_length=0, max_length=10,
    ...     value_type=field.TextLine(title=u"Value"))
    >>> isinstance(f, schema.Tuple)
    True

    >>> f.order
    -1

    >>> field.Tuple(title=u"Test", min_length=0, max_length=10,
    ...     value_type=schema.TextLine(title=u"Value"))
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> f.value_type = schema.TextLine(title=u"Value")
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> field.Tuple(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint((1,2))
    True

List
----

The list field describes a tuple::

    >>> f = field.List(title=u"Test", min_length=0, max_length=10,
    ...     value_type=field.TextLine(title=u"Value"))
    >>> isinstance(f, schema.List)
    True

    >>> f.order
    -1

    >>> field.List(title=u"Test", min_length=0, max_length=10,
    ...     value_type=schema.TextLine(title=u"Value"))
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> f.value_type = schema.TextLine(title=u"Value")
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> field.List(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint([1,2])
    True

Set
---

The set field describes a set::

    >>> f = field.Set(title=u"Test", min_length=0, max_length=10,
    ...     value_type=field.TextLine(title=u"Value"))
    >>> isinstance(f, schema.Set)
    True

    >>> f.order
    -1

    >>> field.Set(title=u"Test", min_length=0, max_length=10,
    ...     value_type=schema.TextLine(title=u"Value"))
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> f.value_type = schema.TextLine(title=u"Value")
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> field.Set(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(set([1,2]))
    True

Frozenset
---------

The set field describes a frozenset::

    >>> f = field.FrozenSet(title=u"Test", min_length=0, max_length=10,
    ...     value_type=field.TextLine(title=u"Value"))
    >>> isinstance(f, schema.FrozenSet)
    True

    >>> f.order
    -1

    >>> field.FrozenSet(title=u"Test", min_length=0, max_length=10,
    ...     value_type=schema.TextLine(title=u"Value"))
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> f.value_type = schema.TextLine(title=u"Value")
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> field.FrozenSet(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(frozenset([1,2]))
    True

Dict
----

The set field describes a dict::

    >>> f = field.Dict(title=u"Test", min_length=0, max_length=10,
    ...     key_type=field.ASCII(title=u"Key"),
    ...     value_type=field.TextLine(title=u"Value"))
    >>> isinstance(f, schema.Dict)
    True

    >>> f.order
    -1

    >>> field.Dict(title=u"Test", min_length=0, max_length=10,
    ...     key_type=schema.ASCII(title=u"Key"),
    ...     value_type=field.TextLine(title=u"Value"))
    Traceback (most recent call last):
    ...
    ValueError: The property `key_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> f.key_type = schema.ASCII(title=u"Key")
    Traceback (most recent call last):
    ...
    ValueError: The property `key_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> field.Dict(title=u"Test", min_length=0, max_length=10,
    ...     key_type=field.ASCII(title=u"Key"),
    ...     value_type=schema.TextLine(title=u"Value"))
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> f.value_type = schema.TextLine(title=u"Value")
    Traceback (most recent call last):
    ...
    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.

    >>> field.Dict(title=u"Test", constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint(dict())
    True

Choice
------

A choice field represents a selection from a vocabulary.
For persistent fields, the vocabulary cannot be a ``source`` or any kind of object:
it must either be a list of primitives, or a named vocabulary::

    >>> f = field.Choice(title=u"Test", values=[1,2,3])
    >>> isinstance(f, schema.Choice)
    True

    >>> f.order
    -1

With a list of values given, the ``vocabulary`` property returns a vocabulary
constructed from the values on the fly, and ``vocabularyName`` is ``None``::

    >>> f.vocabulary
    <zope.schema.vocabulary.SimpleVocabulary object at ...>

    >>> f.vocabularyName is None
    True

We will get an error if we use anything other than primitives::

    >>> f = field.Choice(title=u"Test", values=[object(), object()])
    Traceback (most recent call last):
    ...
    ValueError: Vocabulary values may only contain primitive values.

If a vocabulary name given, it is stored in ``vocabularyName``, and the ``vocabulary`` property returns ``None``::

    >>> f = field.Choice(title=u"Test", vocabulary='my.vocab')
    >>> f.vocabulary is None
    True

    >>> f.vocabularyName
    'my.vocab'

Other combinations are now allowed, such as specifying no vocabulary::

    >>> field.Choice(title=u"Test")
    Traceback (most recent call last):
    ...
    AssertionError: You must specify either values or vocabulary.

Or specifying both types::

    >>> field.Choice(title=u"Test", values=[1,2,3], vocabulary='my.vocab')
    Traceback (most recent call last):
    ...
    AssertionError: You cannot specify both values and vocabulary.

Or specifying an object source::

    >>> from zope.schema.vocabulary import SimpleVocabulary
    >>> dummy_vocabulary = SimpleVocabulary.fromValues([1,2,3])
    >>> field.Choice(title=u"Test", source=dummy_vocabulary)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields do not support sources, only named vocabularies or vocabularies based on simple value sets.

Or specifying an object vocabulary::

    >>> field.Choice(title=u"Test", vocabulary=dummy_vocabulary)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields only support named vocabularies or vocabularies based on simple value sets.

As with other fields, you also cannot set a constraint::

    >>> field.Choice(title=u"Test", values=[1,2,3], constraint=lambda x: True)
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint = lambda x: False
    Traceback (most recent call last):
    ...
    ValueError: Persistent fields does not support setting the `constraint` property

    >>> f.constraint('ABC')
    True

JSONField
---------

The set field describes a JSONField::

    >>> import plone.schema
    >>> f = field.JSONField(title=u"Test")
    >>> isinstance(f, plone.schema.JSONField)
    True

    >>> f.order
    -1

``IPersistentField`` adapters
=============================

It is possible to adapt any non-persistent field to its related ``IPersistentField`` using the adapter factories in ``plone.registry`` fieldfactory.
These are set up in ``configure.zcml`` and explicitly registered in the test setup in ``tests.py``.
Custom adapters are of course also possible::

    >>> from plone.registry.interfaces import IPersistentField

    >>> f = schema.TextLine(title=u"Test")
    >>> IPersistentField.providedBy(f)
    False

    >>> p = IPersistentField(f)
    >>> IPersistentField.providedBy(p)
    True

    >>> isinstance(p, field.TextLine)
    True

Unsupported field types will not be adaptable by default::

    >>> f = schema.Object(title=u"Object", schema=IPersistentField)
    >>> IPersistentField(f, None) is None
    True

    >>> f = schema.InterfaceField(title=u"Interface")
    >>> IPersistentField(f, None) is None
    True

After adaptation, the rules of persistent fields apply:
The ``order`` attribute is perpetually ``-1``.
Custom constraints are not allowed, and key and value type will be adapted to persistent fields as well.
If any of these constraints can not be met, the adaptation will fail.

For constraints, the non-persistent value is simply ignored and the default method from the class will be used.

::

    >>> f = schema.TextLine(title=u"Test", constraint=lambda x: False)
    >>> f.constraint
    <function <lambda> at ...>

    >>> p = IPersistentField(f)
    >>> p.constraint
    <bound method TextLine.constraint of <plone.registry.field.TextLine object at ...>>

The order property is similarly ignored::

    >>> f.order > 0
    True

    >>> p.order
    -1

Key/value types will be adapted if possible::

    >>> f = schema.Dict(title=u"Test",
    ...     key_type=schema.Id(title=u"Id"),
    ...     value_type=schema.TextLine(title=u"Value"))
    >>> p = IPersistentField(f)
    >>> p.key_type
    <plone.registry.field.Id object at ...>

    >>> p.value_type
    <plone.registry.field.TextLine object at ...>

If they cannot be adapted, there will be an error::

    >>> f = schema.Dict(title=u"Test",
    ...     key_type=schema.Id(title=u"Id"),
    ...     value_type=schema.Object(title=u"Value", schema=IPersistentField))
    >>> p = IPersistentField(f)
    Traceback (most recent call last):
    ...
    TypeError: ('Could not adapt', <zope.schema._field.Dict object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)

    >>> f = schema.Dict(title=u"Test",
    ...     key_type=schema.InterfaceField(title=u"Id"),
    ...     value_type=schema.TextLine(title=u"Value"))
    >>> p = IPersistentField(f)
    Traceback (most recent call last):
    ...
    TypeError: ('Could not adapt', <zope.schema._field.Dict object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)

There is additional validation for choice fields that warrant a custom adapter.
These ensure that vocabularies are either stored as a list of simple values, or as named vocabularies.

::

    >>> f = schema.Choice(title=u"Test", values=[1,2,3])
    >>> p = IPersistentField(f)
    >>> p.vocabulary
    <zope.schema.vocabulary.SimpleVocabulary object at ...>
    >>> p._values
    [1, 2, 3]
    >>> p.vocabularyName is None
    True

    >>> f = schema.Choice(title=u"Test", vocabulary='my.vocab')
    >>> p = IPersistentField(f)
    >>> p.vocabulary is None
    True
    >>> p._values is None
    True
    >>> p.vocabularyName
    'my.vocab'

Complex vocabularies or sources are not allowed::

    >>> from zope.schema.vocabulary import SimpleVocabulary
    >>> dummy_vocabulary = SimpleVocabulary.fromItems([('a', 1), ('b', 2)])
    >>> f = schema.Choice(title=u"Test", source=dummy_vocabulary)
    >>> p = IPersistentField(f)
    Traceback (most recent call last):
    ...
    TypeError: ('Could not adapt', <zope.schema._field.Choice object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)


    >>> f = schema.Choice(title=u"Test", vocabulary=dummy_vocabulary)
    >>> p = IPersistentField(f)
    Traceback (most recent call last):
    ...
    TypeError: ('Could not adapt', <zope.schema._field.Choice object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)

Changelog
=========


.. You should *NOT* be adding new change log entries to this file.
   You should create a file in the news directory instead.
   For helpful instructions, please see:
   https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst

.. towncrier release notes start

2.0.1 (2024-01-22)
------------------

Internal:


- Update configuration files.
  [plone devs] (6e36bcc4, 7723aeaf)


2.0.0 (2023-04-26)
------------------

Breaking changes:


- Drop python 2.7 compatibility.
  [gforcada] (#1)


Internal:


- Update configuration files.
  [plone devs] (a864b30f)


1.2.1 (2021-06-14)
------------------

Bug fixes:


- Fix registry key validation regexp.
  [jensens] (#23)


1.2.0 (2021-04-23)
------------------

New features:


- Allow plone.schema.JSONField be stored in registry (as dict-like)
   [sneridagh] (#719)


1.1.6 (2020-04-22)
------------------

Bug fixes:


- Minor packaging updates. (#1)


1.1.5 (2018-12-14)
------------------

Bug fixes:

- Avoid a deprecation warning that would turn into an error on Python 3.8.
  [gforcada]


1.1.4 (2018-11-04)
------------------

Bug fixes:

- Adapt test to changed object field in zope4
  [pbauer]


1.1.3 (2018-06-22)
------------------

Bug fixes:

- Improve performance of RecordsProxy.__iter__ which is now invoked more in
  core Plone as part of the requireJS configuration
  [MatthewWilkes]


1.1.2 (2016-12-06)
------------------

Bug fixes:

- Fix tests to pass on Python 3.5
  [datakurre]


1.1.1 (2016-11-19)
------------------

Bug fixes:

- Fix endless recursion on getting values from broken records proxy objects
  [tomgross]


1.1.0 (2016-07-05)
------------------

New features:

- Give ``RecordsProxy`` a ``__parent__`` (the registry) in order to make it a good Zope citizen.
  This helps in context of z3cform binders and other similar situations,
  where a records proxy is used as context.
  [jensens]


1.0.4 (2016-06-12)
------------------

Fixes:

- More cleanup: PEP8, isort, readability.
  [jensens]


1.0.3 (2016-02-26)
------------------

Fixes:

- Replace deprecated ``zope.testing.doctestunit`` import with ``doctest``
  module from stdlib.
  [thet]

- Cleanup: Pep8, utf8 headers, whitespace fixes, readability, ReST-fixes,
  doc-style, etc.
  [jensens]


1.0.2 (2014-09-11)
------------------

- Choice field construction compatible with a simple vocabulary of
  string-based choices, which are converted to values on construction.
  This provides compatibility for plone.registry/plone.app.registry
  integration with plone.supermodel >= 1.2.5.
  [seanupton]


1.0.1 (2013-01-13)
------------------

1.0 - 2011-05-13
----------------

- Release 1.0 Final
  [esteele]

- Add MANIFEST.in.
  [WouterVH]


1.0b5 - 2011-04-06
------------------

- Make RecordsProxy type customizable through ``factory`` argument to
  ``forInterface`` and ``collectionOfInterface``.
  [elro]

- Add ``collectionOfInterface`` support to registry.
  [elro]

- Fixed bug where prefix was ignored by registry.forInterface.
  [elro]

- Add optional min, max arguments for keys/values/items of _Records.
  [elro]


1.0b4 - 2011-02-04
------------------

- Added support for field references, via the ``FieldRef`` class. See
  ``registry.txt`` for details.
  [optilude]

- Change the internal persistent structure around to make it more efficient.
  The API remains the same. Old registries will be migrated when first
  accessed. Warning: This may lead to a "write-on-read" situation for the
  first request in which the registry is being used.
  [optilude]


1.0b3 - 2011-01-03
------------------

 - Added prefix option to forInterface (as it was added to registerInterface)
   [garbas]


1.0b2 - 2010-04-21
------------------

- Added support for Decimal fields
  [optilude]

- Add a prefix option to registerInterface to allow an interface to be used as
  a template for a series of values, rather than single use.
  [MatthewWilkes]


1.0b1 - 2009-08-02
------------------

- Fix a bug in bind() for Choice fields.
  [optilude]


1.0a2 - 2009-07-12
------------------

- Changed API methods and arguments to mixedCase to be more consistent with
  the rest of Zope. This is a non-backwards-compatible change. Our profuse
  apologies, but it's now or never. :-/

  If you find that you get import errors or unknown keyword arguments in your
  code, please change names from foo_bar too fooBar, e.g. for_interface()
  becomes forInterface().
  [optilude]


1.0a1 - 2009-04-17
------------------

- Initial release


            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.org/project/plone.registry",
    "name": "plone.registry",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "configuration registry",
    "author": "Martin Aspeli, Wichert Akkerman, Hanno Schlichting",
    "author_email": "plone-developers@lists.sourceforge.net",
    "download_url": "https://files.pythonhosted.org/packages/33/f5/011bf18de3ab917eb1dd67b9c44b220a37d19a92f56d9da26d260a291f37/plone.registry-2.0.1.tar.gz",
    "platform": null,
    "description": "============\nIntroduction\n============\nThis package provides debconf-like (or about:config-like) settings registries\nfor Zope applications. A ``registry``, with a dict-like API, is used to get and\nset values stored in ``records``. Each record contains the actual value, as\nwell as a ``field`` that describes the record in more detail. At a minimum, the\nfield contains information about the type of value allowed, as well as a short\ntitle describing the record's purpose.\n\n.. contents:: Table of Contents\n\n\n================\nUsing registries\n================\n\nYou can create a new registry simply by instantiating the Registry class.\nThe class and its data structures are persistent, so you can store them in the ZODB.\nYou may want to provide the registry object as local utility for easy access as well, though we won't do that here.\n\n::\n\n    >>> from plone.registry import Registry\n    >>> registry = Registry()\n\nThe registry starts out empty.\nTo access the registry's records, you can use the ``records`` property.\nThis exposes a dict API where keys are strings and values are objects providing ``IRecords``.\n\n::\n\n    >>> len(registry.records)\n    0\n\nSimple records\n==============\n\nLet's now create a record.\nA record must have a name.\nThis should be a dotted name, and contain ASCII characters only.\nBy convention, it should be all lowercase and start with the name of the package that defines the record.\n\nIt is also possible to create a  number of records based on a single schema interface - see below.\nFor now, we will focus on simple records.\n\nBefore we can create the record, we must create the field that describes it.\nFields are based on the venerable ``zope.schema`` package.\n``plone.registry`` only supports certain fields, and disallows use of a few properties even of those.\nAs a rule of thumb, so long as a field stores a Python primitive, it is supported; the same goes for attributes of fields.\n\nThus:\n\n* Fields like ``Object``, ``InterfaceField`` and so on are *not* supported.\n* A custom ``constraint`` method is *not* supported.\n* The ``order`` attribute will *always* be set to ``-1``.\n* For Choice fields, *only named vocabularies* are supported:\n  you can *not* reference a particular *source* or *source binder*.\n* The ``key_type`` and ``value_type`` properties of ``Dict``, ``List``, ``Tuple``, ``Set`` and ``Frozenset`` may *only* contain persistent fields.\n\nSee section \"Persistent fields\" for more details.\n\nCreating a record\n-----------------\n\nThe supported field types are found in the module ``plone.registry.field``.\nThese are named the same as the equivalent field in ``zope.schema``, and have the same constructors.\nYou must use one of these fields when creating records directly::\n\n    >>> from plone.registry import field\n    >>> age_field = field.Int(title=u\"Age\", min=0, default=18)\n\n    >>> from plone.registry import Record\n    >>> age_record = Record(age_field)\n\nNote that in this case, we did not supply a value.\nThe value will therefore be the field default::\n\n    >>> age_record.value\n    18\n\nWe can set a different value, either in the ``Record`` constructor or via the ``value`` attribute::\n\n    >>> age_record.value = 2\n    >>> age_record.value\n    2\n\nNote that the value is validated against the field::\n\n    >>> age_record.value = -1\n    Traceback (most recent call last):\n    ...\n    zope.schema._bootstrapinterfaces.TooSmall: (-1, 0)\n\n    >>> age_record.value\n    2\n\nWe can now add the field to the registry.\nThis is done via the ``record`` dictionary::\n\n    >>> 'plone.registry.tests.age' in registry\n    False\n    >>> registry.records['plone.registry.tests.age'] = age_record\n\nAt this point, the record will gain ``__name__`` and ``__parent__`` attributes::\n\n    >>> age_record.__name__\n    'plone.registry.tests.age'\n\n    >>> age_record.__parent__ is registry\n    True\n\nCreating a record with an initial value\n---------------------------------------\n\nWe can create records more succinctly in *one go* by\n\n1. creating the field,\n2. creating the Record and setting its value as and\n3. assigning it to the registry,\n\nlike this::\n\n    >>> registry.records['plone.registry.tests.cms'] = \\\n    ...     Record(field.TextLine(title=u\"CMS of choice\"), u\"Plone\")\n\nThe record can now be obtained.\nNote that it has a nice ``__repr__`` to help debugging.\n\n    >>> registry.records['plone.registry.tests.cms']\n    <Record plone.registry.tests.cms>\n\nAccessing and manipulating record values\n----------------------------------------\n\nOnce a record has been created and added to the registry,\nyou can access its value through dict-like operations on the registry itself::\n\n    >>> 'plone.registry.tests.cms' in registry\n    True\n\n    >>> registry['plone.registry.tests.cms']  # doctest: +IGNORE_U\n    u'Plone'\n\n    >>> registry['plone.registry.tests.cms'] = u\"Plone 3.x\"\n\nAgain, values are validated::\n\n    >>> registry['plone.registry.tests.cms'] = b'Joomla'\n    Traceback (most recent call last):\n    ...\n    zope.schema._bootstrapinterfaces.WrongType: (b'Joomla', <class 'str'>, 'value')\n\nThere is also a ``get()`` method::\n\n    >>> registry.get('plone.registry.tests.cms')  # doctest: +IGNORE_U\n    u'Plone 3.x'\n    >>> registry.get('non-existent-key') is None\n    True\n\nDeleting records\n----------------\n\nRecords may be deleted from the ``records`` property::\n\n    >>> del registry.records['plone.registry.tests.cms']\n    >>> 'plone.registry.tests.cms' in registry.records\n    False\n    >>> 'plone.registry.tests.cms' in registry\n    False\n\nCreating records from interfaces\n================================\n\nAs an application developer, it is often desirable to define settings as traditional interfaces with ``zope.schema fields``.\n``plone.registry`` includes support for creating a set of records from a single interface.\n\nTo test this, we have created an interface, ``IMailSettings``.\nIt has two fields: ``sender`` and ``smtp_host``::\n\n    >>> from plone.registry.tests import IMailSettings\n\nNote that this contains standard fields::\n\n    >>> IMailSettings['sender']\n    <zope.schema._bootstrapfields.TextLine object at ...>\n\n    >>> IMailSettings['smtp_host']\n    <zope.schema._field.URI object at ...>\n\nWe can create records from this interface like this::\n\n    >>> registry.registerInterface(IMailSettings)\n\nOne record for each field in the interface has now been created.\nTheir names are the full dotted names to those fields::\n\n    >>> sender_record = registry.records['plone.registry.tests.IMailSettings.sender']\n    >>> smtp_host_record = registry.records['plone.registry.tests.IMailSettings.smtp_host']\n\nThe fields used in the records will be the equivalent persistent versions of the fields from the original interface::\n\n    >>> sender_record.field\n    <plone.registry.field.TextLine object at ...>\n\n    >>> smtp_host_record.field\n    <plone.registry.field.URI object at ...>\n\nThis feat is accomplished internally by adapting the field to the ``IPersistentField`` interface.\nThere is a default adapter factory that works for all fields defined in ``plone.registry.field``.\nYou can of course define your own adapter if you have a custom field type.\nBut bear in mind the golden rules of any persistent field::\n\n* The field must store only primitives or other persistent fields\n* It must not reference a function, class, interface or other method that could break if a package is uninstalled.\n\nIf we have a field for which there is no ``IPersistentField`` adapter, we will get an error::\n\n    >>> from plone.registry.tests import IMailPreferences\n    >>> IMailPreferences['settings']\n    <zope.schema._bootstrapfields.Object object at ...>\n\n    >>> registry.registerInterface(IMailPreferences)\n    Traceback (most recent call last):\n    ...\n    TypeError: There is no persistent field equivalent for the field `settings` of type `Object`.\n\nWhoops!\nWe can, however, tell ``registerInterface()`` to ignore one or more fields::\n\n    >>> registry.registerInterface(IMailPreferences, omit=('settings',))\n\nOnce an interface's records have been registered, we can get and set their values as normal::\n\n    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U\n    u'root@localhost'\n\n    >>> registry['plone.registry.tests.IMailSettings.sender'] = u\"webmaster@localhost\"\n    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U\n    u'webmaster@localhost'\n\nIf we sub-sequently re-register the same interface, the value will be retained if possible::\n\n    >>> registry.registerInterface(IMailSettings)\n    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U\n    u'webmaster@localhost'\n\nHowever, if the value is no longer valid, we will revert to the default.\nTo test that, let's sneakily modify the field for a while::\n\n    >>> old_field = IMailSettings['sender']\n    >>> IMailSettings._InterfaceClass__attrs['sender'] = field.Int(title=u\"Definitely not a string\", default=2)\n    >>> if hasattr(IMailSettings, '_v_attrs'):\n    ...     del IMailSettings._v_attrs['sender']\n    >>> registry.registerInterface(IMailSettings)\n    >>> registry['plone.registry.tests.IMailSettings.sender']\n    2\n\nBut let's put it back the way it was::\n\n    >>> IMailSettings._InterfaceClass__attrs['sender'] = old_field\n    >>> if hasattr(IMailSettings, '_v_attrs'):\n    ...     del IMailSettings._v_attrs['sender']\n    >>> registry.registerInterface(IMailSettings)\n    >>> registry['plone.registry.tests.IMailSettings.sender']  # doctest: +IGNORE_U\n    u'root@localhost'\n\nSometimes, you may want to use an interface as a template for multiple instances of a set of fields, rather than defining them all by hand.\nThis is especially useful when you want to allow third-party packages to provide information.\nTo accomplish this, we can provide a prefix with the ``registerInterface`` call.\nThis will take precedence over the ``__identifier__`` that is usually used.\n\n    >>> registry.registerInterface(IMailSettings, prefix=\"plone.registry.tests.alternativesettings\")\n\nThese values are now available in the same way as the original settings::\n\n    >>> sender_record = registry.records['plone.registry.tests.alternativesettings.sender']\n    >>> smtp_host_record = registry.records['plone.registry.tests.alternativesettings.smtp_host']\n    >>> registry['plone.registry.tests.alternativesettings.sender'] = u'alt@example.org'\n\nAccessing the original interface\n--------------------------------\n\nNow that we have these records, we can look up the original interface.\nThis does not break the golden rules:\ninternally, we only store the name of the interface, and resolve it at runtime.\n\nRecords that know about interfaces are marked with ``IInterfaceAwareRecord`` and have two additional properties:\n``interface`` and ``fieldName``::\n\n    >>> from plone.registry.interfaces import IInterfaceAwareRecord\n    >>> IInterfaceAwareRecord.providedBy(age_record)\n    False\n    >>> IInterfaceAwareRecord.providedBy(sender_record)\n    True\n\n    >>> sender_record.interfaceName\n    'plone.registry.tests.IMailSettings'\n\n    >>> sender_record.interface is IMailSettings\n    True\n\nUsing the records proxy\n-----------------------\n\nOnce the records for an interface has been created, it is possible to obtain a proxy object that provides the given interface, but reads and writes its values to the registry.\nThis is useful, for example, to create a form using ``zope.formlib`` or  ``z3c.form`` that is configured with widgets based on the\ninterface.\nOr simply as a more convenient API when working with multiple, related settings.\n\n::\n\n    >>> proxy = registry.forInterface(IMailSettings)\n    >>> proxy\n    <RecordsProxy for plone.registry.tests.IMailSettings>\n\nIf you use your registry values in code which might be encountered on normal HTML rendering paths (e.g. in a viewlet) you need to be aware that records might not exist or they are invalid.\n``forInterface()`` will raise KeyError on this kind of situations::\n\n    try:\n        proxy = registry.forInterface(IMailSettings)\n    except KeyError:\n        # Gracefully handled cases\n        # when GenericSetup installer has not been run or rerun\n        # e.g. by returning or using some default values\n        pass\n\nThe proxy is not a persistent object on its own::\n\n    >>> from persistent.interfaces import IPersistent\n    >>> IPersistent.providedBy(proxy)\n    False\n\nIt does, however, provide the requisite interface::\n\n    >>> IMailSettings.providedBy(proxy)\n    True\n\nYou can distinguish between the proxy and a 'normal' object by checking for the ``IRecordsProxy`` marker interface::\n\n    >>> from plone.registry.interfaces import IRecordsProxy\n    >>> IRecordsProxy.providedBy(proxy)\n    True\n\nWhen we set a value, it is stored in the registry::\n\n    >>> proxy.smtp_host = 'http://mail.server.com'\n    >>> registry['plone.registry.tests.IMailSettings.smtp_host']\n    'http://mail.server.com'\n\n    >>> registry['plone.registry.tests.IMailSettings.smtp_host'] = 'smtp://mail.server.com'\n    >>> proxy.smtp_host\n    'smtp://mail.server.com'\n\nValues not in the interface will raise an ``AttributeError``::\n\n    >>> proxy.age\n    Traceback (most recent call last):\n    ...\n    AttributeError: age\n\nNote that by default, the forInterface() method will check that the necessary records have been registered.\nFor example, we cannot use any old interface::\n\n    >>> registry.forInterface(IInterfaceAwareRecord)\n    Traceback (most recent call last):\n    ...\n    KeyError: 'Interface `plone.registry.interfaces.IInterfaceAwareRecord` defines a field `...`, for which there is no record.'\n\nBy default, we also cannot use an interface for which only some records exist::\n\n    >>> registry.forInterface(IMailPreferences)\n    Traceback (most recent call last):\n    ...\n    KeyError: 'Interface `plone.registry.tests.IMailPreferences` defines a field `settings`, for which there is no record.'\n\nIt is possible to disable this check, however.\nThis will be a bit more efficient::\n\n    >>> registry.forInterface(IMailPreferences, check=False)\n    <RecordsProxy for plone.registry.tests.IMailPreferences>\n\nA better way, however, is to explicitly declare that some fields are omitted::\n\n    >>> pref_proxy = registry.forInterface(IMailPreferences, omit=('settings',))\n\nIn this case, the omitted fields will default to their 'missing' value::\n\n    >>> pref_proxy.settings ==  IMailPreferences['settings'].missing_value\n    True\n\nHowever, trying to set the value will result in a ``AttributeError``::\n\n    >>> pref_proxy.settings = None\n    Traceback (most recent call last):\n    ...\n    AttributeError: settings\n\nTo access another instance of the field, supply the prefix::\n\n    >>> alt_proxy = registry.forInterface(IMailSettings,\n    ...     prefix=\"plone.registry.tests.alternativesettings\")\n    >>> alt_proxy.sender  # doctest: +IGNORE_U\n    u'alt@example.org'\n\nCollections of records proxies\n------------------------------\n\nA collection of record sets may be accessed using ``collectionOfInterface``::\n\n    >>> collection = registry.collectionOfInterface(IMailSettings)\n\nYou can create a new record set::\n\n    >>> proxy = collection.setdefault('example')\n    >>> proxy.sender = u'collection@example.org'\n    >>> proxy.smtp_host = 'smtp://mail.example.org'\n\nRecord sets are stored based under the prefix::\n\n    >>> prefix = IMailSettings.__identifier__\n    >>> registry.records.values(prefix+'/', prefix+'0')\n    [<Record plone.registry.tests.IMailSettings/example.sender>,\n     <Record plone.registry.tests.IMailSettings/example.smtp_host>]\n    >>> registry['plone.registry.tests.IMailSettings/example.sender']  # doctest: +IGNORE_U\n    u'collection@example.org'\n\nRecords may be set from an existing object::\n\n    >>> class MailSettings:\n    ...     sender = u'someone@example.com'\n    ...     smtp_host = 'smtp://mail.example.com'\n    >>> collection['example_com'] = MailSettings()\n    >>> registry.records.values(prefix+'/', prefix+'0')\n    [<Record plone.registry.tests.IMailSettings/example.sender>,\n     <Record plone.registry.tests.IMailSettings/example.smtp_host>,\n     <Record plone.registry.tests.IMailSettings/example_com.sender>,\n     <Record plone.registry.tests.IMailSettings/example_com.smtp_host>]\n\nThe collection may be iterated over::\n\n    >>> for name in collection: print(name)\n    example\n    example_com\n\nAnd may be deleted::\n\n    >>> del collection['example_com']\n    >>> registry.records.values(prefix+'/', prefix+'0')\n    [<Record plone.registry.tests.IMailSettings/example.sender>,\n     <Record plone.registry.tests.IMailSettings/example.smtp_host>]\n\nUsing field references\n======================\n\nIt is possible for one record to refer to another record's field.\nThis can be used to provide a simple \"override\" mechanism,\nfor example, where one record defines the field and a default value,\nwhilst another provides an override validated against the same field.\n\nLet us first create the base record and set its value::\n\n    >>> timeout_field = field.Int(title=u\"Timeout\", min=0)\n    >>> registry.records['plone.registry.tests.timeout'] = Record(timeout_field, 10)\n\n    >>> timeout_record = registry.records['plone.registry.tests.timeout']\n    >>> timeout_record.value\n    10\n\nNext, we create a field reference for this record::\n\n    >>> from plone.registry import FieldRef\n    >>> timeout_override_field = FieldRef(timeout_record.__name__, timeout_record.field)\n\nWe can use this to create a new record::\n\n    >>> registry.records['plone.registry.tests.timeout.override'] = Record(timeout_override_field, 20)\n    >>> timeout_override_record = registry.records['plone.registry.tests.timeout.override']\n\nThe two values are separate::\n\n    >>> timeout_record.value\n    10\n    >>> timeout_override_record.value\n    20\n\n    >>> registry['plone.registry.tests.timeout']\n    10\n    >>> registry['plone.registry.tests.timeout.override']\n    20\n\nValidation uses the underlying field::\n\n    >>> registry['plone.registry.tests.timeout.override'] = -1\n    Traceback (most recent call last):\n    ...\n    zope.schema._bootstrapinterfaces.TooSmall: (-1, 0)\n\nThe reference field exposes the standard field properties, e.g.::\n\n    >>> timeout_override_record.field.title\n    'Timeout'\n    >>> timeout_override_record.field.min\n    0\n\nTo look up the underlying record name, we can use the ``recordName`` property::\n\n    >>> timeout_override_record.field.recordName\n    'plone.registry.tests.timeout'\n\n\n===============\nRegistry events\n===============\n\nThe registry fires certain events. These are:\n\n``plone.registry.interfaces.IRecordAddedEvent``\n    when a record has been added to the registry.\n\n``plone.registry.interfaces.IRecordRemovedEvent``\n    when a record has been removed from the registry.\n\n``plone.registry.interfaces.IRecordModifiedEvent``,\n    when a record's value is modified.\n\nTo test these events, we will create, modify and remove a few records::\n\n    >>> from zope.component.eventtesting import clearEvents\n    >>> clearEvents()\n    >>> from plone.registry import Registry, Record, field\n    >>> registry = Registry()\n\nAdding a new record to the registry should fire ``IRecordAddedEvents``::\n\n    >>> registry.records['plone.registry.tests.age'] = \\\n    ...     Record(field.Int(title=u\"Age\", min=0, default=18))\n\n    >>> registry.records['plone.registry.tests.cms'] = \\\n    ...     Record(field.TextLine(title=u\"Preferred CMS\"), value=u\"Plone\")\n\nWhen creating records from an interface, one event is fired for each field in the interface::\n\n    >>> from plone.registry.tests import IMailSettings\n    >>> registry.registerInterface(IMailSettings)\n\nDeleting a record should fire an ``IRecordRemovedEvent``::\n\n    >>> del registry.records['plone.registry.tests.cms']\n\nChanging a record should fire an ``IRecordModifiedEvent``::\n\n    >>> registry['plone.registry.tests.age'] = 25\n    >>> registry.records['plone.registry.tests.age'].value = 24\n\nLet's take a look at the events that were just fired::\n\n    >>> from plone.registry.interfaces import IRecordEvent\n    >>> from zope.component.eventtesting import getEvents\n    >>> getEvents(IRecordEvent)\n    [<RecordAddedEvent for plone.registry.tests.age>,\n     <RecordAddedEvent for plone.registry.tests.cms>,\n     <RecordAddedEvent for plone.registry.tests.IMailSettings.sender>,\n     <RecordAddedEvent for plone.registry.tests.IMailSettings.smtp_host>,\n     <RecordRemovedEvent for plone.registry.tests.cms>,\n     <RecordModifiedEvent for plone.registry.tests.age>,\n     <RecordModifiedEvent for plone.registry.tests.age>]\n\nFor the modified events, we can also check the value before and after the change::\n\n    >>> from plone.registry.interfaces import IRecordModifiedEvent\n    >>> [(repr(e), e.oldValue, e.newValue,) for e in getEvents(IRecordModifiedEvent)]\n    [('<RecordModifiedEvent for plone.registry.tests.age>', 18, 25),\n     ('<RecordModifiedEvent for plone.registry.tests.age>', 25, 24)]\n\nIObjectEvent-style redispatchers\n================================\n\nThere is a special event handler.\nIt takes care of re-dispatching registry events based on the schema interface prescribed by the record.\n\nLet's re-set the event testing framework and register the re-dispatching event subscriber.\nNormally, this would happen automatically by including this package's ZCML.\n\n::\n\n    >>> clearEvents()\n    >>> from zope.component import provideHandler\n    >>> from plone.registry.events import redispatchInterfaceAwareRecordEvents\n    >>> provideHandler(redispatchInterfaceAwareRecordEvents)\n\nWe'll then register a schema interface::\n\n    >>> from plone.registry.tests import IMailSettings\n    >>> registry.registerInterface(IMailSettings)\n\nWe could now register an event handler to print any record event occurring on an ``IMailSettings`` record.\nMore specialised event handlers for e.g. ``IRecordModifiedEvent`` or ``IRecordRemovedEvent`` are of course also possible.\nNote that it is not possible to re-dispatch ``IRecordAddedEvents``, so these are never caught.\n\n    >>> from zope.component import adapter\n    >>> @adapter(IMailSettings, IRecordEvent)\n    ... def print_mail_settings_events(proxy, event):\n    ...     print(\"Got %s for %s\" % (event, proxy))\n    >>> provideHandler(print_mail_settings_events)\n\nLet's now modify one of the records for this interface.\nThe event handler should react immediately::\n\n    >>> registry['plone.registry.tests.IMailSettings.sender'] = u\"Some sender\"\n    Got <RecordModifiedEvent for plone.registry.tests.IMailSettings.sender> for <RecordsProxy for plone.registry.tests.IMailSettings>\n\nLet's also modify a non-interface-aware record, for comparison's sake.\nHere, there is nothing printed::\n\n    >>> registry['plone.registry.tests.age'] = 3\n\nWe can try a record-removed event as well::\n\n    >>> del registry.records['plone.registry.tests.IMailSettings.sender']\n    Got <RecordRemovedEvent for plone.registry.tests.IMailSettings.sender> for <RecordsProxy for plone.registry.tests.IMailSettings>\n\nThe basic events that have been dispatched are::\n\n    >>> getEvents(IRecordEvent)\n    [<RecordAddedEvent for plone.registry.tests.IMailSettings.sender>,\n     <RecordAddedEvent for plone.registry.tests.IMailSettings.smtp_host>,\n     <RecordModifiedEvent for plone.registry.tests.IMailSettings.sender>,\n     <RecordModifiedEvent for plone.registry.tests.age>,\n     <RecordRemovedEvent for plone.registry.tests.IMailSettings.sender>]\n\n\n=================\nPersistent fields\n=================\n\nThe persistent fields that are found in ``plone.registry.field`` are siblings of the ones found in zope.schema,\nwith persistence mixed in.\nTo avoid potentially breaking the registry with persistent references to symbols that may go away,\nwe purposefully limit the number of fields supported.\nWe also disallow some properties, and add some additional checks on others.\n\nThe standard fields\n===================\n\nWe will show each supported field in turn. For all fields, note that:\n\n* the ``order`` property will return ``-1`` no matter what setting the ``constraint`` property is diallowed\n* the ``key_type`` and ``value_type`` properties, where applicable, must be set to a persistent field.\n* for ``Choice`` fields, only named vocabularies and vocabularies based on simple values are supported:\n  sources and ``IVocabulary`` objects are not.\n\nImports needed::\n\n    >>> from plone.registry import field\n    >>> from zope import schema\n    >>> from persistent import Persistent\n\nBytes\n-----\n\nThe bytes field describes a string of bytes::\n\n    >>> f = field.Bytes(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.Bytes)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Bytes(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint('ABC')\n    True\n\nBytesLine\n---------\n\nThe bytes field describes a string of bytes, disallowing newlines::\n\n    >>> f = field.BytesLine(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.BytesLine)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.BytesLine(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(b'AB\\nC')\n    False\n\nASCII\n-----\n\nThe ASCII field describes a string containing only ASCII characters::\n\n    >>> f = field.ASCII(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.ASCII)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.ASCII(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint('ab\\nc')\n    True\n\nASCIILine\n---------\n\nThe ASCII line field describes a string containing only ASCII characters and disallowing newlines::\n\n    >>> f = field.ASCIILine(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.ASCIILine)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.ASCIILine(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint('ab\\nc')\n    False\n\nText\n----\n\nThe text field describes a unicode string::\n\n    >>> f = field.Text(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.Text)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Text(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(u'ab\\nc')\n    True\n\nTextLine\n--------\n\nThe text line field describes a unicode string, disallowing newlines::\n\n    >>> f = field.TextLine(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.TextLine)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.TextLine(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(u'ab\\nc')\n    False\n\nBool\n----\n\nThe bool field describes a boolean::\n\n    >>> f = field.Bool(title=u\"Test\")\n    >>> isinstance(f, schema.Bool)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Bool(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(False)\n    True\n\nInt\n---\n\nThe int field describes an integer or long::\n\n    >>> f = field.Int(title=u\"Test\", min=-123, max=1234)\n    >>> isinstance(f, schema.Int)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Int(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(123)\n    True\n\nFloat\n-----\n\nThe float field describes a float::\n\n    >>> f = field.Float(title=u\"Test\", min=-123.0, max=1234.0)\n    >>> isinstance(f, schema.Float)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Float(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(123)\n    True\n\nDecimal\n-------\n\nThe decimal field describes a decimal::\n\n    >>> import decimal\n    >>> f = field.Decimal(title=u\"Test\", min=decimal.Decimal('-123.0'), max=decimal.Decimal('1234.0'))\n    >>> isinstance(f, schema.Decimal)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Decimal(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(123)\n    True\n\nPassword\n--------\n\nThe password field describes a unicode string used for a password::\n\n    >>> f = field.Password(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.Password)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Password(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(u'ab\\nc')\n    False\n\nSourceText\n----------\n\nThe source  text field describes a unicode string with source code::\n\n    >>> f = field.SourceText(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.SourceText)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.SourceText(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(u'ab\\nc')\n    True\n\nURI\n---\n\nThe URI field describes a URI string::\n\n    >>> f = field.URI(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.URI)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.URI(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(u'abc')\n    True\n\nId\n--\n\nThe id field describes a URI string or a dotted name::\n\n    >>> f = field.Id(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.Id)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Id(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(u'abc')\n    True\n\nDottedName\n----------\n\nThe dotted name field describes a Python dotted name::\n\n    >>> f = field.DottedName(title=u\"Test\", min_length=0, max_length=10)\n    >>> isinstance(f, schema.DottedName)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.DottedName(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(u'abc')\n    True\n\nDatetime\n--------\n\nThe date/time field describes a Python datetime object::\n\n    >>> f = field.Datetime(title=u\"Test\")\n    >>> isinstance(f, schema.Datetime)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Datetime(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> import datetime\n    >>> f.constraint(datetime.datetime.now())\n    True\n\nDate\n----\n\nThe date field describes a Python date object::\n\n    >>> f = field.Date(title=u\"Test\")\n    >>> isinstance(f, schema.Date)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Date(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> import datetime\n    >>> f.constraint(datetime.date.today())\n    True\n\nTimedelta\n---------\n\nThe time-delta field describes a Python timedelta object::\n\n    >>> f = field.Timedelta(title=u\"Test\")\n    >>> isinstance(f, schema.Timedelta)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Timedelta(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> import datetime\n    >>> f.constraint(datetime.timedelta(1))\n    True\n\nTuple\n-----\n\nThe tuple field describes a tuple::\n\n    >>> f = field.Tuple(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=field.TextLine(title=u\"Value\"))\n    >>> isinstance(f, schema.Tuple)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Tuple(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=schema.TextLine(title=u\"Value\"))\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> f.value_type = schema.TextLine(title=u\"Value\")\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> field.Tuple(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint((1,2))\n    True\n\nList\n----\n\nThe list field describes a tuple::\n\n    >>> f = field.List(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=field.TextLine(title=u\"Value\"))\n    >>> isinstance(f, schema.List)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.List(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=schema.TextLine(title=u\"Value\"))\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> f.value_type = schema.TextLine(title=u\"Value\")\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> field.List(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint([1,2])\n    True\n\nSet\n---\n\nThe set field describes a set::\n\n    >>> f = field.Set(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=field.TextLine(title=u\"Value\"))\n    >>> isinstance(f, schema.Set)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Set(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=schema.TextLine(title=u\"Value\"))\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> f.value_type = schema.TextLine(title=u\"Value\")\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> field.Set(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(set([1,2]))\n    True\n\nFrozenset\n---------\n\nThe set field describes a frozenset::\n\n    >>> f = field.FrozenSet(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=field.TextLine(title=u\"Value\"))\n    >>> isinstance(f, schema.FrozenSet)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.FrozenSet(title=u\"Test\", min_length=0, max_length=10,\n    ...     value_type=schema.TextLine(title=u\"Value\"))\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> f.value_type = schema.TextLine(title=u\"Value\")\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> field.FrozenSet(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(frozenset([1,2]))\n    True\n\nDict\n----\n\nThe set field describes a dict::\n\n    >>> f = field.Dict(title=u\"Test\", min_length=0, max_length=10,\n    ...     key_type=field.ASCII(title=u\"Key\"),\n    ...     value_type=field.TextLine(title=u\"Value\"))\n    >>> isinstance(f, schema.Dict)\n    True\n\n    >>> f.order\n    -1\n\n    >>> field.Dict(title=u\"Test\", min_length=0, max_length=10,\n    ...     key_type=schema.ASCII(title=u\"Key\"),\n    ...     value_type=field.TextLine(title=u\"Value\"))\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `key_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> f.key_type = schema.ASCII(title=u\"Key\")\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `key_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> field.Dict(title=u\"Test\", min_length=0, max_length=10,\n    ...     key_type=field.ASCII(title=u\"Key\"),\n    ...     value_type=schema.TextLine(title=u\"Value\"))\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> f.value_type = schema.TextLine(title=u\"Value\")\n    Traceback (most recent call last):\n    ...\n    ValueError: The property `value_type` may only contain objects providing `plone.registry.interfaces.IPersistentField`.\n\n    >>> field.Dict(title=u\"Test\", constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint(dict())\n    True\n\nChoice\n------\n\nA choice field represents a selection from a vocabulary.\nFor persistent fields, the vocabulary cannot be a ``source`` or any kind of object:\nit must either be a list of primitives, or a named vocabulary::\n\n    >>> f = field.Choice(title=u\"Test\", values=[1,2,3])\n    >>> isinstance(f, schema.Choice)\n    True\n\n    >>> f.order\n    -1\n\nWith a list of values given, the ``vocabulary`` property returns a vocabulary\nconstructed from the values on the fly, and ``vocabularyName`` is ``None``::\n\n    >>> f.vocabulary\n    <zope.schema.vocabulary.SimpleVocabulary object at ...>\n\n    >>> f.vocabularyName is None\n    True\n\nWe will get an error if we use anything other than primitives::\n\n    >>> f = field.Choice(title=u\"Test\", values=[object(), object()])\n    Traceback (most recent call last):\n    ...\n    ValueError: Vocabulary values may only contain primitive values.\n\nIf a vocabulary name given, it is stored in ``vocabularyName``, and the ``vocabulary`` property returns ``None``::\n\n    >>> f = field.Choice(title=u\"Test\", vocabulary='my.vocab')\n    >>> f.vocabulary is None\n    True\n\n    >>> f.vocabularyName\n    'my.vocab'\n\nOther combinations are now allowed, such as specifying no vocabulary::\n\n    >>> field.Choice(title=u\"Test\")\n    Traceback (most recent call last):\n    ...\n    AssertionError: You must specify either values or vocabulary.\n\nOr specifying both types::\n\n    >>> field.Choice(title=u\"Test\", values=[1,2,3], vocabulary='my.vocab')\n    Traceback (most recent call last):\n    ...\n    AssertionError: You cannot specify both values and vocabulary.\n\nOr specifying an object source::\n\n    >>> from zope.schema.vocabulary import SimpleVocabulary\n    >>> dummy_vocabulary = SimpleVocabulary.fromValues([1,2,3])\n    >>> field.Choice(title=u\"Test\", source=dummy_vocabulary)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields do not support sources, only named vocabularies or vocabularies based on simple value sets.\n\nOr specifying an object vocabulary::\n\n    >>> field.Choice(title=u\"Test\", vocabulary=dummy_vocabulary)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields only support named vocabularies or vocabularies based on simple value sets.\n\nAs with other fields, you also cannot set a constraint::\n\n    >>> field.Choice(title=u\"Test\", values=[1,2,3], constraint=lambda x: True)\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint = lambda x: False\n    Traceback (most recent call last):\n    ...\n    ValueError: Persistent fields does not support setting the `constraint` property\n\n    >>> f.constraint('ABC')\n    True\n\nJSONField\n---------\n\nThe set field describes a JSONField::\n\n    >>> import plone.schema\n    >>> f = field.JSONField(title=u\"Test\")\n    >>> isinstance(f, plone.schema.JSONField)\n    True\n\n    >>> f.order\n    -1\n\n``IPersistentField`` adapters\n=============================\n\nIt is possible to adapt any non-persistent field to its related ``IPersistentField`` using the adapter factories in ``plone.registry`` fieldfactory.\nThese are set up in ``configure.zcml`` and explicitly registered in the test setup in ``tests.py``.\nCustom adapters are of course also possible::\n\n    >>> from plone.registry.interfaces import IPersistentField\n\n    >>> f = schema.TextLine(title=u\"Test\")\n    >>> IPersistentField.providedBy(f)\n    False\n\n    >>> p = IPersistentField(f)\n    >>> IPersistentField.providedBy(p)\n    True\n\n    >>> isinstance(p, field.TextLine)\n    True\n\nUnsupported field types will not be adaptable by default::\n\n    >>> f = schema.Object(title=u\"Object\", schema=IPersistentField)\n    >>> IPersistentField(f, None) is None\n    True\n\n    >>> f = schema.InterfaceField(title=u\"Interface\")\n    >>> IPersistentField(f, None) is None\n    True\n\nAfter adaptation, the rules of persistent fields apply:\nThe ``order`` attribute is perpetually ``-1``.\nCustom constraints are not allowed, and key and value type will be adapted to persistent fields as well.\nIf any of these constraints can not be met, the adaptation will fail.\n\nFor constraints, the non-persistent value is simply ignored and the default method from the class will be used.\n\n::\n\n    >>> f = schema.TextLine(title=u\"Test\", constraint=lambda x: False)\n    >>> f.constraint\n    <function <lambda> at ...>\n\n    >>> p = IPersistentField(f)\n    >>> p.constraint\n    <bound method TextLine.constraint of <plone.registry.field.TextLine object at ...>>\n\nThe order property is similarly ignored::\n\n    >>> f.order > 0\n    True\n\n    >>> p.order\n    -1\n\nKey/value types will be adapted if possible::\n\n    >>> f = schema.Dict(title=u\"Test\",\n    ...     key_type=schema.Id(title=u\"Id\"),\n    ...     value_type=schema.TextLine(title=u\"Value\"))\n    >>> p = IPersistentField(f)\n    >>> p.key_type\n    <plone.registry.field.Id object at ...>\n\n    >>> p.value_type\n    <plone.registry.field.TextLine object at ...>\n\nIf they cannot be adapted, there will be an error::\n\n    >>> f = schema.Dict(title=u\"Test\",\n    ...     key_type=schema.Id(title=u\"Id\"),\n    ...     value_type=schema.Object(title=u\"Value\", schema=IPersistentField))\n    >>> p = IPersistentField(f)\n    Traceback (most recent call last):\n    ...\n    TypeError: ('Could not adapt', <zope.schema._field.Dict object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)\n\n    >>> f = schema.Dict(title=u\"Test\",\n    ...     key_type=schema.InterfaceField(title=u\"Id\"),\n    ...     value_type=schema.TextLine(title=u\"Value\"))\n    >>> p = IPersistentField(f)\n    Traceback (most recent call last):\n    ...\n    TypeError: ('Could not adapt', <zope.schema._field.Dict object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)\n\nThere is additional validation for choice fields that warrant a custom adapter.\nThese ensure that vocabularies are either stored as a list of simple values, or as named vocabularies.\n\n::\n\n    >>> f = schema.Choice(title=u\"Test\", values=[1,2,3])\n    >>> p = IPersistentField(f)\n    >>> p.vocabulary\n    <zope.schema.vocabulary.SimpleVocabulary object at ...>\n    >>> p._values\n    [1, 2, 3]\n    >>> p.vocabularyName is None\n    True\n\n    >>> f = schema.Choice(title=u\"Test\", vocabulary='my.vocab')\n    >>> p = IPersistentField(f)\n    >>> p.vocabulary is None\n    True\n    >>> p._values is None\n    True\n    >>> p.vocabularyName\n    'my.vocab'\n\nComplex vocabularies or sources are not allowed::\n\n    >>> from zope.schema.vocabulary import SimpleVocabulary\n    >>> dummy_vocabulary = SimpleVocabulary.fromItems([('a', 1), ('b', 2)])\n    >>> f = schema.Choice(title=u\"Test\", source=dummy_vocabulary)\n    >>> p = IPersistentField(f)\n    Traceback (most recent call last):\n    ...\n    TypeError: ('Could not adapt', <zope.schema._field.Choice object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)\n\n\n    >>> f = schema.Choice(title=u\"Test\", vocabulary=dummy_vocabulary)\n    >>> p = IPersistentField(f)\n    Traceback (most recent call last):\n    ...\n    TypeError: ('Could not adapt', <zope.schema._field.Choice object at ...>, <InterfaceClass plone.registry.interfaces.IPersistentField>)\n\nChangelog\n=========\n\n\n.. You should *NOT* be adding new change log entries to this file.\n   You should create a file in the news directory instead.\n   For helpful instructions, please see:\n   https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n\n.. towncrier release notes start\n\n2.0.1 (2024-01-22)\n------------------\n\nInternal:\n\n\n- Update configuration files.\n  [plone devs] (6e36bcc4, 7723aeaf)\n\n\n2.0.0 (2023-04-26)\n------------------\n\nBreaking changes:\n\n\n- Drop python 2.7 compatibility.\n  [gforcada] (#1)\n\n\nInternal:\n\n\n- Update configuration files.\n  [plone devs] (a864b30f)\n\n\n1.2.1 (2021-06-14)\n------------------\n\nBug fixes:\n\n\n- Fix registry key validation regexp.\n  [jensens] (#23)\n\n\n1.2.0 (2021-04-23)\n------------------\n\nNew features:\n\n\n- Allow plone.schema.JSONField be stored in registry (as dict-like)\n   [sneridagh] (#719)\n\n\n1.1.6 (2020-04-22)\n------------------\n\nBug fixes:\n\n\n- Minor packaging updates. (#1)\n\n\n1.1.5 (2018-12-14)\n------------------\n\nBug fixes:\n\n- Avoid a deprecation warning that would turn into an error on Python 3.8.\n  [gforcada]\n\n\n1.1.4 (2018-11-04)\n------------------\n\nBug fixes:\n\n- Adapt test to changed object field in zope4\n  [pbauer]\n\n\n1.1.3 (2018-06-22)\n------------------\n\nBug fixes:\n\n- Improve performance of RecordsProxy.__iter__ which is now invoked more in\n  core Plone as part of the requireJS configuration\n  [MatthewWilkes]\n\n\n1.1.2 (2016-12-06)\n------------------\n\nBug fixes:\n\n- Fix tests to pass on Python 3.5\n  [datakurre]\n\n\n1.1.1 (2016-11-19)\n------------------\n\nBug fixes:\n\n- Fix endless recursion on getting values from broken records proxy objects\n  [tomgross]\n\n\n1.1.0 (2016-07-05)\n------------------\n\nNew features:\n\n- Give ``RecordsProxy`` a ``__parent__`` (the registry) in order to make it a good Zope citizen.\n  This helps in context of z3cform binders and other similar situations,\n  where a records proxy is used as context.\n  [jensens]\n\n\n1.0.4 (2016-06-12)\n------------------\n\nFixes:\n\n- More cleanup: PEP8, isort, readability.\n  [jensens]\n\n\n1.0.3 (2016-02-26)\n------------------\n\nFixes:\n\n- Replace deprecated ``zope.testing.doctestunit`` import with ``doctest``\n  module from stdlib.\n  [thet]\n\n- Cleanup: Pep8, utf8 headers, whitespace fixes, readability, ReST-fixes,\n  doc-style, etc.\n  [jensens]\n\n\n1.0.2 (2014-09-11)\n------------------\n\n- Choice field construction compatible with a simple vocabulary of\n  string-based choices, which are converted to values on construction.\n  This provides compatibility for plone.registry/plone.app.registry\n  integration with plone.supermodel >= 1.2.5.\n  [seanupton]\n\n\n1.0.1 (2013-01-13)\n------------------\n\n1.0 - 2011-05-13\n----------------\n\n- Release 1.0 Final\n  [esteele]\n\n- Add MANIFEST.in.\n  [WouterVH]\n\n\n1.0b5 - 2011-04-06\n------------------\n\n- Make RecordsProxy type customizable through ``factory`` argument to\n  ``forInterface`` and ``collectionOfInterface``.\n  [elro]\n\n- Add ``collectionOfInterface`` support to registry.\n  [elro]\n\n- Fixed bug where prefix was ignored by registry.forInterface.\n  [elro]\n\n- Add optional min, max arguments for keys/values/items of _Records.\n  [elro]\n\n\n1.0b4 - 2011-02-04\n------------------\n\n- Added support for field references, via the ``FieldRef`` class. See\n  ``registry.txt`` for details.\n  [optilude]\n\n- Change the internal persistent structure around to make it more efficient.\n  The API remains the same. Old registries will be migrated when first\n  accessed. Warning: This may lead to a \"write-on-read\" situation for the\n  first request in which the registry is being used.\n  [optilude]\n\n\n1.0b3 - 2011-01-03\n------------------\n\n - Added prefix option to forInterface (as it was added to registerInterface)\n   [garbas]\n\n\n1.0b2 - 2010-04-21\n------------------\n\n- Added support for Decimal fields\n  [optilude]\n\n- Add a prefix option to registerInterface to allow an interface to be used as\n  a template for a series of values, rather than single use.\n  [MatthewWilkes]\n\n\n1.0b1 - 2009-08-02\n------------------\n\n- Fix a bug in bind() for Choice fields.\n  [optilude]\n\n\n1.0a2 - 2009-07-12\n------------------\n\n- Changed API methods and arguments to mixedCase to be more consistent with\n  the rest of Zope. This is a non-backwards-compatible change. Our profuse\n  apologies, but it's now or never. :-/\n\n  If you find that you get import errors or unknown keyword arguments in your\n  code, please change names from foo_bar too fooBar, e.g. for_interface()\n  becomes forInterface().\n  [optilude]\n\n\n1.0a1 - 2009-04-17\n------------------\n\n- Initial release\n\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "Registry for application settings (like debconf/ about:config)",
    "version": "2.0.1",
    "project_urls": {
        "Homepage": "https://pypi.org/project/plone.registry"
    },
    "split_keywords": [
        "configuration",
        "registry"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "436a8cae3a4bd75ad7b8e3f8dfee31600b44b3c162d72efd7dcab436fdf1df61",
                "md5": "df5577dc4fa9fca095c343b92f53bb67",
                "sha256": "34108d1ead452002a5d5d8ddf8813dfe111da53b8cedeb56332e555afd73e888"
            },
            "downloads": -1,
            "filename": "plone.registry-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "df5577dc4fa9fca095c343b92f53bb67",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 37634,
            "upload_time": "2024-01-22T19:52:29",
            "upload_time_iso_8601": "2024-01-22T19:52:29.827986Z",
            "url": "https://files.pythonhosted.org/packages/43/6a/8cae3a4bd75ad7b8e3f8dfee31600b44b3c162d72efd7dcab436fdf1df61/plone.registry-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "33f5011bf18de3ab917eb1dd67b9c44b220a37d19a92f56d9da26d260a291f37",
                "md5": "2a27e1a5665cef562d24d2f37aac1cf9",
                "sha256": "4a19201727e3665f98ca742c408f9dab27b36a2fc48f4e9a0ea3864df9eebb8c"
            },
            "downloads": -1,
            "filename": "plone.registry-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2a27e1a5665cef562d24d2f37aac1cf9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 48775,
            "upload_time": "2024-01-22T19:52:32",
            "upload_time_iso_8601": "2024-01-22T19:52:32.572883Z",
            "url": "https://files.pythonhosted.org/packages/33/f5/011bf18de3ab917eb1dd67b9c44b220a37d19a92f56d9da26d260a291f37/plone.registry-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-22 19:52:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "plone.registry"
}