fix: honor the recursive parameter in list_files() - #1317
Open
yuvrajnode wants to merge 1 commit into
Open
Conversation
list_files() accepted a `recursive` argument and documented it as "Whether to search recursively. Defaults to False", but the implementation always used Path.rglob(), so the search was recursive regardless of what the caller passed. This affected ReferenceLoader.list_reference_ids(), which calls list_files(ref_dir, AUDIO_EXTENSIONS, recursive=False, sort=False) expecting to scan only the top level of each references/<id>/ folder. A stray audio file in a nested subdirectory could make an otherwise invalid reference ID appear valid. Select rglob/glob based on the flag. The other two call sites pass recursive=True, so their behavior is unchanged.
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
1 participant
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.
list_files()infish_speech/utils/file.pyaccepts arecursiveargument and documents it as "Whether to search recursively. Defaults to False", but the implementation always calledPath.rglob()— so the search was recursive no matter what the caller passed.Impact
ReferenceLoader.list_reference_ids()calls it withrecursive=False, expecting to scan only the top level of eachreferences/<id>/folder. Because the flag was ignored, a stray audio file in a nested subdirectory could make an otherwise-invalid reference ID appear valid.The other two call sites (
tools/vqgan/create_train_split.py,tools/vqgan/extract_vq.py) passrecursive=True, so their behavior is unchanged.Fix
Select
rglob/globbased on the flag:Verification
Against a
demo/tree containingtop.wavandsub/nested.wav:recursive=Falsetop.wav,sub/nested.wavtop.wavrecursive=Truetop.wav,sub/nested.wavtop.wav,sub/nested.wavThe repo has no test suite, so I kept this to the one-line behavioral fix rather than introducing pytest as a new dependency.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.