docs(redirects): clarify headers argument on redirect exceptions#2677
Open
chucknuris wants to merge 3 commits into
Open
docs(redirects): clarify headers argument on redirect exceptions#2677chucknuris wants to merge 3 commits into
chucknuris wants to merge 3 commits into
Conversation
The redirect exceptions accept a headers argument, but its behavior was not documented, leading to confusion over whether these headers merge with the incoming request headers or the response headers. Document the headers argument on HTTPMovedPermanently, HTTPFound, HTTPSeeOther, HTTPTemporaryRedirect, and HTTPPermanentRedirect, clarifying that the headers are merged into those already set on the response and are unrelated to the request headers. Closes falconry#1920
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2677 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 64 64
Lines 7985 7985
Branches 1103 1103
=========================================
Hits 7985 7985 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The redirect exceptions (
HTTPMovedPermanently,HTTPFound,HTTPSeeOther,HTTPTemporaryRedirect,HTTPPermanentRedirect) accept aheadersargument, but it was undocumented. As raised in #1920, this left it ambiguous whether those headers merge with the incoming request headers or the response headers.This PR documents the
headersargument on all five redirect classes, clarifying that the headers are merged into those already set on the response, and are unrelated to the headers of the incoming request.Changes
headersentry to theArgs:docstring of each redirect exception infalcon/redirects.py.miscnews fragment (docs/_newsfragments/1920.misc.rst).Verification
ruff format --checkandruff checkpass (docstring-only change; no formatting impact).towncrier build --draftrenders the changelog entry correctly.Closes #1920