Refactor: Add secure exit handling and strong parsing to the broken link checker.#238
Open
patelscripts wants to merge 1 commit intoOpenScienceLabs:mainfrom
Open
Refactor: Add secure exit handling and strong parsing to the broken link checker.#238patelscripts wants to merge 1 commit intoOpenScienceLabs:mainfrom
patelscripts wants to merge 1 commit intoOpenScienceLabs:mainfrom
Conversation
Author
|
“Hi @xmnlab, I’ve refactored the link checker and tested locally. Please review and approve when possible ” |
Member
|
@patelscripts , thanks for working on that. general recommendations for your PRs:
|
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
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.
This pull request refactors the check-broken-links-md.py script to improve its reliability, maintainability, and clarity. The previous implementation had issues with fragile parsing, incorrect whitelist handling, and unsafe process termination. This update restructures the script into smaller, testable components and adds several enhancements to make it more robust and user-friendly.
Key improvements include:
1: Fixed whitelist logic so URLs in the exception list are properly ignored.
2: Replaced os._exit(1) with sys.exit(1) for safer termination and cleanup.
3: Implemented regex-based parsing to accurately extract files, URLs, and status codes.
4: Cleaned up subprocess handling to correctly capture both stdout and stderr.