--- a/src/pyams_utils/site.py Wed Nov 20 19:26:23 2019 +0100
+++ b/src/pyams_utils/site.py Fri Nov 22 18:51:37 2019 +0100
@@ -10,33 +10,33 @@
# FOR A PARTICULAR PURPOSE.
#
-__docformat__ = 'restructuredtext'
-
-
-# import standard library
+"""PyAMS_utils.site module
+"""
-# import interfaces
-from pyams_utils.interfaces import PYAMS_APPLICATION_SETTINGS_KEY, PYAMS_APPLICATION_DEFAULT_NAME, \
- PYAMS_APPLICATION_FACTORY_KEY, PUBLIC_PERMISSION
-from pyams_utils.interfaces.site import ISiteRoot, ISiteRootFactory, INewLocalSiteCreatedEvent, ISiteUpgradeEvent, \
- ISiteGenerations, SITE_GENERATIONS_KEY, IConfigurationManager
-from zope.component.interfaces import IPossibleSite, ObjectEvent
+from persistent.dict import PersistentDict
+from pyramid.exceptions import NotFound
+from pyramid.path import DottedNameResolver
+from pyramid.security import ALL_PERMISSIONS, Allow, Everyone
+from pyramid.threadlocal import get_current_registry
+from pyramid_zodbconn import get_connection
+from zope.component import hooks
+from zope.component.interfaces import IPossibleSite
+from zope.container.folder import Folder
+from zope.interface import implementer
+from zope.interface.interfaces import ObjectEvent
+from zope.lifecycleevent import ObjectCreatedEvent
+from zope.site.site import LocalSiteManager, SiteManagerContainer
from zope.traversing.interfaces import ITraversable
-# import packages
-from persistent.dict import PersistentDict
-from pyams_utils.adapter import adapter_config, ContextAdapter, get_annotation_adapter
+from pyams_utils.adapter import ContextAdapter, adapter_config, get_annotation_adapter
+from pyams_utils.interfaces import PUBLIC_PERMISSION, PYAMS_APPLICATION_DEFAULT_NAME, \
+ PYAMS_APPLICATION_FACTORY_KEY, PYAMS_APPLICATION_SETTINGS_KEY
+from pyams_utils.interfaces.site import IConfigurationManager, INewLocalSiteCreatedEvent, \
+ ISiteGenerations, ISiteRoot, ISiteRootFactory, ISiteUpgradeEvent, SITE_GENERATIONS_KEY
from pyams_utils.registry import get_utilities_for, query_utility
-from pyramid.exceptions import NotFound
-from pyramid.path import DottedNameResolver
-from pyramid.security import Allow, Everyone, ALL_PERMISSIONS
-from pyramid.threadlocal import get_current_registry
-from pyramid_zodbconn import get_connection
-from zope.container.folder import Folder
-from zope.interface import implementer
-from zope.lifecycleevent import ObjectCreatedEvent
-from zope.site import hooks
-from zope.site.site import LocalSiteManager, SiteManagerContainer
+
+
+__docformat__ = 'restructuredtext'
@implementer(ISiteRoot, IConfigurationManager)
@@ -139,7 +139,8 @@
if not current:
print("Upgrading {0} to generation {1}...".format(name, utility.generation))
elif current < utility.generation:
- print("Upgrading {0} from generation {1} to {2}...".format(name, current, utility.generation))
+ print("Upgrading {0} from generation {1} to {2}...".format(name, current,
+ utility.generation))
utility.evolve(application, current)
generations[name] = utility.generation
finally:
@@ -152,14 +153,16 @@
def check_required_utilities(site, utilities):
"""Utility function to check for required utilities
- :param object site: the site manager into which configuration may be checked
- :param tuple utilities: each element of the tuple is another tuple made of the utility interface,
- the utility registration name, the utility factory and the object name when creating the utility, as in:
+ :param ISite site: the site manager into which configuration may be checked
+ :param tuple utilities: each element of the tuple is another tuple made of the utility
+ interface, the utility registration name, the utility factory and the object name when
+ creating the utility, as in:
.. code-block:: python
REQUIRED_UTILITIES = ((ISecurityManager, '', SecurityManager, 'Security manager'),
- (IPrincipalAnnotationUtility, '', PrincipalAnnotationUtility, 'User profiles'))
+ (IPrincipalAnnotationUtility, '', PrincipalAnnotationUtility,
+ 'User profiles'))
"""
registry = get_current_registry()
for interface, name, factory, default_id in utilities: