Fix mutable default argument in build_annotation_segments#92
Open
arpitjain099 wants to merge 1 commit into
Open
Fix mutable default argument in build_annotation_segments#92arpitjain099 wants to merge 1 commit into
arpitjain099 wants to merge 1 commit into
Conversation
The audible_ranges parameter defaulted to a mutable list ([]), which is shared across all calls. Replace with None and initialize inside the function body. Also adds tests for the default-isolation invariant, empty input to collapse_audible_ranges, and adjacent-range merging. Signed-off-by: arpitjain099 <arpitjain099@gmail.com>
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.
The
audible_rangesparameter inbuild_annotation_segments()defaults to a mutable list[]. In Python, mutable defaults are shared across all calls to the function, so if any caller ever modified it in place the default would be permanently changed for subsequent calls.The fix replaces the default with
Noneand initializes a fresh list inside the function body. This is a standard Python pattern for avoiding the mutable default gotcha.Also adds a few tests:
collapse_audible_rangeswith empty input and adjacent ranges (where end == start of the next, which the counter-based algorithm correctly merges)