Skip to content

docs(redirects): clarify headers argument on redirect exceptions #2677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chucknuris wants to merge 3 commits into
base: master
Choose a base branch
from
+21 −0
Open

docs(redirects): clarify headers argument on redirect exceptions #2677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8c61d4
docs(redirects): clarify headers argument on redirect exceptions
chucknuris Jul 5, 2026
c917b7f
Merge branch 'master' into docs/clarify-redirect-headers
vytas7 Jul 13, 2026
ff42b86
Merge branch 'master' into docs/clarify-redirect-headers
vytas7 Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/_newsfragments/1920.misc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
The ``headers`` argument of the redirect exceptions
(:class:`~falcon.HTTPMovedPermanently`, :class:`~falcon.HTTPFound`,
:class:`~falcon.HTTPSeeOther`, :class:`~falcon.HTTPTemporaryRedirect`, and
:class:`~falcon.HTTPPermanentRedirect`) is now documented. The accompanying
docstrings clarify that these headers are merged into the ones already set on
the response, and are unrelated to the headers of the incoming request.
15 changes: 15 additions & 0 deletions falcon/redirects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ class HTTPMovedPermanently(HTTPStatus):
Args:
location (str): URI to provide as the Location header in the
response.
headers (dict): Extra headers to add to the response. These are
merged into the headers already set on the response; they
are not related to the headers of the incoming request.
"""

def __init__(self, location: str, headers: Headers | None = None) -> None:
Expand Down Expand Up @@ -70,6 +73,9 @@ class HTTPFound(HTTPStatus):
Args:
location (str): URI to provide as the Location header in the
response.
headers (dict): Extra headers to add to the response. These are
merged into the headers already set on the response; they
are not related to the headers of the incoming request.
"""

def __init__(self, location: str, headers: Headers | None = None) -> None:
Expand Down Expand Up @@ -104,6 +110,9 @@ class HTTPSeeOther(HTTPStatus):
Args:
location (str): URI to provide as the Location header in the
response.
headers (dict): Extra headers to add to the response. These are
merged into the headers already set on the response; they
are not related to the headers of the incoming request.
"""

def __init__(self, location: str, headers: Headers | None = None) -> None:
Expand Down Expand Up @@ -133,6 +142,9 @@ class HTTPTemporaryRedirect(HTTPStatus):
Args:
location (str): URI to provide as the Location header in the
response.
headers (dict): Extra headers to add to the response. These are
merged into the headers already set on the response; they
are not related to the headers of the incoming request.
"""

def __init__(self, location: str, headers: Headers | None = None) -> None:
Expand All @@ -159,6 +171,9 @@ class HTTPPermanentRedirect(HTTPStatus):
Args:
location (str): URI to provide as the Location header in the
response.
headers (dict): Extra headers to add to the response. These are
merged into the headers already set on the response; they
are not related to the headers of the incoming request.
"""

def __init__(self, location: str, headers: Headers | None = None) -> None:
Expand Down
Loading