- The interface for ``repoze.bfg.interfaces.ITraverser`` and the

  built-in implementations that implement the interface
  (``repoze.bfg.traversal.ModelGraphTraverser``, and
  ``repoze.bfg.urldispatch.RoutesModelTraverser``) now expect the
  ``__call__`` method of an ITraverser to return 3 additional
  arguments: ``traversed``, ``virtual_root``, and
  ``virtual_root_path`` (the old contract was that the ``__call__``
  method of an ITraverser returned; three arguments, the contract new
  is that it returns six).  ``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.

  Six arguments are now returned from BFG ITraversers.  They are
  returned in this order: ``context``, ``view_name``, ``subpath``,
  ``traversed``, ``virtual_root``, and ``virtual_root_path``.

  Places in the BFG code which called an ITraverser continue to accept
  a 3-argument return value, although BFG will generate and log a
  warning when one is encountered.

- The request object now has the following attributes: ``traversed``
  (the sequence of names traversed or ``None`` if traversal was not
  performed), ``virtual_root`` (the model object representing the
  virtual root, including the virtual root path if any), and
  ``virtual_root_path`` (the seuquence of names representing the
  virtual root path or ``None`` if traversal was not performed).

- A new decorator named ``wsgiapp2`` was added to the
  ``repoze.bfg.wsgi`` module.  This decorator performs the same
  function as ``repoze.bfg.wsgi.wsgiapp`` except it fixes up the
  ``SCRIPT_NAME``, and ``PATH_INFO`` environment values before
  invoking the WSGI subapplication.

- The ``repoze.bfg.testing.DummyRequest`` object now has default
  attributes for ``traversed``, ``virtual_root``, and
  ``virtual_root_path``.

- The RoutesModelTraverser now behaves more like the Routes
  "RoutesMiddleware" object when an element in the match dict is named
  ``path_info`` (usually when there's a pattern like
  ``http://foo/*path_info``).  When this is the case, the
  ``PATH_INFO`` environment variable is set to the value in the match
  dict, and the ``SCRIPT_NAME`` is appended to with the prefix of the
  original ``PATH_INFO`` not including the value of the new variable.

- The notfound debug now shows the traversed path, the virtual root,
  and the virtual root path too.

1 files changed, 16 insertions, 0 deletions

diff --git a/docs/narr/traversal.rst b/docs/narr/traversal.rst
index 9ff7329c5..3977f46d0 100644
--- a/docs/narr/traversal.rst
+++ b/docs/narr/traversal.rst
@@ -282,6 +282,22 @@ The :term:`context` will always be available to a view as the
 ``context`` attribute of the :term:`request` object.  It will be the
 context object implied by the current request.
 
+The "traversal path" will always be available to a view as the
+``traversed`` attribute of the :term:`request` object.  It will be a
+sequence representing the ordered set of names that were used to
+traverse to the context, not including the view name or subpath.  If
+there is a virtual root associated with request, the virtual root path
+is included within the traversal path.
+
+The :term:`virtual root` will always be available to a view as the
+``virtual_root`` attribute of the :term:`request` object.  It will be
+the virtual root object implied by the current request.
+
+The :term:`virtual root path` will always be available to a view as
+the ``virtual_root_path`` attribute of the :term:`request` object.  It
+will be a sequence representing the ordered set of names that were
+used to traverse to the virtual root obejct.
+
 Unicode and Traversal
 ---------------------