summaryrefslogtreecommitdiff
path: root/docs/whatsnew-1.1.rst
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/whatsnew-1.1.rst
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/whatsnew-1.1.rst')
-rw-r--r--docs/whatsnew-1.1.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/whatsnew-1.1.rst b/docs/whatsnew-1.1.rst
index 992e0b637..488328519 100644
--- a/docs/whatsnew-1.1.rst
+++ b/docs/whatsnew-1.1.rst
@@ -18,6 +18,9 @@ The major feature additions in Pyramid 1.1 are:
- Support for "static" routes.
+- Default HTTP exception view and associated ``redirect`` and ``abort``
+ convenience functions.
+
``request.response``
~~~~~~~~~~~~~~~~~~~~
@@ -50,6 +53,31 @@ Static Routes
be useful for URL generation via ``route_url`` and ``route_path``. See the
section entitled :ref:`static_route_narr` for more information.
+Default HTTP Exception View
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- A default exception view for the context :exc:`webob.exc.HTTPException`
+ (aka :class:`pyramid.httpexceptions.HTTPException`) is now registered by
+ default. This means that an instance of any exception class imported from
+ :mod:`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 convenience functions named :func:`pyramid.httpexceptions.abort` and
+ :func:`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
+ :exc:`webob.exc.HTTPException`.
+
+ To allow for configuration of this feature, the :term:`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).
+
Minor Feature Additions
-----------------------
@@ -222,3 +250,10 @@ Documentation Enhancements
- Added a section to the "URL Dispatch" narrative chapter regarding the new
"static" route feature entitled :ref:`static_route_narr`.
+
+- Added API docs for :func:`pyramid.httpexceptions.abort` and
+ :func:`pyramid.httpexceptions.redirect`.
+
+- Added :ref:`http_exceptions` section to Views narrative chapter including a
+ description of :func:`pyramid.httpexceptions.abort`` and
+ :func:`pyramid.httpexceptions.redirect`.