- The import of ``repoze.bfg.view.NotFound`` is deprecated in favor of

  ``repoze.bfg.exceptions.NotFound``.  The old location still
  functions, but emits a deprecation warning.

- The import of ``repoze.bfg.security.Unauthorized`` is deprecated in
  favor of ``repoze.bfg.exceptions.Forbidden``.  The old location
  still functions but emits a deprecation warning.  The rename from
  ``Unauthorized`` to ``Forbidden`` brings parity to the the name of
  the exception and the system view it invokes when raised.

- New ``repoze.bfg.exceptions`` module was created to house exceptions
  that were previously sprinkled through various modules.

- An ``exceptions`` API chapter was added, documenting the new
  ``repoze.bfg.exceptions`` module.

1 files changed, 24 insertions, 0 deletions

diff --git a/repoze/bfg/exceptions.py b/repoze/bfg/exceptions.py
new file mode 100644
index 000000000..afd617a2c
--- /dev/null
+++ b/repoze/bfg/exceptions.py
@@ -0,0 +1,24 @@
+class Forbidden(Exception):
+    """\
+    Raise this exception within :term:`view` code to immediately
+    return the Forbidden view to the invoking user.  Usually this is a
+    basic ``401`` page, but the Forbidden view can be customized as
+    necessary.  See :ref:`changing_the_forbidden_view`.
+
+    This exception's constructor accepts a single positional argument,
+    which should be a string.  The value of this string will be placed
+    into the WSGI environment under the ``repoze.bfg.message`` key,
+    for availability to the Forbidden view."""
+
+class NotFound(Exception):
+    """\
+    Raise this exception within :term:`view` code to immediately
+    return the Not Found view to the invoking user.  Usually this is a
+    basic ``404`` page, but the Not Found view can be customized as
+    necessary.  See :ref:`changing_the_notfound_view`.
+
+    This exception's constructor accepts a single positional argument,
+    which should be a string.  The value of this string will be placed
+    into the WSGI environment under the ``repoze.bfg.message`` key,
+    for availability to the Not Found view."""
+