Repository navigation
fix: deprecate nonpositive batch sizes before 5.0 - #64
Open
tongwentao wants to merge 4 commits into
Open
tongwentao wants to merge 4 commits into
tongwentao wants to merge 4 commits into
Conversation
This branch has not been deployed
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.
This replaces closed PR #62 with the compatibility changes requested in the maintainer's review. GitHub does not allow the contributor account to reopen #62.
Sizes below 1 have been accepted since
batcherwas introduced. Rejecting them immediately would break existing 4.x callers, includingbatcher([], 0)and sizes computed from a small input. This revision follows the maintainer's compatibility plan: warn in 4.x and reserveValueErrorfor 5.0.batcheremits oneDeprecationWarningfor a size below 1 when iteration begins, before consuming the source. Its existing result is preserved: one batch containing all items, or no batches for an empty source.abatcheremits the same warning and preserves existing behavior, including the assertion for size 0 and the single final batch for a negative size.abatcheracceptsNone, 0 and negative sizes as no size limit, without warning. Interval deadlines and cancellation behavior remain covered by the existing tests, now also exercised with 0 and -1.Both docstrings and the changelog explain the staged deprecation. This PR does not implement the future 5.0 exception.
Validation on Python 3.13.5, using the existing development environment over SSH on Linux:
Other interpreter versions are left to CI. This revision was prepared and validated with Codex.