summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/request.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/api/request.rst b/docs/api/request.rst
index 86202b830..08d8d76e1 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -73,6 +73,21 @@
:ref:`vhosting_chapter` for more information about virtual
roots.
+ .. attribute:: exception
+
+ If an exception was raised by a :term:`root factory` or a
+ :term:`view callable`, or at various other points where
+ :mod:`repoze.bfg` executes user-defined code during the
+ processing of a request, the exception object which was caught
+ will be available as the ``exception`` attribute of the request
+ within a :term:`exception view`, a :term:`response callback` or a
+ :term:`finished callback`. If no exception occurred, the value
+ of ``request.exception`` will be ``None`` within response and
+ finished callbacks.
+
+ .. note:: The exception attribute is new in :mod:`repoze.bfg`
+ 1.3.
+
.. autofunction:: make_request_ascii