pyams/pyams_utils: comparison src/pyams

equal deleted inserted replaced

-:2022e4da3ad9
+:63284c98cdc1
 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
 # FOR A PARTICULAR PURPOSE.
 #
-__docformat__ = 'restructuredtext'
+"""PyAMS_utils.traversing module
+This module provides a custom Pyramid "namespace" traverser: using "++name++" URLs allows
+to traverse URLs based on custom traversing adapters.
+It also provides a "get_parent" function, which returns a parent object of given object providing
+a given interface.
+"""
 from pyramid.compat import decode_path_info, is_nonstr_iter
 from pyramid.exceptions import NotFound, URLDecodeError
 from pyramid.interfaces import VH_ROOT_KEY
 from pyramid.location import lineage
 from pyams_utils.adapter import ContextAdapter, adapter_config
 from pyams_utils.interfaces.traversing import IPathElements
 from pyams_utils.registry import query_utility
+__docformat__ = 'restructuredtext'
 class NamespaceTraverser(ResourceTreeTraverser):
 """Custom traverser handling views and namespaces
 This is an upgraded version of native Pyramid traverser.
 It adds:
 PLUS_SELECTOR = '+'
 NAMESPACE_SELECTOR = PLUS_SELECTOR * 2
 def __call__(self, request):
+# pylint: disable=too-many-locals,too-many-branches,too-many-statements
 environ = request.environ
 matchdict = request.matchdict
 if matchdict is not None:
 path = matchdict.get('traverse', slash) or slash
 # empty if mounted under a path in mod_wsgi, for example
 path = request.path_info or slash
 except KeyError:
 # if environ['PATH_INFO'] is just not there
 path = slash
-except UnicodeDecodeError as e:
+except UnicodeDecodeError as exc:
-raise URLDecodeError(e.encoding, e.object, e.start, e.end, e.reason)
+raise URLDecodeError(exc.encoding, exc.object, exc.start, exc.end, exc.reason)
 if VH_ROOT_KEY in environ:
 # HTTP_X_VHM_ROOT
 vroot_path = decode_path_info(environ[VH_ROOT_KEY])
 vroot_tuple = split_path_info(vroot_path)
 vroot_tuple = ()
 vpath = path
 vroot_idx = -1
 root = self.root
-ob = vroot = root
+obj = vroot = root
 request.registry.notify(BeforeTraverseEvent(root, request))
 if vpath == slash:
 # invariant: vpath must not be empty
 ns_selector = self.NAMESPACE_SELECTOR
 view_selector = self.VIEW_SELECTOR
 vpath_tuple = split_path_info(vpath)
 for segment in vpath_tuple:
-if ob is not root:
+if obj is not root:
-request.registry.notify(BeforeTraverseEvent(ob, request))
+request.registry.notify(BeforeTraverseEvent(obj, request))
 if segment == plus_selector:
 # check for custom namespace called '+'
-# currently this namespace is used in PyAMS_default_theme package to get direct access to a given
+# currently this namespace is used in PyAMS_default_theme package to get
-# content
+# direct access to a given content
 registry = get_current_registry()
-traverser = registry.queryMultiAdapter((ob, request), ITraversable, '+')
+traverser = registry.queryMultiAdapter((obj, request), ITraversable, '+')
 if traverser is None:
 raise NotFound()
 try:
-ob = traverser.traverse(vpath_tuple[vroot_idx + i + 2], vpath_tuple[vroot_idx + i + 3:])
+obj = traverser.traverse(vpath_tuple[vroot_idx + i + 2],
+vpath_tuple[vroot_idx + i + 3:])
 except IndexError:
-# the "+" namespace traverser is waiting for additional elements from input URL
+# the "+" namespace traverser is waiting for additional elements from
-# so a "+" URL not followed by something else is just an error!
+# input URL so a "+" URL not followed by something else is just an error!
 raise NotFound()
 else:
 i += 1
 return {
-'context': ob,
+'context': obj,
 'view_name': ''.join(vpath_tuple[vroot_idx + i + 2:]),
 'subpath': vpath_tuple[i + 2:],
 'traversed': vpath_tuple[:vroot_idx + i + 2],
 'virtual_root': vroot,
 'virtual_root_path': vroot_tuple,
 'root': root
 }
 elif segment[:2] == ns_selector:
 # check for namespace prefixed by '++'
-# when a namespace is detected, named "ITraversable" multi-adapters are searched for
+# when a namespace is detected, named "ITraversable" multi-adapters are
-# context and request, or for context, sequentially; a NotFound exception is raised if traverser
+# searched for context and request, or for context, sequentially; a NotFound
-# can't be found, otherwise it's "traverse" method is called to get new context
+# exception is raised if traverser can't be found, otherwise it's "traverse"
-ns, name = segment[2:].split(ns_selector, 1)
+# method is called to get new context
+nss, name = segment[2:].split(ns_selector, 1)
 registry = get_current_registry()
-traverser = registry.queryMultiAdapter((ob, request), ITraversable, ns)
+traverser = registry.queryMultiAdapter((obj, request), ITraversable, nss)
 if traverser is None:
-traverser = registry.queryAdapter(ob, ITraversable, ns)
+traverser = registry.queryAdapter(obj, ITraversable, nss)
 if traverser is None:
 raise NotFound()
-ob = traverser.traverse(name, vpath_tuple[vroot_idx + i + 1:])
+obj = traverser.traverse(name, vpath_tuple[vroot_idx + i + 1:])
 i += 1
 continue
 elif segment[:2] == view_selector:
 # check for view name prefixed by '@@'
 return {
-'context': ob,
+'context': obj,
 'view_name': segment[2:],
 'subpath': vpath_tuple[i + 1:],
 'traversed': vpath_tuple[:vroot_idx + i + 1],
 'virtual_root': vroot,
 'virtual_root_path': vroot_tuple,
 'root': root
 }
 try:
-getitem = ob.__getitem__
+getitem = obj.__getitem__
 except AttributeError:
 return {
-'context': ob,
+'context': obj,
 'view_name': segment,
 'subpath': vpath_tuple[i + 1:],
 'traversed': vpath_tuple[:vroot_idx + i + 1],
 'virtual_root': vroot,
 'virtual_root_path': vroot_tuple,
 'root': root
 }
 try:
-next = getitem(segment)
+next_item = getitem(segment)
 except KeyError:
 return {
-'context': ob,
+'context': obj,
 'view_name': segment,
 'subpath': vpath_tuple[i + 1:],
 'traversed': vpath_tuple[:vroot_idx + i + 1],
 'virtual_root': vroot,
 'virtual_root_path': vroot_tuple,
 'root': root
 }
 if i == vroot_idx:
-vroot = next
+vroot = next_item
-ob = next
+obj = next_item
 i += 1
-if ob is not root:
+if obj is not root:
-request.registry.notify(BeforeTraverseEvent(ob, request))
+request.registry.notify(BeforeTraverseEvent(obj, request))
 return {
-'context': ob,
+'context': obj,
 'view_name': empty,
 'subpath': subpath,
 'traversed': vpath_tuple,
 'virtual_root': vroot,
 'virtual_root_path': vroot_tuple,
 def get_parent(context, interface=Interface, allow_context=True, condition=None):
 """Get first parent of the context that implements given interface
 :param object context: base element
 :param Interface interface: the interface that parend should implement
-:param boolean allow_context: if 'True' (the default), traversing is done starting with context; otherwise,
+:param boolean allow_context: if 'True' (the default), traversing is done starting with
-traversing is done starting from context's parent
+context; otherwise, traversing is done starting from context's parent
-:param callable condition: an optional function that should return a 'True' result when called with parent
+:param callable condition: an optional function that should return a 'True' result when
-as first argument
+called with parent as first argument
 """
 if allow_context:
 parent = context
 else:
 parent = getattr(context, '__parent__', None)
 be able to search object based on a given parent
 """
 @property
 def parents(self):
+"""Get list of parents OIDs"""
 intids = query_utility(IIntIds)
 if intids is None:
 return []
 return [intids.register(parent) for parent in lineage(self.context)]

branch	dev-tf
changeset 427	63284c98cdc1
parent 329	1482a4b86075