summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-05-16 02:11:56 -0400
committerChris McDonough <chrism@plope.com>2011-05-16 02:11:56 -0400
commit1ffb8e3cc21603b29ccd78152f82cca7f61a09b1 (patch)
treea58614dbc7ccbd49d2f8a744e2c5aea01b24e444 /docs/api
parent2ce65257cce304bd0f14d3b1bd4fd83ab957398b (diff)
downloadpyramid-1ffb8e3cc21603b29ccd78152f82cca7f61a09b1.tar.gz
pyramid-1ffb8e3cc21603b29ccd78152f82cca7f61a09b1.tar.bz2
pyramid-1ffb8e3cc21603b29ccd78152f82cca7f61a09b1.zip
- Added API docs for ``pyramid.httpexceptions.abort`` and
``pyramid.httpexceptions.redirect``. - Added "HTTP Exceptions" section to Views narrative chapter including a description of ``pyramid.httpexceptions.abort``; adjusted redirect section to note ``pyramid.httpexceptions.redirect``. - A default exception view for the context ``webob.exc.HTTPException`` (aka ``pyramid.httpexceptions.HTTPException``) is now registered by default. This means that an instance of any exception class imported from ``pyramid.httpexceptions`` (such as ``HTTPFound``) can now be raised from within view code; when raised, this exception view will render the exception to a response. - New functions named ``pyramid.httpexceptions.abort`` and ``pyramid.httpexceptions.redirect`` perform the equivalent of their Pylons brethren when an HTTP exception handler is registered. These functions take advantage of the newly registered exception view for ``webob.exc.HTTPException``. - The Configurator now accepts an additional keyword argument named ``httpexception_view``. By default, this argument is populated with a default exception view function that will be used when an HTTP exception is raised. When ``None`` is passed for this value, an exception view for HTTP exceptions will not be registered. Passing ``None`` returns the behavior of raising an HTTP exception to that of Pyramid 1.0 (the exception will propagate to middleware and to the WSGI server).
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/httpexceptions.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/api/httpexceptions.rst b/docs/api/httpexceptions.rst
index 57ca8092c..73da4126b 100644
--- a/docs/api/httpexceptions.rst
+++ b/docs/api/httpexceptions.rst
@@ -5,6 +5,10 @@
.. automodule:: pyramid.httpexceptions
+ .. autofunction:: abort
+
+ .. autofunction:: redirect
+
.. attribute:: status_map
A mapping of integer status code to exception class (eg. the