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

Use structural pattern matching to handle linkcheck result statuses #13049

Merged
merged 6 commits into from
Oct 20, 2024
Merged

Use structural pattern matching to handle linkcheck result statuses #13049

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3659a95
linkcheck: refactor logging code
jayaddison Oct 20, 2024
3704477
Refactor: use Structural Pattern Matching (`match`) to handle linksta…
jayaddison Oct 20, 2024
822e418
linkcheck: remove unused `old` message tag
jayaddison Oct 20, 2024
d9f7b64
linkcheck: exhaustively check status codes
jayaddison Oct 20, 2024
c6f8ba4
Lint fixup: apply `ruff format`
jayaddison Oct 20, 2024
6c1b3fb
Collapse if
AA-Turner Oct 20, 2024
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
168 changes: 81 additions & 87 deletions sphinx/builders/linkcheck.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,99 +111,93 @@ def process_result(self, result: CheckResult) -> None:
}
self.write_linkstat(linkstat)

if result.status == _Status.UNCHECKED:
return
if result.status == _Status.WORKING and result.message == 'old':
return
Comment on lines -116 to -117
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Commenting for future historians: the old message tag here was a way that the linkcheck component would communicate to itself that a hyperlink had already been checked and confirmed as working ('good').

That code was removed in 4351721, and I believe that the URI deduplication that was removed there is no longer necessary, because linkcheck nowadays collects hyperlinks in a Python dict, CheckExternalLinksBuilder.hyperlinks, keyed by the URI; so duplicates should not occur anyway.

if result.lineno:
if result.lineno and result.status != _Status.UNCHECKED:
# unchecked links are not logged
logger.info('(%16s: line %4d) ', result.docname, result.lineno, nonl=True)
if result.status == _Status.IGNORED:
if result.message:
logger.info(darkgray('-ignored- ') + result.uri + ': ' + result.message)
else:
logger.info(darkgray('-ignored- ') + result.uri)
elif result.status == _Status.LOCAL:
logger.info(darkgray('-local- ') + result.uri)
self.write_entry(
_Status.LOCAL,
result.docname,
filename,
result.lineno,
result.uri,
)
elif result.status == _Status.WORKING:
logger.info(darkgreen('ok ') + result.uri + result.message)
elif result.status == _Status.TIMEOUT:
if self.app.quiet:
logger.warning(
'timeout ' + result.uri + result.message,
location=(result.docname, result.lineno),
)
else:
logger.info(
red('timeout ') + result.uri + red(' - ' + result.message)
)
self.write_entry(
_Status.TIMEOUT,
result.docname,
filename,
result.lineno,
result.uri + ': ' + result.message,
)
self.timed_out_hyperlinks += 1
elif result.status == _Status.BROKEN:
if self.app.quiet:
logger.warning(
__('broken link: %s (%s)'),

match result.status:
case _Status.RATE_LIMITED | _Status.UNCHECKED:
pass
case _Status.IGNORED:
if result.message:
msg = darkgray('-ignored- ') + result.uri + ': ' + result.message
else:
msg = darkgray('-ignored- ') + result.uri
logger.info(msg)
case _Status.LOCAL:
logger.info(darkgray('-local- ') + result.uri)
self.write_entry(
_Status.LOCAL,
result.docname,
filename,
result.lineno,
result.uri,
result.message,
location=(result.docname, result.lineno),
)
else:
logger.info(
red('broken ') + result.uri + red(' - ' + result.message)
case _Status.WORKING:
logger.info(darkgreen('ok ') + result.uri + result.message)
case _Status.TIMEOUT:
if self.app.quiet:
msg = 'timeout ' + result.uri + result.message
logger.warning(msg, location=(result.docname, result.lineno))
else:
msg = red('timeout ') + result.uri + red(' - ' + result.message)
logger.info(msg)
self.write_entry(
_Status.TIMEOUT,
result.docname,
filename,
result.lineno,
result.uri + ': ' + result.message,
)
self.write_entry(
_Status.BROKEN,
result.docname,
filename,
result.lineno,
result.uri + ': ' + result.message,
)
self.broken_hyperlinks += 1
elif result.status == _Status.REDIRECTED:
try:
text, color = {
301: ('permanently', purple),
302: ('with Found', purple),
303: ('with See Other', purple),
307: ('temporarily', turquoise),
308: ('permanently', purple),
}[result.code]
except KeyError:
text, color = ('with unknown code', purple)
linkstat['text'] = text
if self.config.linkcheck_allowed_redirects:
logger.warning(
'redirect ' + result.uri + ' - ' + text + ' to ' + result.message,
location=(result.docname, result.lineno),
self.timed_out_hyperlinks += 1
case _Status.BROKEN:
if self.app.quiet:
logger.warning(
__('broken link: %s (%s)'),
result.uri,
result.message,
location=(result.docname, result.lineno),
)
else:
msg = red('broken ') + result.uri + red(' - ' + result.message)
logger.info(msg)
self.write_entry(
_Status.BROKEN,
result.docname,
filename,
result.lineno,
result.uri + ': ' + result.message,
)
else:
logger.info(
color('redirect ')
+ result.uri
+ color(' - ' + text + ' to ' + result.message)
self.broken_hyperlinks += 1
case _Status.REDIRECTED:
try:
text, color = {
301: ('permanently', purple),
302: ('with Found', purple),
303: ('with See Other', purple),
307: ('temporarily', turquoise),
308: ('permanently', purple),
}[result.code]
except KeyError:
text, color = ('with unknown code', purple)
linkstat['text'] = text
redirection = text + ' to ' + result.message
if self.config.linkcheck_allowed_redirects:
msg = 'redirect ' + result.uri + ' - ' + redirection
logger.warning(msg, location=(result.docname, result.lineno))
else:
msg = color('redirect ') + result.uri + color(' - ' + redirection)
logger.info(msg)
self.write_entry(
'redirected ' + text,
result.docname,
filename,
result.lineno,
result.uri + ' to ' + result.message,
)
self.write_entry(
'redirected ' + text,
result.docname,
filename,
result.lineno,
result.uri + ' to ' + result.message,
)
else:
msg = f'Unknown status {result.status!r}.'
raise ValueError(msg)
case _Status.UNKNOWN:
msg = 'Unknown status.'
raise ValueError(msg)

def write_linkstat(self, data: dict[str, str | int | _Status]) -> None:
self.json_outfile.write(json.dumps(data))
Expand Down
Loading