summaryrefslogtreecommitdiff
path: root/repoze/bfg/exceptions.py
blob: a50da36b221fe2f72dc80b9df103173d16ff92e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
from zope.configuration.exceptions import ConfigurationError as ZCE

class Forbidden(Exception):
    """\
    Raise this exception within :term:`view` code to immediately
    return the :term:`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 :term:`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."""

class ConfigurationError(ZCE):
    """ Raised when inappropriate input values are supplied to an API
    method of a :term:`Configurator`"""