gh-132983: Add documentation for compression.zstd #133911
Open
+796
−1
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
11 tasks
AA-Turner
reviewed
May 12, 2025
| @@ -5,13 +5,15 @@ Data Compression and Archiving | |||
| ****************************** | |||
|
|
|||
| The modules described in this chapter support data compression with the zlib, | |||
| gzip, bzip2 and lzma algorithms, and the creation of ZIP- and tar-format | |||
| gzip, bzip2, zstd, and lzma algorithms, and the creation of ZIP- and tar-format | |||
There was a problem hiding this comment.
New algorithm at the end?
Suggested change
| gzip, bzip2, zstd, and lzma algorithms, and the creation of ZIP- and tar-format | |
| gzip, bzip2, lzma, and zstd algorithms, and the creation of ZIP- and tar-format |
Comment on lines
+1
to
+2
| The :mod:`!compression` package | ||
| ================================= |
There was a problem hiding this comment.
Suggested change
| The :mod:`!compression` package | |
| ================================= | |
| The :mod:`!compression` package | |
| =============================== |
Comment on lines
+6
to
+13
| .. note:: | ||
|
|
||
| Several modules in :mod:`!compression` re-export modules that currently | ||
| exist at the repository top-level. These re-exported modules are the new | ||
| canonical import name for the respective top-level module. The existing | ||
| modules are not currently deprecated and will not be removed prior to Python | ||
| 3.19, but users are encouraged to migrate to the new import names when | ||
| feasible. |
There was a problem hiding this comment.
Suggested change
| .. note:: | |
| Several modules in :mod:`!compression` re-export modules that currently | |
| exist at the repository top-level. These re-exported modules are the new | |
| canonical import name for the respective top-level module. The existing | |
| modules are not currently deprecated and will not be removed prior to Python | |
| 3.19, but users are encouraged to migrate to the new import names when | |
| feasible. | |
| .. attention:: | |
| The :mod:`!compression` package is the new location for the data compression | |
| modules in the standard library, listed below. The existing modules are not | |
| deprecated and will not be removed before Python 3.19. The new ``compression.*`` | |
| import names are encouraged for use where practicable. |
Comment on lines
+15
to
+23
| * :mod:`!compression.bz2` -- Re-exports :mod:`bz2` | ||
|
|
||
| * :mod:`!compression.gzip` -- Re-exports :mod:`gzip` | ||
|
|
||
| * :mod:`!compression.lzma` -- Re-exports :mod:`lzma` | ||
|
|
||
| * :mod:`!compression.zlib` -- Re-exports :mod:`zlib` | ||
|
|
||
| * :mod:`compression.zstd` -- Wrapper for the Zstandard compression library |
There was a problem hiding this comment.
Suggested change
| * :mod:`!compression.bz2` -- Re-exports :mod:`bz2` | |
| * :mod:`!compression.gzip` -- Re-exports :mod:`gzip` | |
| * :mod:`!compression.lzma` -- Re-exports :mod:`lzma` | |
| * :mod:`!compression.zlib` -- Re-exports :mod:`zlib` | |
| * :mod:`compression.zstd` -- Wrapper for the Zstandard compression library | |
| * :mod:`!compression.bz2` -- Re-exports :mod:`bz2` | |
| * :mod:`!compression.gzip` -- Re-exports :mod:`gzip` | |
| * :mod:`!compression.lzma` -- Re-exports :mod:`lzma` | |
| * :mod:`!compression.zlib` -- Re-exports :mod:`zlib` | |
| * :mod:`compression.zstd` -- Wrapper for the Zstandard compression library |
|
|
||
| * :mod:`compression.zstd` -- Wrapper for the Zstandard compression library | ||
|
|
||
|
|
Comment on lines
+728
to
+729
| Creating a compressed file:: | ||
|
|
There was a problem hiding this comment.
Suggested change
| Creating a compressed file:: | |
| Creating a compressed file: | |
| .. code-block:: python |
Comment on lines
+735
to
+736
| Compressing data in memory:: | ||
|
|
There was a problem hiding this comment.
Suggested change
| Compressing data in memory:: | |
| Compressing data in memory: | |
| .. code-block:: python |
Comment on lines
+741
to
+742
| Incremental compression:: | ||
|
|
There was a problem hiding this comment.
Suggested change
| Incremental compression:: | |
| Incremental compression: | |
| .. code-block:: python |
Comment on lines
+752
to
+753
| Writing compressed data to an already-open file:: | ||
|
|
There was a problem hiding this comment.
Suggested change
| Writing compressed data to an already-open file:: | |
| Writing compressed data to an already-open file: | |
| .. code-block:: python |
Comment on lines
+761
to
+762
| Creating a compressed file using compression parameters:: | ||
|
|
There was a problem hiding this comment.
Suggested change
| Creating a compressed file using compression parameters:: | |
| Creating a compressed file using compression parameters: | |
| .. code-block:: python |
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 docs for the
compressionandcompression.zstdmodules.📚 Documentation preview 📚: https://cpython-previews--133911.org.readthedocs.build/