summaryrefslogtreecommitdiff
path: root/Doc/library/zlib.rst
diff options
context:
space:
mode:
authorNadeem Vawda <nadeem.vawda@gmail.com>2011-09-12 00:04:13 +0200
committerNadeem Vawda <nadeem.vawda@gmail.com>2011-09-12 00:04:13 +0200
commit64d25ddb9c31b94aadfc8c9f220b0a5759e20265 (patch)
tree442b3e50e070948f246c58618d9d6d75c809cb56 /Doc/library/zlib.rst
parent249ab5e8d1452ab7bc43b0f1e1221e0065d2e52d (diff)
downloadcpython-git-64d25ddb9c31b94aadfc8c9f220b0a5759e20265.tar.gz
Issue #12306: Add ZLIB_RUNTIME_VERSION to the zlib module.
While we're at it, also document ZLIB_VERSION. Patch by Torsten Landschoff.
Diffstat (limited to 'Doc/library/zlib.rst')
-rw-r--r--Doc/library/zlib.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst
index 54835e7f7e..aab9ec7b26 100644
--- a/Doc/library/zlib.rst
+++ b/Doc/library/zlib.rst
@@ -122,6 +122,7 @@ The available exception and functions in this module are:
won't fit into memory at once. The *wbits* parameter controls the size of the
window buffer.
+
Compression objects support the following methods:
@@ -217,6 +218,26 @@ Decompression objects support the following methods and attributes:
seeks into the stream at a future point.
+Information about the version of the zlib library in use is available through
+the following constants:
+
+
+.. data:: ZLIB_VERSION
+
+ The version string of the zlib library that was used for building the module.
+ This may be different from the zlib library actually used at runtime, which
+ is available as :const:`ZLIB_RUNTIME_VERSION`.
+
+ .. versionadded:: 3.3
+
+
+.. data:: ZLIB_RUNTIME_VERSION
+
+ The version string of the zlib library actually loaded by the interpreter.
+
+ .. versionadded:: 3.3
+
+
.. seealso::
Module :mod:`gzip`