# Copyright 2013 by Rackspace Hosting, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from datetime import datetime
from falcon.http_error import HTTPError, NoRepresentation, \
OptionalRepresentation
import falcon.status_codes as status
from falcon import util
[docs]class HTTPBadRequest(HTTPError):
"""400 Bad Request.
The request could not be understood by the server due to malformed
syntax. The client SHOULD NOT repeat the request without
modifications. (RFC 2616)
Args:
title (str): Error title (e.g., 'TTL Out of Range').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPBadRequest, self).__init__(status.HTTP_400, title,
description, **kwargs)
[docs]class HTTPUnauthorized(HTTPError):
"""401 Unauthorized.
Use when authentication is required, and the provided credentials are
not valid, or no credentials were provided in the first place.
Args:
title (str): Error title (e.g., 'Authentication Required').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
challenges (iterable of str): One or more authentication
challenges to use as the value of the WWW-Authenticate header in
the response. See also:
http://tools.ietf.org/html/rfc7235#section-2.1
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, challenges, **kwargs):
headers = kwargs.setdefault('headers', {})
if challenges:
headers['WWW-Authenticate'] = ', '.join(challenges)
super(HTTPUnauthorized, self).__init__(status.HTTP_401, title,
description, **kwargs)
[docs]class HTTPForbidden(HTTPError):
"""403 Forbidden.
Use when the client's credentials are good, but they do not have permission
to access the requested resource.
If the request method was not HEAD and the server wishes to make
public why the request has not been fulfilled, it SHOULD describe the
reason for the refusal in the entity. If the server does not wish to
make this information available to the client, the status code 404
(Not Found) can be used instead. (RFC 2616)
Args:
title (str): Error title (e.g., 'Permission Denied').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPForbidden, self).__init__(status.HTTP_403, title,
description, **kwargs)
[docs]class HTTPNotFound(OptionalRepresentation, HTTPError):
"""404 Not Found.
Use this when the URL path does not map to an existing resource, or you
do not wish to disclose exactly why a request was refused.
"""
def __init__(self, **kwargs):
super(HTTPNotFound, self).__init__(status.HTTP_404, **kwargs)
[docs]class HTTPMethodNotAllowed(OptionalRepresentation, HTTPError):
"""405 Method Not Allowed.
The method specified in the Request-Line is not allowed for the
resource identified by the Request-URI. The response MUST include an
Allow header containing a list of valid methods for the requested
resource. (RFC 2616)
Args:
allowed_methods (list of str): Allowed HTTP methods for this
resource (e.g., ``['GET', 'POST', 'HEAD']``).
"""
def __init__(self, allowed_methods, **kwargs):
new_headers = {'Allow': ', '.join(allowed_methods)}
super(HTTPMethodNotAllowed, self).__init__(status.HTTP_405,
**kwargs)
if not self.headers:
self.headers = {}
self.headers.update(new_headers)
[docs]class HTTPNotAcceptable(HTTPError):
"""406 Not Acceptable.
The client requested a resource in a representation that is not
supported by the server. The client must indicate a supported
media type in the Accept header.
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. (RFC 2616)
Args:
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, description, **kwargs):
super(HTTPNotAcceptable, self).__init__(status.HTTP_406,
'Media type not acceptable',
description, **kwargs)
[docs]class HTTPConflict(HTTPError):
"""409 Conflict.
The request could not be completed due to a conflict with the current
state of the resource. This code is only allowed in situations where
it is expected that the user might be able to resolve the conflict
and resubmit the request. The response body SHOULD include enough
information for the user to recognize the source of the conflict.
Ideally, the response entity would include enough information for the
user or user agent to fix the problem; however, that might not be
possible and is not required.
Conflicts are most likely to occur in response to a PUT request. For
example, if versioning were being used and the entity being PUT
included changes to a resource which conflict with those made by an
earlier (third-party) request, the server might use the 409 response
to indicate that it can't complete the request. In this case, the
response entity would likely contain a list of the differences
between the two versions in a format defined by the response
Content-Type.
(RFC 2616)
Args:
title (str): Error title (e.g., 'Editing Conflict').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPConflict, self).__init__(status.HTTP_409, title,
description, **kwargs)
[docs]class HTTPLengthRequired(HTTPError):
"""411 Length Required.
The server refuses to accept the request without a defined
Content-Length. The client MAY repeat the request if it adds a
valid Content-Length header field containing the length of the
message-body in the request message. (RFC 2616)
Args:
title (str): Error title (e.g., 'Missing Content-Length').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPLengthRequired, self).__init__(status.HTTP_411,
title, description, **kwargs)
[docs]class HTTPPreconditionFailed(HTTPError):
"""412 Precondition Failed.
The precondition given in one or more of the request-header fields
evaluated to false when it was tested on the server. This response
code allows the client to place preconditions on the current resource
metainformation (header field data) and thus prevent the requested
method from being applied to a resource other than the one intended.
(RFC 2616)
Args:
title (str): Error title (e.g., 'Image Not Modified').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPPreconditionFailed, self).__init__(status.HTTP_412, title,
description, **kwargs)
class HTTPRequestEntityTooLarge(HTTPError):
"""413 Request Entity Too Large.
The server is refusing to process a request because the request
entity is larger than the server is willing or able to process. The
server MAY close the connection to prevent the client from continuing
the request.
If the condition is temporary, the server SHOULD include a Retry-
After header field to indicate that it is temporary and after what
time the client MAY try again.
(RFC 2616)
Args:
title (str): Error title (e.g., 'Request Body Limit Exceeded').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
retry_after (datetime or int, optional): Value for the Retry-After
header. If a ``datetime`` object, will serialize as an HTTP date.
Otherwise, a non-negative ``int`` is expected, representing the
number of seconds to wait.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, retry_after=None, **kwargs):
headers = kwargs.setdefault('headers', {})
if isinstance(retry_after, datetime):
headers['Retry-After'] = util.dt_to_http(retry_after)
elif retry_after is not None:
headers['Retry-After'] = str(retry_after)
super(HTTPRequestEntityTooLarge, self).__init__(status.HTTP_413,
title,
description,
**kwargs)
[docs]class HTTPRangeNotSatisfiable(NoRepresentation, HTTPError):
"""416 Range Not Satisfiable.
The requested range is not valid. See also: http://goo.gl/Qsa4EF
Args:
resource_length: The maximum value for the last-byte-pos of a range
request. Used to set the Content-Range header.
"""
def __init__(self, resource_length):
headers = {'Content-Range': 'bytes */' + str(resource_length)}
super(HTTPRangeNotSatisfiable, self).__init__(status.HTTP_416,
headers=headers)
[docs]class HTTPUnprocessableEntity(HTTPError):
"""422 Unprocessable Entity.
The request was well-formed but was unable to be followed due to semantic
errors. See also: http://www.ietf.org/rfc/rfc4918.
Args:
title (str): Error title (e.g., 'Missing title field').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPUnprocessableEntity, self).__init__(status.HTTP_422, title,
description, **kwargs)
[docs]class HTTPTooManyRequests(HTTPError):
"""429 Too Many Requests.
The user has sent too many requests in a given amount of time
("rate limiting").
The response representations SHOULD include details explaining the
condition, and MAY include a Retry-After header indicating how long
to wait before making a new request.
(RFC 6585)
Args:
title (str): Error title (e.g., 'Too Many Requests').
description (str): Human-friendly description of the rate limit that
was exceeded.
retry_after (datetime or int, optional): Value for the Retry-After
header. If a ``datetime`` object, will serialize as an HTTP date.
Otherwise, a non-negative ``int`` is expected, representing the
number of seconds to wait.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, retry_after=None, **kwargs):
headers = kwargs.setdefault('headers', {})
if isinstance(retry_after, datetime):
headers['Retry-After'] = util.dt_to_http(retry_after)
elif retry_after is not None:
headers['Retry-After'] = str(retry_after)
super(HTTPTooManyRequests, self).__init__(status.HTTP_429,
title,
description,
**kwargs)
[docs]class HTTPUnavailableForLegalReasons(OptionalRepresentation, HTTPError):
"""451 Unavailable For Legal Reasons.
This status code indicates that the server is denying access to the
resource as a consequence of a legal demand.
See also:
https://datatracker.ietf.org/doc/draft-ietf-httpbis-legally-restricted-status/
Args:
title (str): Error title (e.g., 'Legal reason: <reason>').
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, **kwargs):
super(HTTPUnavailableForLegalReasons, self).__init__(status.HTTP_451,
title, **kwargs)
[docs]class HTTPInternalServerError(HTTPError):
"""500 Internal Server Error.
Args:
title (str): Error title (e.g., 'This Should Never Happen').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPInternalServerError, self).__init__(status.HTTP_500, title,
description, **kwargs)
[docs]class HTTPBadGateway(HTTPError):
"""502 Bad Gateway.
Args:
title (str): Error title, for
example: 'Upstream Server is Unavailable'.
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, **kwargs):
super(HTTPBadGateway, self).__init__(status.HTTP_502, title,
description, **kwargs)
[docs]class HTTPServiceUnavailable(HTTPError):
"""503 Service Unavailable.
Args:
title (str): Error title (e.g., 'Temporarily Unavailable').
description (str): Human-friendly description of the error, along with
a helpful suggestion or two.
retry_after (datetime or int): Value for the Retry-After header. If a
``datetime`` object, will serialize as an HTTP date. Otherwise,
a non-negative ``int`` is expected, representing the number of
seconds to wait.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, title, description, retry_after, **kwargs):
headers = kwargs.setdefault('headers', {})
if isinstance(retry_after, datetime):
headers['Retry-After'] = util.dt_to_http(retry_after)
else:
headers['Retry-After'] = str(retry_after)
super(HTTPServiceUnavailable, self).__init__(status.HTTP_503,
title,
description,
**kwargs)
[docs]class HTTPInvalidParam(HTTPBadRequest):
"""A parameter in the request is invalid. Inherits from ``HTTPBadRequest``.
This error may refer to a parameter in a query string, form, or
document that was submitted with the request.
Args:
msg (str): A description of the invalid parameter.
param_name (str): The name of the parameter.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, msg, param_name, **kwargs):
description = 'The "{0}" parameter is invalid. {1}'
description = description.format(param_name, msg)
super(HTTPInvalidParam, self).__init__('Invalid parameter',
description, **kwargs)
[docs]class HTTPMissingParam(HTTPBadRequest):
"""A parameter is missing from the request. Inherits from ``HTTPBadRequest``.
This error may refer to a parameter in a query string, form, or
document that was submitted with the request.
Args:
param_name (str): The name of the parameter.
kwargs (optional): Same as for ``HTTPError``.
"""
def __init__(self, param_name, **kwargs):
description = 'The "{0}" parameter is required.'
description = description.format(param_name)
super(HTTPMissingParam, self).__init__('Missing parameter',
description, **kwargs)