From 596860a10e8356e72aa695f77c3c8c4dbf269c52 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Thu, 25 Aug 2011 02:34:57 -0500 Subject: Added docs for some missing HTTP status' supported in httpexceptions. --- docs/api/httpexceptions.rst | 8 ++++++++ pyramid/httpexceptions.py | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/docs/api/httpexceptions.rst b/docs/api/httpexceptions.rst index 89be17a2d..6a08d1048 100644 --- a/docs/api/httpexceptions.rst +++ b/docs/api/httpexceptions.rst @@ -87,6 +87,12 @@ .. autoclass:: HTTPExpectationFailed + .. autoclass:: HTTPUnprocessableEntity + + .. autoclass:: HTTPLocked + + .. autoclass:: HTTPFailedDependency + .. autoclass:: HTTPInternalServerError .. autoclass:: HTTPNotImplemented @@ -98,3 +104,5 @@ .. autoclass:: HTTPGatewayTimeout .. autoclass:: HTTPVersionNotSupported + + .. autoclass:: HTTPInsufficientStorage diff --git a/pyramid/httpexceptions.py b/pyramid/httpexceptions.py index fef4fe47e..dd3db3a9d 100644 --- a/pyramid/httpexceptions.py +++ b/pyramid/httpexceptions.py @@ -50,6 +50,9 @@ Exception * 415 - HTTPUnsupportedMediaType * 416 - HTTPRequestRangeNotSatisfiable * 417 - HTTPExpectationFailed + * 422 - HTTPUnprocessableEntity + * 423 - HTTPLocked + * 424 - HTTPFailedDependency HTTPServerError * 500 - HTTPInternalServerError * 501 - HTTPNotImplemented @@ -57,6 +60,7 @@ Exception * 503 - HTTPServiceUnavailable * 504 - HTTPGatewayTimeout * 505 - HTTPVersionNotSupported + * 507 - HTTPInsufficientStorage Each HTTP exception has the following attributes: -- cgit v1.2.3 From 5bcab687562b667e3e1ceb8ca9075e524c064d3a Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Thu, 25 Aug 2011 03:21:38 -0500 Subject: More explicitly discussed properties of HTTPException objects. --- pyramid/httpexceptions.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/pyramid/httpexceptions.py b/pyramid/httpexceptions.py index dd3db3a9d..0887b0eec 100644 --- a/pyramid/httpexceptions.py +++ b/pyramid/httpexceptions.py @@ -62,7 +62,10 @@ Exception * 505 - HTTPVersionNotSupported * 507 - HTTPInsufficientStorage -Each HTTP exception has the following attributes: +HTTP exceptions are also :term:`response` objects, thus they accept most of +the same parameters that can be passed to a regular +:class:`~pyramid.response.Response`. Each HTTP exception also has the +following attributes: ``code`` the HTTP status code for the exception @@ -86,7 +89,8 @@ Each HTTP exception has the following attributes: the explanation and further detail provided in the message. -Each HTTP exception accepts the following parameters: +Each HTTP exception accepts the following parameters, any others will +be forwarded to its :class:`~pyramid.response.Response` superclass: ``detail`` a plain-text override of the default ``detail`` @@ -102,6 +106,10 @@ Each HTTP exception accepts the following parameters: a ``string.Template`` object containing a content fragment in HTML that frames the explanation and further detail + ``body`` + a string that will override the ``body_template`` and be used as the + body of the response. + Substitution of response headers into template values is always performed. Substitution of WSGI environment values is performed if a ``request`` is passed to the exception's constructor. -- cgit v1.2.3