mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-02 13:22:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.14] gh-134906: Document CompressionParameter.content_size_flag (GH-134907) (#134915)

Browse source 
gh-134906: Document CompressionParameter.content_size_flag (GH-134907)

* Document CompressionParameter.content_size_flag
(cherry picked from commit 5f60d0fccc)

Co-authored-by: Emma Smith <emma@emmatyping.dev>
This commit is contained in:
Miss Islington (bot) 2025-05-30 06:43:33 +02:00 • committed by GitHub
parent 4927596c49
commit 370f91b946
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/library/compression.zstd.rst
View file

@ -615,6 +615,24 @@ Advanced parameter control
A value of zero causes the value to be selected automatically. A value of zero causes the value to be selected automatically.
.. attribute:: content_size_flag
Write the size of the data to be compressed into the Zstandard frame
header when known prior to compressing.
This flag only takes effect under the following two scenarios:
* Calling :func:`compress` for one-shot compression
* Providing all of the data to be compressed in the frame in a single
:meth:`ZstdCompressor.compress` call, with the
:attr:`ZstdCompressor.FLUSH_FRAME` mode.
All other compression calls may not write the size information into the
frame header.
``True`` or ``1`` enable the content size flag while ``False`` or ``0``
disable it.
.. attribute:: checksum_flag .. attribute:: checksum_flag
A four-byte checksum using XXHash64 of the uncompressed content is A four-byte checksum using XXHash64 of the uncompressed content is