Файл: pyramid.pdf

47.1. HTTP EXCEPTIONS

class HTTPMultipleChoices(location=’‘, detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of _HTTPMove

This indicates that the requested resource corresponds to any one of a set of representations, each with its own specific location, and agent-driven negotiation information is being provided so that the user can select a preferred representation and redirect its request to that location.

code: 300, title: Multiple Choices

class HTTPMovedPermanently(location=’‘, detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of _HTTPMove

This indicates that the requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs.

code: 301, title: Moved Permanently

class HTTPFound(location=’‘, detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of _HTTPMove

This indicates that the requested resource resides temporarily under a different URI.

code: 302, title: Found

class HTTPSeeOther(location=’‘, detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of _HTTPMove

This indicates that the response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource.

code: 303, title: See Other

class HTTPNotModified(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPRedirection

This indicates that if the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code.

code: 304, title: Not Modified

575

47. PYRAMID.HTTPEXCEPTIONS

class HTTPUseProxy(location=’‘, detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of _HTTPMove

This indicates that the requested resource MUST be accessed through the proxy given by the Location field.

code: 305, title: Use Proxy

class HTTPTemporaryRedirect(location=’‘, detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of _HTTPMove

This indicates that the requested resource resides temporarily under a different URI.

code: 307, title: Temporary Redirect

class HTTPBadRequest(detail=None, headers=None, comment=None, body_template=None, **kw)

class HTTPUnauthorized(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indicates that the request requires user authentication.

code: 401, title: Unauthorized

class HTTPPaymentRequired(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

code: 402, title: Payment Required

class HTTPForbidden(detail=None, headers=None, comment=None, body_template=None,

result=None, **kw) subclass of HTTPClientError

This indicates that the server understood the request, but is refusing to fulfill it.

code: 403, title: Forbidden

Raise this exception within view code to immediately return the forbidden view to the invoking user. Usually this is a basic 403 page, but the forbidden view can be customized as necessary. See

576

47.1. HTTP EXCEPTIONS

Changing the Forbidden View. A Forbidden exception will be the context of a Forbidden View.

This exception’s constructor treats two arguments specially. The first argument, detail, should be a string. The value of this string will be used as the message attribute of the exception object. The second special keyword argument, result is usually an instance of pyramid.security.Denied or pyramid.security.ACLDenied each of which indicates a reason for the forbidden error. However, result is also permitted to be just a plain boolean False object or None. The result value will be used as the result attribute of the exception object. It defaults to None.

The Forbidden View can use the attributes of a Forbidden exception as necessary to provide extended information in an error report shown to a user.

class HTTPNotFound(detail=None, headers=None, comment=None, body_template=None,

**kw) subclass of HTTPClientError

This indicates that the server did not find anything matching the Request-URI.

code: 404, title: Not Found

Raise this exception within view code to immediately return the Not Found view to the invoking user. Usually this is a basic 404 page, but the Not Found view can be customized as necessary. See

Changing the Not Found View.

This exception’s constructor accepts a detail argument (the first argument), which should be a string. The value of this string will be available as the message attribute of this exception, for availability to the Not Found View.

class HTTPMethodNotAllowed(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indicates that the method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

code: 405, title: Method Not Allowed

class HTTPNotAcceptable(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indicates the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

code: 406, title: Not Acceptable

577

47. PYRAMID.HTTPEXCEPTIONS

class HTTPProxyAuthenticationRequired(detail=None, headers=None, com-

ment=None, body_template=None, **kw)

subclass of HTTPClientError

This is similar to 401, but indicates that the client must first authenticate itself with the proxy.

code: 407, title: Proxy Authentication Required

class HTTPRequestTimeout(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indicates that the client did not produce a request within the time that the server was prepared to wait.

code: 408, title: Request Timeout

class HTTPConflict(detail=None, headers=None, comment=None, body_template=None,

**kw) subclass of HTTPClientError

This indicates that the request could not be completed due to a conflict with the current state of the resource.

code: 409, title: Conflict

class HTTPGone(detail=None, headers=None, comment=None, body_template=None, **kw) subclass of HTTPClientError

This indicates that the requested resource is no longer available at the server and no forwarding address is known.

code: 410, title: Gone

class HTTPLengthRequired(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indicates that the the server refuses to accept the request without a defined Content-Length.

code: 411, title: Length Required

578

This indicates that the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.

code: 412, title: Precondition Failed

class HTTPRequestEntityTooLarge(detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of HTTPClientError

This indicates that the server is refusing to process a request because the request entity is larger than the server is willing or able to process.

code: 413, title: Request Entity Too Large

class HTTPRequestURITooLong(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indicates that the server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.

code: 414, title: Request-URI Too Long

class HTTPUnsupportedMediaType(detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of HTTPClientError

This indicates that the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.

code: 415, title: Unsupported Media Type

class HTTPRequestRangeNotSatisfiable(detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of HTTPClientError

The server SHOULD return a response with this status code if a request included a Range requestheader field, and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field.

code: 416, title: Request Range Not Satisfiable

579

47. PYRAMID.HTTPEXCEPTIONS

class HTTPExpectationFailed(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indidcates that the expectation given in an Expect request-header field could not be met by this server.

code: 417, title: Expectation Failed

class HTTPUnprocessableEntity(detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of HTTPClientError

This indicates that the server is unable to process the contained instructions. Only for WebDAV.

code: 422, title: Unprocessable Entity

class HTTPLocked(detail=None, headers=None, comment=None, body_template=None,

**kw)

subclass of HTTPClientError

This indicates that the resource is locked. Only for WebDAV

code: 423, title: Locked

class HTTPFailedDependency(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPClientError

This indicates that the method could not be performed because the requested action depended on another action and that action failed. Only for WebDAV.

This indicates that the server does not support the functionality required to fulfill the request.

code: 501, title: Not Implemented

580

47.1. HTTP EXCEPTIONS

class HTTPBadGateway(detail=None, headers=None, comment=None, body_template=None,

**kw) subclass of HTTPServerError

This indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

code: 502, title: Bad Gateway

class HTTPServiceUnavailable(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPServerError

This indicates that the server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

code: 503, title: Service Unavailable

class HTTPGatewayTimeout(detail=None, headers=None, comment=None,

body_template=None, **kw) subclass of HTTPServerError

This indicates that the server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.

code: 504, title: Gateway Timeout

class HTTPVersionNotSupported(detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of HTTPServerError

This indicates that the server does not support, or refuses to support, the HTTP protocol version that was used in the request message.

code: 505, title: HTTP Version Not Supported

class HTTPInsufficientStorage(detail=None, headers=None, comment=None,

body_template=None, **kw)

subclass of HTTPServerError

This indicates that the server does not have enough space to save the resource.

code: 507, title: Insufficient Storage

581

47. PYRAMID.HTTPEXCEPTIONS

582