May 21, 2025 · May 12, 2025 · May 12, 2025 · May 12, 2025 · May 12, 2025 · May 12, 2025
diff --git a/Doc/library/archiving.rst b/Doc/library/archiving.rst
 ******************************

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

diff --git a/Doc/library/compression.rst b/Doc/library/compression.rst
 The :mod:`!compression` package
 =================================
 ===============================

 .. versionadded:: 3.14

 ..note::
 ..attention::

    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.
   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.

 * :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


diff --git a/Doc/library/compression.zstd.rst b/Doc/library/compression.zstd.rst

      ``'rb'`` for reading and ``'wb'`` for writing.


   .. attribute:: name

      Thezstd file name. Equivalent to the :attr:`~io.FileIO.name`
      Thename of the Zstandard file. Equivalent to the :attr:`~io.FileIO.name`
      attribute of the underlying :term:`file object`.


      compression technique used by zstd, resulting in higher compression
      ratios but slower compression.

      .. seealso::
         :class:`Strategy`
      .. seealso:: :class:`Strategy`

   .. attribute:: enable_long_distance_matching


 .. function:: get_frame_info(frame_buffer)

   Retrieve a :class:`FrameInfo`,containing metadata about a Zstandard frame.
   Frames contain metadata related to the compressed data they hold.
   Retrieve a :class:`FrameInfo` objectcontaining metadata about a Zstandard
 frame.Frames contain metadata related to the compressed data they hold.


 .. class:: FrameInfo()
 .. class:: FrameInfo

   Metadata related to a Zstandard frame. There are currently two attributes
   containing metadata related to Zstandard frames.

 .. attribute:: zstd_version_info

   Version number of the runtime zstd library as a tuple ofint
   Version number of the runtime zstd library as a tuple ofintegers
   (major, minor, release).


 Examples
 --------

 Reading in a compressed file::
 Reading in a compressed file:

 .. code-block:: python
   from compression import zstd
   with zstd.open("file.zst") as f:
       file_content = f.read()

 Creating a compressed file::
 Creating a compressed file:

 .. code-block:: python
   from compression import zstd
   data = b"Insert Data Here"
   with zstd.open("file.zst", "w") as f:
       f.write(data)

 Compressing data in memory::
 Compressing data in memory:

 .. code-block:: python
   from compression import zstd
   data_in = b"Insert Data Here"
   data_out = zstd.compress(data_in)

 Incremental compression::
 Incremental compression:

 .. code-block:: python
   from compression import zstd
   comp = zstd.ZstdCompressor()
   out1 = comp.compress(b"Some data\n")
   # Concatenate all the partial results:
   result = b"".join([out1, out2, out3, out4])

 Writing compressed data to an already-open file::
 Writing compressed data to an already-open file:

 .. code-block:: python
   from compression import zstd
   with open("file.zst", "wb") as f:
       f.write(b"This data will not be compressed\n")
       with zstd.open(f, "w") as zstf:
           zstf.write(b"This *will* be compressed\n")
       f.write(b"Not compressed\n")

 Creating a compressed file using compression parameters::
 Creating a compressed file using compression parameters:

 .. code-block:: python
   from compression import zstd
   options = {
      zstd.CompressionParameter.checksum_flag: 1
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,7 +5,7 @@ Data Compression and Archiving
		******************************

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

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,25 +1,18 @@
		The :mod:`!compression` package
		=================================
		===============================

		.. versionadded:: 3.14

		..note::
		..attention::
AA-Turner marked this conversation as resolved. Show resolvedHide resolved

		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.
		The :mod:`!compression` package is the new location for the data compression
emmatyping marked this conversation as resolved. Show resolvedHide resolved
		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.
emmatyping marked this conversation as resolved. Show resolvedHide resolved

		* :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
Original file line number	Diff line number	Diff line change
Expand Up		@@ -138,10 +138,9 @@ Reading and writing compressed files

		``'rb'`` for reading and ``'wb'`` for writing.


		.. attribute:: name

		Thezstd file name. Equivalent to the :attr:`~io.FileIO.name`
		Thename of the Zstandard file. Equivalent to the :attr:`~io.FileIO.name`
		attribute of the underlying :term:`file object`.


Expand DownExpand Up		@@ -542,8 +541,7 @@ Advanced parameter control
		compression technique used by zstd, resulting in higher compression
		ratios but slower compression.

		.. seealso::
		:class:`Strategy`
		.. seealso:: :class:`Strategy`

		.. attribute:: enable_long_distance_matching

Expand DownExpand Up		@@ -684,11 +682,11 @@ Miscellaneous

		.. function:: get_frame_info(frame_buffer)

		Retrieve a :class:`FrameInfo`,containing metadata about a Zstandard frame.
		Frames contain metadata related to the compressed data they hold.
		Retrieve a :class:`FrameInfo` objectcontaining metadata about a Zstandard
		frame.Frames contain metadata related to the compressed data they hold.


		.. class:: FrameInfo()
		.. class:: FrameInfo

		Metadata related to a Zstandard frame. There are currently two attributes
		containing metadata related to Zstandard frames.
Expand All		@@ -712,34 +710,38 @@ Miscellaneous

		.. attribute:: zstd_version_info

		Version number of the runtime zstd library as a tuple ofint
		Version number of the runtime zstd library as a tuple ofintegers
		(major, minor, release).


		Examples
		--------

		Reading in a compressed file::
		Reading in a compressed file:

		.. code-block:: python
		from compression import zstd
		with zstd.open("file.zst") as f:
		file_content = f.read()

		Creating a compressed file::
		Creating a compressed file:

		.. code-block:: python
		from compression import zstd
		data = b"Insert Data Here"
		with zstd.open("file.zst", "w") as f:
		f.write(data)

		Compressing data in memory::
		Compressing data in memory:

		.. code-block:: python
		from compression import zstd
		data_in = b"Insert Data Here"
		data_out = zstd.compress(data_in)

		Incremental compression::
		Incremental compression:

		.. code-block:: python
		from compression import zstd
		comp = zstd.ZstdCompressor()
		out1 = comp.compress(b"Some data\n")
Expand All		@@ -749,17 +751,19 @@ Incremental compression::
		# Concatenate all the partial results:
		result = b"".join([out1, out2, out3, out4])

		Writing compressed data to an already-open file::
		Writing compressed data to an already-open file:

		.. code-block:: python
		from compression import zstd
		with open("file.zst", "wb") as f:
emmatyping marked this conversation as resolved. Show resolvedHide resolved
		f.write(b"This data will not be compressed\n")
		with zstd.open(f, "w") as zstf:
		zstf.write(b"This will be compressed\n")
		f.write(b"Not compressed\n")

		Creating a compressed file using compression parameters::
		Creating a compressed file using compression parameters:

		.. code-block:: python
		from compression import zstd
		options = {
		zstd.CompressionParameter.checksum_flag: 1
Expand Down