Skip to content
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

Jump to bottom

linkcheck: support ignored-URIs for redirects #13127

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

linkcheck: support ignored-URIs for redirects #13127

wants to merge 15 commits into from
+67 −4

Conversation

jayaddison
Copy link
Contributor

Feature or Bugfix

  • Bugfix

Purpose

  • Server-issued HTTP redirects may refer the linkcheck client to URLs that the operator has configured as ignored using the linkcheck_ignore config setting. This changeset handles those redirections by returning an ignore result immediately, without following the redirect.

Detail

  • Override the requests.Session.get_redirect_target method so that we can raise a (Sphinx-internal) exception if we encounter a redirect to a configured ignore-URL.

Relates

jayaddison
jayaddison commented Nov 13, 2024
View reviewed changes
sphinx/util/requests.py Outdated
# do not follow redirections that match ignored URI patterns
if resp.is_redirect:
location = resp.headers['location']
dest = urljoin(resp.url, location)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd draw attention to this line in particular as possibly-dubious.

Servers often respond with relative Location redirects; but I think we want to match against more-fully-qualified URI paths.

jayaddison
jayaddison commented Nov 13, 2024
View reviewed changes
sphinx/util/requests.py Outdated Show resolved Hide resolved
@jayaddison jayaddison mentioned this pull request Nov 17, 2024
Open
jayaddison
jayaddison commented Nov 19, 2024
View reviewed changes
sphinx/util/requests.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner Awaiting requested review from AA-Turner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support linkcheck_ignore in link redirection
1 participant
@jayaddison