Refactor DocGen to use filesystem abstraction #178
Merged
Conversation
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
cpyle0819
force-pushed
the
doc-gen-updates
branch
from
4faa60f to
a707336
Compare
DavidSouther
approved these changes
Jul 3, 2025
Merged
Contributor
Author
|
Looks like doc_gen.py#collect_snippets has a call stack that leads to |
Contributor
Author
|
Explicitly removed label so this doesn't accidentally get merged. |
- Add abstract readlines method to Fs class - Implement readlines in PathFs using file.readlines() - Implement readlines in RecordFs using splitlines(keepends=True) - Add comprehensive tests for both implementations - Test various scenarios: empty files, no final newline, different line endings
This was referenced Jul 7, 2025
* Abstract filesystem operations in file_utils.py - Add fs parameter to walk_with_gitignore and get_files functions - Replace direct filesystem calls with Fs interface methods - Use fs.stat(), fs.readlines(), and fs.list() instead of os.scandir() and open() - Exclude .gitignore files from walk results - Add comprehensive tests using RecordFs for deterministic testing - Test gitignore filtering, skip functions, and edge cases * Address PR feedback: use fully qualified imports, absolute paths, and add nested gitignore test - Use fully qualified imports in file_utils.py and file_utils_test.py - Convert all test paths to absolute paths as requested - Add comprehensive nested gitignore test case - Improve RecordFs.list() method to handle intermediate directories properly
DavidSouther
requested changes
Jul 7, 2025
DavidSouther
requested changes
Jul 7, 2025
cpyle0819
force-pushed
the
doc-gen-updates
branch
from
84e5c54 to
778232a
Compare
DavidSouther
approved these changes
Jul 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.