Fix: Sanitise project path on windows for doc build #527
Conversation
|
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the Windows path sanitization for module regex matching in the doc build process.
- Escape backslashes in
project_rootbefore building the regex - Update the regex to use the sanitized path
- Ensures tests for Windows-style paths operate correctly
Comments suppressed due to low confidence (1)
tests/scrape_images.py:16
- [nitpick] Add or update tests covering Windows-style paths to ensure the regex correctly handles backslashes in
project_rooton Windows environments.
sanitized_path = self.project_root.replace("\\", "\\\\")
tests/scrape_images.py
Outdated
| 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("\\", "\\\\") |
There was a problem hiding this comment.
Consider using re.escape(self.project_root) to properly escape all regex metacharacters in the project path instead of manually replacing backslashes.
| sanitized_path = self.project_root.replace("\\", "\\\\") | |
| sanitized_path = re.escape(self.project_root) |
tests/scrape_images.py
Outdated
| self.project_root = project_root | ||
| self.re_machine_module_name = re.compile(f"{self.project_root}/(.*).py$") | ||
| sanitized_path = self.project_root.replace("\\", "\\\\") | ||
| self.re_machine_module_name = re.compile(f"{sanitized_path}/(.*).py$") |
There was a problem hiding this comment.
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.
| self.re_machine_module_name = re.compile(f"{sanitized_path}/(.*).py$") | |
| self.re_machine_module_name = re.compile(f"{sanitized_path}/(.*)\\.py$") |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #527 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 25 25
Lines 1631 1631
Branches 257 257
=========================================
Hits 1631 1631
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
Thanks @OliverDavey ! |
2 participants
Fix for issue #526