gh-134938: Add set_pledged_input_size to ZstdCompressor
#135010
Merged
+285
−2
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
|
cc @Rogdham |
DangNhutNguyen
approved these changes
Jun 2, 2025
DangNhutNguyen
approved these changes
Jun 2, 2025
Also fixup punctuation usage and don't incref Py_None.
Rogdham
reviewed
Jun 2, 2025
AA-Turner
reviewed
Jun 3, 2025
| @@ -247,6 +247,25 @@ Compressing and decompressing data in memory | |||
| The *mode* argument is a :class:`ZstdCompressor` attribute, either | |||
| :attr:`~.FLUSH_BLOCK`, or :attr:`~.FLUSH_FRAME`. | |||
|
|
|||
| .. method:: set_pledged_input_size(size) | |||
There was a problem hiding this comment.
This doesn't currently explain why one would want to use the method.
There was a problem hiding this comment.
I added a bit to describe this, but suggestions welcome.
AA-Turner
reviewed
Jun 3, 2025
AA-Turner
reviewed
Jun 3, 2025
serhiy-storchaka
approved these changes
Jun 3, 2025
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
…python into zstd-set-pledged-input-size
|
@serhiy-storchaka
I'll make a follow up after this is merged to resolve these. |
serhiy-storchaka
approved these changes
Jun 4, 2025
|
Thanks @emmatyping for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 5, 2025
…onGH-135010) (cherry picked from commit 4b44b34) Co-authored-by: Emma Smith <emma@emmatyping.dev>
|
GH-135173 is a backport of this pull request to the 3.14 branch. |
serhiy-storchaka
pushed a commit
that referenced
this pull request
Jun 5, 2025
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 PR adds a new method
set_pledged_input_size(), which allows users to declare up front how much data will be written to the compressor for a given frame. This combined withCompressionParameter.content_size_flagallows users to ensure that even for streaming compression scenarios the content size is written into the zstd frame header, which is beneficial for reducing decompression memory usage.📚 Documentation preview 📚: https://cpython-previews--135010.org.readthedocs.build/