--- a/src/pyams_utils/interfaces/__init__.py Sat Nov 23 01:17:56 2019 +0100
+++ b/src/pyams_utils/interfaces/__init__.py Sat Nov 23 14:51:46 2019 +0100
@@ -10,18 +10,20 @@
# FOR A PARTICULAR PURPOSE.
#
-"""PyAMS_utils interfaces module
+"""PyAMS_utils.interfaces package
This module defines several generic constants and interfaces.
+
It is also used to provide translations to common zope.schema exceptions.
"""
-__docformat__ = 'restructuredtext'
+from zope.interface import Interface
+from zope.schema.interfaces import ConstraintNotSatisfied, InvalidDottedName, InvalidId, \
+ InvalidURI, InvalidValue, NotAContainer, NotAnIterator, NotUnique, RequiredMissing, \
+ SchemaNotFullyImplemented, SchemaNotProvided, TooBig, TooLong, TooShort, TooSmall, Unbound, \
+ WrongContainedType, WrongType
-from zope.interface import Interface
-from zope.schema.interfaces import ConstraintNotSatisfied, InvalidDottedName, InvalidId, InvalidURI, InvalidValue, \
- NotAContainer, NotAnIterator, NotUnique, RequiredMissing, SchemaNotFullyImplemented, SchemaNotProvided, TooBig, \
- TooLong, TooShort, TooSmall, Unbound, WrongContainedType, WrongType
+__docformat__ = 'restructuredtext'
from pyams_utils import _
@@ -50,7 +52,6 @@
NotAContainer.__doc__ = _("""Not a container""")
NotAnIterator.__doc__ = _("""Not an iterator""")
-
#
# Custom permissions
#
@@ -65,7 +66,8 @@
'''View permission is a custom permission used to view contents'''
MANAGE_PERMISSION = 'manage'
-'''Permission used to manage basic information; this permission is generally not used by custom contents'''
+'''Permission used to manage basic information; this permission is generally not used by custom
+contents'''
VIEW_SYSTEM_PERMISSION = 'pyams.ViewSystem'
'''Permission used to access management screens'''
@@ -106,14 +108,15 @@
This interface can be used to register an "interface's object factory".
For a given interface, such factory can be used to get an instance of an object providing
- this interface; several factories can be registered for the same interface if they have distinct
- names. See :py:mod:`pyams_utils.factory` module.
+ this interface; several factories can be registered for the same interface if they have
+ distinct names. See :py:mod:`pyams_utils.factory` module.
"""
class ICacheKeyValue(Interface):
"""Interface used to get string representation of a given object as cache key
- Several default adapters are given for objects (using their "id()"), strings (using string as key)
- and for persistent objects (using their persistent OID); you are free to provide your own adapters.
+ Several default adapters are given for objects (using their "id()"), strings (using string as
+ key) and for persistent objects (using their persistent OID); you are free to provide your
+ own adapters.
"""