Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
134 changes: 131 additions & 3 deletions Doc/library/zlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ earlier than 1.1.3; 1.1.3 has a `security vulnerability <https://zlib.net/zlib_f

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;
consult the zlib manual at http://www.zlib.net/manual.html for authoritative
consult the `zlib manual <https://www.zlib.net/manual.html>`_ for authoritative
Copy link
Member

Choose a reason for hiding this comment

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

Note, bare links in source text are recognised by reST (unlike markdown), so this change is optional.

Suggested change
consult the `zlib manual <https://www.zlib.net/manual.html>`_ for authoritative
consult the `zlib manual <https://www.zlib.net/manual.html>`__ for authoritative

information.

For reading and writing ``.gz`` files see the :mod:`gzip` module.
Expand Down Expand Up @@ -340,6 +340,134 @@ Decompression objects support the following methods and attributes:
objects.


The following constants are available to configure compression and decompression
behavior:

.. data:: DEFLATED

The deflate compression method.


.. data:: MAX_WBITS

The maximum window buffer size (power of 2).


.. data:: DEF_MEM_LEVEL

The default memory level for compression objects.


.. data:: DEF_BUF_SIZE

The default buffer size for decompression operations.


.. data:: Z_NO_COMPRESSION

Compression level ``0``.

.. versionadded:: 3.6


.. data:: Z_BEST_SPEED

Compression level ``1``.


.. data:: Z_BEST_COMPRESSION

Compression level ``9``.


.. data:: Z_DEFAULT_COMPRESSION

Default compression level (``-1``).


.. data:: Z_DEFAULT_STRATEGY

Default compression strategy, for normal data.


.. data:: Z_FILTERED

Compression strategy for data produced by a filter (or predictor).


.. data:: Z_HUFFMAN_ONLY

Compression strategy that forces Huffman coding only.


.. data:: Z_RLE

Compression strategy that limits match distances to one (run-length encoding).

This constant is only available if Python was compiled with zlib
1.2.0.1 or greater.

.. versionadded:: 3.6


.. data:: Z_FIXED

Compression strategy that prevents the use of dynamic Huffman codes.

This constant is only available if Python was compiled with zlib
1.2.2.2 or greater.

.. versionadded:: 3.6


.. data:: Z_NO_FLUSH

Flush mode ``0``. No special flushing behavior.

.. versionadded:: 3.6


.. data:: Z_PARTIAL_FLUSH

Flush mode ``1``. Flush as much output as possible.


.. data:: Z_SYNC_FLUSH

Flush mode ``2``. All output is flushed and the output is aligned to a byte boundary.


.. data:: Z_FULL_FLUSH

Flush mode ``3``. All output is flushed and the compression state is reset.


.. data:: Z_FINISH

Flush mode ``4``. All pending input is processed, no more input is expected.


.. data:: Z_BLOCK

Flush mode ``5``. A deflate block is completed and emitted.

This constant is only available if Python was compiled with zlib
1.2.2.2 or greater.

.. versionadded:: 3.6


.. data:: Z_TREES

Flush mode ``6``, for inflate operations. Instructs inflate to return when
it gets to the next deflate block boundary.

This constant is only available if Python was compiled with zlib
1.2.3.4 or greater.

.. versionadded:: 3.6


Information about the version of the zlib library in use is available through
the following constants:

Expand Down Expand Up @@ -375,10 +503,10 @@ the following constants:
Module :mod:`gzip`
Reading and writing :program:`gzip`\ -format files.

http://www.zlib.net
https://www.zlib.net
The zlib library home page.

http://www.zlib.net/manual.html
https://www.zlib.net/manual.html
The zlib manual explains the semantics and usage of the library's many
functions.

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ Doc/library/xml.sax.reader.rst
Doc/library/xml.sax.rst
Doc/library/xmlrpc.client.rst
Doc/library/xmlrpc.server.rst
Doc/library/zlib.rst
Doc/whatsnew/2.4.rst
Doc/whatsnew/2.5.rst
Doc/whatsnew/2.6.rst
Loading