summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-05-29 04:45:55 -0400
committerChris McDonough <chrism@plope.com>2011-05-29 04:45:55 -0400
commit8662ce04c7a2a2dd490761f330336e4c3e156c7d (patch)
tree04e7ee5882518fc23f642eb978717a82eb0c564a
parent43378f78c0108831f3e07717c5213f1fd17a3d39 (diff)
downloadpyramid-8662ce04c7a2a2dd490761f330336e4c3e156c7d.tar.gz
pyramid-8662ce04c7a2a2dd490761f330336e4c3e156c7d.tar.bz2
pyramid-8662ce04c7a2a2dd490761f330336e4c3e156c7d.zip
docs fixes
-rw-r--r--pyramid/exceptions.py30
1 files changed, 17 insertions, 13 deletions
diff --git a/pyramid/exceptions.py b/pyramid/exceptions.py
index 8b3c75549..46367d4ef 100644
--- a/pyramid/exceptions.py
+++ b/pyramid/exceptions.py
@@ -3,8 +3,9 @@ HTTP Exceptions
---------------
This module contains Pyramid HTTP exception classes. Each class relates to a
-single HTTP status code. Each class is a subclass of the `~HTTPException`.
-Each exception class is also a :term:`response` object.
+single HTTP status code. Each class is a subclass of the
+:class:`~HTTPException`. Each exception class is also a :term:`response`
+object.
Each exception class has a status code according to `RFC 2068
<http://www.ietf.org/rfc/rfc2068.txt>`: codes with 100-300 are not really
@@ -76,10 +77,10 @@ Each HTTP exception has the following attributes:
the template via ${detail}
``body_template``
- a content fragment (in HTML) used for environment and
- header substitution; the default template includes both
+ a ``String.template``-format content fragment used for environment
+ and header substitution; the default template includes both
the explanation and further detail provided in the
- message
+ message.
Each HTTP exception accepts the following parameters:
@@ -94,7 +95,7 @@ Each HTTP exception accepts the following parameters:
usually stripped/hidden for end-users
``body_template``
- a string.Template object containing a content fragment in HTML
+ a ``string.Template`` object containing a content fragment in HTML
that frames the explanation and further detail
Substitution of response headers into template values is always performed.
@@ -108,15 +109,14 @@ The subclasses of :class:`~_HTTPMove`
field. Reflecting this, these subclasses have one additional keyword argument:
``location``, which indicates the location to which to redirect.
"""
-
import types
from string import Template
-from webob import Response
from webob import html_escape as _html_escape
-
from zope.configuration.exceptions import ConfigurationError as ZCE
from zope.interface import implements
+
from pyramid.interfaces import IExceptionResponse
+from pyramid.response import Response
def _no_escape(value):
if value is None:
@@ -1008,24 +1008,28 @@ class ConfigurationError(ZCE):
def abort(status_code, **kw):
- """Aborts the request immediately by raising an HTTP exception. The
- values in ``*kw`` will be passed to the HTTP exception constructor.
- Example::
+ """Aborts the request immediately by raising an HTTP exception based on a
+ status code. Example::
abort(404) # raises an HTTPNotFound exception.
+
+ The values passed as ``kw`` are provided to the exception's constructor.
"""
exc = status_map[status_code](**kw)
raise exc
def redirect(url, code=302, **kw):
- """Raises a redirect exception to the specified URL.
+ """Raises an :class:`~HTTPFound` (302) redirect exception to the
+ URL specified by ``url``.
Optionally, a code variable may be passed with the status code of
the redirect, ie::
redirect(route_url('foo', request), code=303)
+ The values passed as ``kw`` are provided to the exception constructor.
+
"""
exc = status_map[code]
raise exc(location=url, **kw)