b213399473
Define a set of HTTPStatus subclasses that can be raised to perform various types of HTTP redirects. This should avoid the problem of hooks and responder methods possibly overriding the redirect. Raising an instance of one of these classes and will short-circuit request processing similar to raising an instance of HTTPError. Specifically, if raised in a before hook, it will skip any remaining hooks and the responder method, but will not skip any process_response middleware methods. If raised within a responder, it will skip the rest of the responder and all after hooks. If raised in an after hook, it would skip remaining after hooks but not middleware methods. And finally, if raised within a middleware method, execution would perceive as described at the bottom of [1]. The above behavior is inherited from HTTPStatus and so is not re-tested in the subclasses. [1]: https://falcon.readthedocs.org/en/stable/api/middleware.html Closes #406
47 lines
1.6 KiB
Python
47 lines
1.6 KiB
Python
# Copyright 2015 by Hurricane Labs LLC
|
|
#
|
|
# 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.
|
|
|
|
|
|
class HTTPStatus(Exception):
|
|
"""Represents a generic HTTP status.
|
|
|
|
Raise an instance of this class from a hook, middleware, or
|
|
responder to short-circuit request processing in a manner similar
|
|
to ``falcon.HTTPError``, but for non-error status codes.
|
|
|
|
Attributes:
|
|
status (str): HTTP status line, e.g. '748 Confounded by Ponies'.
|
|
headers (dict): Extra headers to add to the response.
|
|
body (str or unicode): String representing response content. If
|
|
Unicode, Falcon will encode as UTF-8 in the response.
|
|
|
|
Args:
|
|
status (str): HTTP status code and text, such as
|
|
'748 Confounded by Ponies'.
|
|
headers (dict): Extra headers to add to the response.
|
|
body (str or unicode): String representing response content. If
|
|
Unicode, Falcon will encode as UTF-8 in the response.
|
|
"""
|
|
|
|
__slots__ = (
|
|
'status',
|
|
'headers',
|
|
'body'
|
|
)
|
|
|
|
def __init__(self, status, headers=None, body=None):
|
|
self.status = status
|
|
self.headers = headers
|
|
self.body = body
|