Skip to content

Commit 49d9c30

Browse files
committed
Add documentation for compression.zstd
1 parent 0eb448c commit 49d9c30

File tree

3 files changed

+742
-1
lines changed

3 files changed

+742
-1
lines changed

Doc/library/archiving.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ Data Compression and Archiving
55
******************************
66

77
The modules described in this chapter support data compression with the zlib,
8-
gzip, bzip2 and lzma algorithms, and the creation of ZIP- and tar-format
8+
gzip, bzip2, zstd, and lzma algorithms, and the creation of ZIP- and tar-format
99
archives. See also :ref:`archiving-operations` provided by the :mod:`shutil`
1010
module.
1111

1212

1313
.. toctree::
1414

15+
compression.rst
16+
compression.zstd.rst
1517
zlib.rst
1618
gzip.rst
1719
bz2.rst

Doc/library/compression.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
The :mod:`!compression` package
2+
=================================
3+
4+
.. versionadded:: 3.14
5+
6+
.. note::
7+
8+
Several modules in :mod:`!compression` re-export modules that currently
9+
exist at the repository top-level. These re-exported modules are the new
10+
canonical import name for the respective top-level module. The existing
11+
modules are not currently deprecated and will not be removed prior to Python
12+
3.19, but users are encouraged to migrate to the new import names when
13+
feasible.
14+
15+
* :mod:`!compression.bz2` -- Re-exports :mod:`bz2`
16+
17+
* :mod:`!compression.gzip` -- Re-exports :mod:`gzip`
18+
19+
* :mod:`!compression.lzma` -- Re-exports :mod:`lzma`
20+
21+
* :mod:`!compression.zlib` -- Re-exports :mod:`zlib`
22+
23+
* :mod:`compression.zstd` -- Wrapper for the Zstandard compression library
24+
25+

0 commit comments

Comments
 (0)