summaryrefslogtreecommitdiff
path: root/docs/api/httpexceptions.rst
blob: 0fdd0f0e9baa3287a2204b2467a43ca04293a9c0 (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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.. _httpexceptions_module:

:mod:`pyramid.httpexceptions`
--------------------------------

.. automodule:: pyramid.httpexceptions

  .. attribute:: status_map

     A mapping of integer status code to HTTP exception class (eg. the integer
     "401" maps to :class:`pyramid.httpexceptions.HTTPUnauthorized`).  All
     mapped exception classes are children of :class:`pyramid.httpexceptions`,
     i.e. the :ref:`pyramid_specific_http_exceptions` such as
     :class:`pyramid.httpexceptions.HTTPBadRequest.BadCSRFToken` are not
     mapped.

  .. autofunction:: exception_response

  .. autoclass:: HTTPException

  .. autoclass:: HTTPOk

  .. autoclass:: HTTPRedirection

  .. autoclass:: HTTPError

  .. autoclass:: HTTPClientError

  .. autoclass:: HTTPServerError

  .. autoclass:: HTTPCreated

  .. autoclass:: HTTPAccepted

  .. autoclass:: HTTPNonAuthoritativeInformation

  .. autoclass:: HTTPNoContent

  .. autoclass:: HTTPResetContent

  .. autoclass:: HTTPPartialContent

  .. autoclass:: HTTPMultipleChoices

  .. autoclass:: HTTPMovedPermanently

  .. autoclass:: HTTPFound

  .. autoclass:: HTTPSeeOther

  .. autoclass:: HTTPNotModified

  .. autoclass:: HTTPUseProxy

  .. autoclass:: HTTPTemporaryRedirect

  .. autoclass:: HTTPBadRequest

  .. autoclass:: HTTPUnauthorized

  .. autoclass:: HTTPPaymentRequired

  .. autoclass:: HTTPForbidden

  .. autoclass:: HTTPNotFound

  .. autoclass:: HTTPMethodNotAllowed

  .. autoclass:: HTTPNotAcceptable

  .. autoclass:: HTTPProxyAuthenticationRequired

  .. autoclass:: HTTPRequestTimeout

  .. autoclass:: HTTPConflict

  .. autoclass:: HTTPGone

  .. autoclass:: HTTPLengthRequired

  .. autoclass:: HTTPPreconditionFailed

  .. autoclass:: HTTPRequestEntityTooLarge

  .. autoclass:: HTTPRequestURITooLong

  .. autoclass:: HTTPUnsupportedMediaType

  .. autoclass:: HTTPRequestRangeNotSatisfiable

  .. autoclass:: HTTPExpectationFailed

  .. autoclass:: HTTPUnprocessableEntity

  .. autoclass:: HTTPLocked

  .. autoclass:: HTTPFailedDependency

  .. autoclass:: HTTPInternalServerError

  .. autoclass:: HTTPNotImplemented

  .. autoclass:: HTTPBadGateway

  .. autoclass:: HTTPServiceUnavailable

  .. autoclass:: HTTPGatewayTimeout

  .. autoclass:: HTTPVersionNotSupported

  .. autoclass:: HTTPInsufficientStorage


.. _pyramid_specific_http_exceptions:

Pyramid-specific HTTP Exceptions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Each Pyramid-specific HTTP exception has the status code of it's parent.

  .. autoclass:: HTTPBadCSRFToken