mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 08:59:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

[3.10] bpo-47040: improve document of checksum functions (GH-31955) (GH-32002)

Browse source 
Clarifies a versionchanged note on crc32 & adler32 docs that the workaround is only needed for Python 2 and earlier.
Also cleans up an unnecessary intermediate variable in the implementation.

Authored-By: Ma Lin / animalize
Co-authored-by: Gregory P. Smith <greg@krypto.org>
This commit is contained in:
Ma Lin 2022-03-20 14:57:12 +08:00 • committed by GitHub
parent 906f1a4a95
commit 6d290d5862
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/library/binascii.rst
View file

@ -135,7 +135,7 @@ The :mod:`binascii` module defines the following functions:
.. function:: crc32(data[, value])
Compute CRC-32, the 32-bit checksum of *data*, starting with an
Compute CRC-32, the unsigned 32-bit checksum of *data*, starting with an
initial CRC of *value*. The default initial CRC is zero. The algorithm
is consistent with the ZIP file checksum. Since the algorithm is designed for
use as a checksum algorithm, it is not suitable for use as a general hash
@ -149,9 +149,8 @@ The :mod:`binascii` module defines the following functions:
.. versionchanged:: 3.0
The result is always unsigned.
To generate the same numeric value across all Python versions and
platforms, use ``crc32(data) & 0xffffffff``.
To generate the same numeric value when using Python 2 or earlier,
use ``crc32(data) & 0xffffffff``.
.. function:: b2a_hex(data[, sep[, bytes_per_sep=1]])
hexlify(data[, sep[, bytes_per_sep=1]])

14
Doc/library/zlib.rst
View file

@ -42,10 +42,9 @@ The available exception and functions in this module are:
for use as a general hash algorithm.
.. versionchanged:: 3.0
Always returns an unsigned value.
To generate the same numeric value across all Python versions and
platforms, use ``adler32(data) & 0xffffffff``.
The result is always unsigned.
To generate the same numeric value when using Python 2 or earlier,
use ``adler32(data) & 0xffffffff``.
.. function:: compress(data, /, level=-1)
@ -127,10 +126,9 @@ The available exception and functions in this module are:
for use as a general hash algorithm.
.. versionchanged:: 3.0
Always returns an unsigned value.
To generate the same numeric value across all Python versions and
platforms, use ``crc32(data) & 0xffffffff``.
The result is always unsigned.
To generate the same numeric value when using Python 2 or earlier,
use ``crc32(data) & 0xffffffff``.
.. function:: decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)