]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] gh-98347: Add links to python-isal in the documentation (GH-98637) (#132894)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 25 Apr 2025 02:09:58 +0000 (04:09 +0200)
committerGitHub <noreply@github.com>
Fri, 25 Apr 2025 02:09:58 +0000 (03:09 +0100)
gh-98347: Add links to python-isal in the documentation (GH-98637)

Clearly note that this is primarily intended for users for who zlib/gzip is a bottleneck.
(cherry picked from commit b1fc8b69ec4c29026cd8786fc5da0c498c7dcd57)

Co-authored-by: Ruben Vorderman <r.h.p.vorderman@lumc.nl>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc/library/gzip.rst
Doc/library/zlib.rst

index ccf9bbb28de14fb1bd343dfcff5abb6068580f21..d6f72c1610c560d131f9422b7691c71b067b88fe 100644 (file)
@@ -253,6 +253,10 @@ Example of how to GZIP compress a binary string::
       The basic data compression module needed to support the :program:`gzip` file
       format.
 
+   In case gzip (de)compression is a bottleneck, the `python-isal`_
+   package speeds up (de)compression with a mostly compatible API.
+
+   .. _python-isal: https://github.com/pycompression/python-isal
 
 .. program:: gzip
 
index 965b82a3daffb921a1b06cdc4ebbd324965f2f75..4f0eac0a9d51f8408e76ff4b3ba31c2f5e853e26 100644 (file)
@@ -341,3 +341,8 @@ the following constants:
    http://www.zlib.net/manual.html
       The zlib manual explains  the semantics and usage of the library's many
       functions.
+
+   In case gzip (de)compression is a bottleneck, the `python-isal`_
+   package speeds up (de)compression with a mostly compatible API.
+
+   .. _python-isal: https://github.com/pycompression/python-isal