Skip to content

PEP 757: address gpshead's review #4144

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
vstinner merged 7 commits into from
Dec 3, 2024
Merged

PEP 757: address gpshead's review #4144

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
38f103e
Document, that PyLongWriter_Create allocate memory for the caller
skirpichev Dec 2, 2024
7942095
Document that PyLongWriter_Finish/Discard are mutually exclusive
skirpichev Dec 2, 2024
3497305
Use struct field instead of sys.int_info.bits_per_digit
skirpichev Dec 2, 2024
ff879e1
Document that only most significand digits must be zeroed.
skirpichev Dec 2, 2024
14cbb59
Require that ndigits > 0
skirpichev Dec 2, 2024
c0e939f
endianness -> digit_endianness
skirpichev Dec 2, 2024
f1137b3
Apply suggestions from code review
skirpichev Dec 2, 2024
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
23 changes: 14 additions & 9 deletions peps/pep-0757.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ functions.
- ``1`` for most significant digit first
- ``-1`` for least significant digit first

.. c:member:: int8_t endianness
.. c:member:: int8_t digit_endianness

Digit endianness:

Expand Down Expand Up @@ -177,19 +177,20 @@ create a Python :class:`int` object from a digits array.

Create a :c:type:`PyLongWriter`.

On success, set *\*digits* and return a writer.
On success, allocate *\*digits* and return a writer.
On error, set an exception and return ``NULL``.

*negative* is ``1`` if the number is negative, or ``0`` otherwise.

*ndigits* is the number of digits in the *digits* array. It must be
greater than or equal to 0.
*ndigits* is the number of digits in the *digits* array. It must be
greater than 0.

The caller can either initialize the array of digits *digits* and then call
:c:func:`PyLongWriter_Finish` to get a Python :class:`int`, or call
The caller can either initialize the array of digits *digits* and then
either call :c:func:`PyLongWriter_Finish` to get a Python :class:`int` or
:c:func:`PyLongWriter_Discard` to destroy the writer instance. Digits must
be in the range [``0``; ``(1 << sys.int_info.bits_per_digit) - 1``]. Unused
digits must be set to ``0``.
be in the range [``0``; ``(1 << bits_per_digit) - 1``] (where the
:c:struct:`~PyLongLayout.bits_per_digit` is the number of bits per digit).
The unused most-significant digits must be set to ``0``.


On CPython 3.14, the :c:func:`PyLongWriter_Create` implementation is a thin
Expand All @@ -206,11 +207,15 @@ wrapper to the private :c:func:`!_PyLong_New()` function.
The function takes care of normalizing the digits and converts the
object to a compact integer if needed.

The writer instance is invalid after the call.


.. c:function:: void PyLongWriter_Discard(PyLongWriter *writer)

Discard a :c:type:`PyLongWriter` created by :c:func:`PyLongWriter_Create`.

The writer instance is invalid after the call.


Optimize import for small integers
==================================
Expand Down Expand Up @@ -252,7 +257,7 @@ Code::
int int_digits_order = layout->digits_order;
size_t int_bits_per_digit = layout->bits_per_digit;
size_t int_nails = int_digit_size*8 - int_bits_per_digit;
int int_endianness = layout->endianness;
int int_endianness = layout->digit_endianness;


Export: :c:func:`PyLong_Export()` with gmpy2
Expand Down