diff options
Diffstat (limited to 'repoze/bfg/interfaces.py')
| -rw-r--r-- | repoze/bfg/interfaces.py | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/repoze/bfg/interfaces.py b/repoze/bfg/interfaces.py index 80a6bda26..cb0220a2e 100644 --- a/repoze/bfg/interfaces.py +++ b/repoze/bfg/interfaces.py @@ -77,8 +77,20 @@ class IRootFactory(Interface): class ITraverser(Interface): def __call__(environ): - """ Return a tuple in the form (context, name, subpath), typically - the result of an object graph traversal """ + """ Return a tuple in the form ``(context, view_name, subpath, + traversed, virtual_root, virtual_root_path)`` , typically the + result of an object graph traversal. ``context`` will be a + model object, ``view_name`` will be the view name used (a + Unicode name), ``subpath`` will be a sequence of Unicode names + that followed the view name but were not traversed, + ``traversed`` will be a sequence of Unicode names that were + traversed (including the virtual root path, if any) or + ``None`` if no traversal was performed, ``virtual_root`` will + be a model object representing the virtual root (or the + physical root if traversal was not performed), and + ``virtual_root_path`` will be a sequence representing the + virtual root path (a sequence of Unicode names) or None if + traversal was not performed.""" class ITraverserFactory(Interface): def __call__(context): |