Skip to content

[3.14] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) #141234

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 1 commit into from
Nov 8, 2025
Merged

[3.14] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) #141234

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
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion Doc/c-api/hash.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,16 @@ See also the :c:member:`PyTypeObject.tp_hash` member and :ref:`numeric-hash`.
it is easier to create colliding strings. A cutoff of 7 on 64-bit platforms
and 5 on 32-bit platforms should provide a decent safety margin.

This corresponds to the :data:`sys.hash_info.cutoff` constant.

.. versionadded:: 3.4


.. c:macro:: PyHASH_MODULUS

The `Mersenne prime <https://en.wikipedia.org/wiki/Mersenne_prime>`_ ``P = 2**n -1``,
used for numeric hash scheme.

This corresponds to the :data:`sys.hash_info.modulus` constant.

.. versionadded:: 3.13
Expand All @@ -71,7 +74,6 @@ See also the :c:member:`PyTypeObject.tp_hash` member and :ref:`numeric-hash`.
.. c:macro:: PyHASH_BITS

The exponent ``n`` of ``P`` in :c:macro:`PyHASH_MODULUS`.
This corresponds to the :data:`sys.hash_info.hash_bits` constant.

.. versionadded:: 3.13

Expand All @@ -86,6 +88,7 @@ See also the :c:member:`PyTypeObject.tp_hash` member and :ref:`numeric-hash`.
.. c:macro:: PyHASH_INF

The hash value returned for a positive infinity.

This corresponds to the :data:`sys.hash_info.inf` constant.

.. versionadded:: 3.13
Expand All @@ -94,6 +97,7 @@ See also the :c:member:`PyTypeObject.tp_hash` member and :ref:`numeric-hash`.
.. c:macro:: PyHASH_IMAG

The multiplier used for the imaginary part of a complex number.

This corresponds to the :data:`sys.hash_info.imag` constant.

.. versionadded:: 3.13
Expand All @@ -111,14 +115,20 @@ See also the :c:member:`PyTypeObject.tp_hash` member and :ref:`numeric-hash`.

Hash function name (UTF-8 encoded string).

This corresponds to the :data:`sys.hash_info.algorithm` constant.

.. c:member:: const int hash_bits

Internal size of the hash value in bits.

This corresponds to the :data:`sys.hash_info.hash_bits` constant.

.. c:member:: const int seed_bits

Size of seed input in bits.

This corresponds to the :data:`sys.hash_info.seed_bits` constant.

.. versionadded:: 3.4


Expand Down
6 changes: 5 additions & 1 deletion Doc/library/sys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1130,10 +1130,14 @@ always available. Unless explicitly noted otherwise, all variables are read-only

The size of the seed key of the hash algorithm

.. attribute:: hash_info.cutoff

Cutoff for small string DJBX33A optimization in range ``[1, cutoff)``.

.. versionadded:: 3.2

.. versionchanged:: 3.4
Added *algorithm*, *hash_bits* and *seed_bits*
Added *algorithm*, *hash_bits*, *seed_bits*, and *cutoff*.


.. data:: hexversion
Expand Down
Loading