Skip to content

Update documented minimum required zlib library version #140116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2025
Merged

Update documented minimum required zlib library version #140116

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06fab58
Commit
StanFromIreland Oct 14, 2025
d098537
Update configure to check
StanFromIreland Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions Doc/library/zlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@

For applications that require data compression, the functions in this module
allow compression and decompression, using the zlib library. The zlib library
has its own home page at https://www.zlib.net. There are known
incompatibilities between the Python module and versions of the zlib library
earlier than 1.1.3; 1.1.3 has a `security vulnerability <https://zlib.net/zlib_faq.html#faq33>`_, so we recommend using
1.1.4 or later.
has its own home page at https://www.zlib.net. zlib 1.2.2.1 is the minium
Copy link
Member Author

@StanFromIreland StanFromIreland Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was wrong for a while:

cpython/Modules/zlibmodule.c

Lines 16 to 18 in 59547a2

#if defined(ZLIB_VERNUM) && ZLIB_VERNUM < 0x1221
#error "At least zlib version 1.2.2.1 is required"
#endif

supported version.

zlib's functions have many options and often need to be used in a particular
order. This documentation doesn't attempt to cover all of the permutations;
Expand Down
16 changes: 7 additions & 9 deletions Doc/using/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,28 +26,26 @@ To build optional modules:

* `libbz2 <https://sourceware.org/bzip2/>`_ for the :mod:`bz2` module.

* `libb2 <https://github.com/BLAKE2/libb2>`_ (:ref:`BLAKE2 <hashlib-blake2>`),
used by :mod:`hashlib` module.
* `libb2 <https://github.com/BLAKE2/libb2>`_ (:ref:`BLAKE2 <hashlib-blake2>`)
Copy link
Member Author

@StanFromIreland StanFromIreland Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed some unnecessary commas here.

for the :mod:`hashlib` module.

* `libffi <https://sourceware.org/libffi/>`_ 3.3.0 is the recommended
minimum version for the :mod:`ctypes` module.

* ``liblzma``, for the :mod:`lzma` module.
* ``liblzma`` for the :mod:`lzma` module.

* `libmpdec <https://www.bytereef.org/mpdecimal/doc/libmpdec/>`_ 2.5.0
for the :mod:`decimal` module.

* ``libncurses`` or ``libncursesw``,
for the :mod:`curses` module.
* ``libncurses`` or ``libncursesw`` for the :mod:`curses` module.

* ``libpanel`` or ``libpanelw``,
for the :mod:`curses.panel` module.
* ``libpanel`` or ``libpanelw`` for the :mod:`curses.panel` module.

* `libreadline <https://tiswww.case.edu/php/chet/readline/rltop.html>`_ or
`libedit <https://www.thrysoee.dk/editline/>`_
for the :mod:`readline` module.

* `libuuid <https://linux.die.net/man/3/libuuid>`_, for the :mod:`uuid` module.
* `libuuid <https://linux.die.net/man/3/libuuid>`_ for the :mod:`uuid` module.

* `OpenSSL <https://www.openssl.org/>`_ 1.1.1 is the minimum version and
OpenSSL 3.0.18 is the recommended minimum version for the
Expand All @@ -57,7 +55,7 @@ To build optional modules:

* `Tcl/Tk <https://www.tcl-lang.org/>`_ 8.5.12 for the :mod:`tkinter` module.

* `zlib <https://www.zlib.net>`_ 1.1.4 is the reccomended minimum version for the
* `zlib <https://www.zlib.net>`_ 1.2.2.1 is the minimum version for the
Copy link
Member

@vstinner vstinner Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

zlib 1.2.2.0 was released in 2004: https://madler.net/pipermail/zlib-announce_madler.net/2004/000002.html. So it sounds reasonable to require this (old) version.

Copy link
Member Author

@StanFromIreland StanFromIreland Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I noted here, it is required by the code. One will get an error otherwise.

:mod:`zlib` module.

* `zstd <https://facebook.github.io/zstd/>`_ 1.4.5 is the minimum version for
Expand Down
Loading