FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.11] gh-112346: Document the OS byte in `gzip.compress` output change in 3.11 (GH-120480) by miss-islington · Pull Request #120614 · python/cpython · GitHub

/ cpython Public

[3.11] gh-112346: Document the OS byte in gzip.compress output change in 3.11 (GH-120480) #120614

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
pablogsal merged 1 commit into from
Jun 17, 2024
+18 −1
Conversation 0 Commits 1 Checks 0 Files changed 2
Merged

[3.11] gh-112346: Document the OS byte in gzip.compress output change in 3.11 (GH-120480) #120614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
4 changes: 3 additions & 1 deletion Doc/library/gzip.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,9 @@ The module defines the following items:
.. versionchanged:: 3.11
Speed is improved by compressing all data at once instead of in a
streamed fashion. Calls with *mtime* set to ``0`` are delegated to
:func:`zlib.compress` for better speed.
:func:`zlib.compress` for better speed. In this situation the
output may contain a gzip header "OS" byte value other than 255
"unknown" as supplied by the underlying zlib implementation.

.. function:: decompress(data)

Expand Down
15 changes: 15 additions & 0 deletions Doc/whatsnew/3.11.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -769,6 +769,21 @@ functools
(Contributed by Yurii Karabas in :issue:`46014`.)


.. _whatsnew311-gzip:

gzip
----

* The :func:`gzip.compress` function is now faster when used with the
**mtime=0** argument as it delegates the compression entirely to a single
:func:`zlib.compress` operation. There is one side effect of this change: The
gzip file header contains an "OS" byte in its header. That was traditionally
always set to a value of 255 representing "unknown" by the :mod:`gzip`
module. Now, when using :func:`~gzip.compress` with **mtime=0**, it may be
set to a different value by the underlying zlib C library Python was linked
against.
(See :gh:`112346` for details on the side effect.)

.. _whatsnew311-hashlib:

hashlib
Expand Down
Back | FazBrowse Home | New Git URL