Skip to content

Fix: Sanitise project path on windows for doc build #527

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

Merged
fgmacedo merged 3 commits into from
Jul 1, 2025
Merged

Fix: Sanitise project path on windows for doc build #527

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c8c97d
Sanitise project path on windows for doc build
OliverDavey May 12, 2025
aa9290e
MachineScraper now uses regex escape function for robustness
OliverDavey Jun 30, 2025
430a6cb
don't escape the forward slash
OliverDavey Jul 1, 2025
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
3 changes: 2 additions & 1 deletion tests/scrape_images.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ class MachineScraper:

def __init__(self, project_root):
self.project_root = project_root
self.re_machine_module_name = re.compile(f"{self.project_root}/(.*).py$")
sanitized_path = self.project_root.replace("\\", "\\\\")
Copy link

Copilot AI Jun 4, 2025

Choose a reason for hiding this comment

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

Consider using re.escape(self.project_root) to properly escape all regex metacharacters in the project path instead of manually replacing backslashes.

Suggested change
sanitized_path = self.project_root.replace("\\", "\\\\")
sanitized_path = re.escape(self.project_root)

Copilot uses AI. Check for mistakes.
self.re_machine_module_name = re.compile(f"{sanitized_path}/(.*).py$")
Copy link

Copilot AI Jun 4, 2025

Choose a reason for hiding this comment

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

The regex uses .py without escaping the dot, matching any character before 'py'. Escape the dot (e.g., \\.py$) to match the literal file extension.

Suggested change
self.re_machine_module_name = re.compile(f"{sanitized_path}/(.*).py$")
self.re_machine_module_name = re.compile(f"{sanitized_path}/(.*)\\.py$")

Copilot uses AI. Check for mistakes.
self.seen = set()

def __repr__(self):
Expand Down
Loading