print-files: --exclude argument - #507
Merged
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
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.
Extend the
scripts/print-files.pyutility so operators can exclude specific files or directories from the printed set, and so the tool dumps text sourcesKey changes
--excludeoption (repeatable,action="append"). Each value is a relative file or directory path to drop from the output; a directory exclude prSAFE_SUFFIXESallowlist:.py .sql .ts .json .yaml .js .conf .yml .css .sh .toml .md .html .xml .txt .j2. Files are filtered on this list bothmainontoargparse(variadic positionalpaths,--exclude). The default scan base is"."(relative) so that relative--excludevalues m--excludevalues are ignored (if p), so a stray empty argument no longer wipes the whole output.Notable implementation details
is_excluded(path)returns true when the path equals an exclude entry or has one as an ancestor, so a directory exclude prunes its subtree at every visiis_safe(path)requirespath.is_file()and a recognised suffix.".") is what makes the--excludematching reliable; an absolute base (the previous behaviour) caused relative excludes to