Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-31 04:23:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-128813: soft-deprecate _Py_c_*() functions (GH-137261)

Browse source
This commit is contained in:
Sergey B Kirpichev 2025-08-01 10:40:12 +03:00 • committed by GitHub
parent 2a87af062b
commit 9ced5c4ace
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 39 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

28
Doc/c-api/complex.rst
View file

@ -43,24 +43,36 @@ pointers. This is consistent throughout the API.
Return the sum of two complex numbers, using the C :c:type:`Py_complex`
representation.
.. deprecated:: 3.15
This function is :term:`soft deprecated`.
.. c:function:: Py_complex _Py_c_diff(Py_complex left, Py_complex right)
Return the difference between two complex numbers, using the C
:c:type:`Py_complex` representation.
.. deprecated:: 3.15
This function is :term:`soft deprecated`.
.. c:function:: Py_complex _Py_c_neg(Py_complex num)
Return the negation of the complex number *num*, using the C
:c:type:`Py_complex` representation.
.. deprecated:: 3.15
This function is :term:`soft deprecated`.
.. c:function:: Py_complex _Py_c_prod(Py_complex left, Py_complex right)
Return the product of two complex numbers, using the C :c:type:`Py_complex`
representation.
.. deprecated:: 3.15
This function is :term:`soft deprecated`.
.. c:function:: Py_complex _Py_c_quot(Py_complex dividend, Py_complex divisor)
@ -70,6 +82,9 @@ pointers. This is consistent throughout the API.
If *divisor* is null, this method returns zero and sets
:c:data:`errno` to :c:macro:`!EDOM`.
.. deprecated:: 3.15
This function is :term:`soft deprecated`.
.. c:function:: Py_complex _Py_c_pow(Py_complex num, Py_complex exp)
@ -81,6 +96,19 @@ pointers. This is consistent throughout the API.
Set :c:data:`errno` to :c:macro:`!ERANGE` on overflows.
.. deprecated:: 3.15
This function is :term:`soft deprecated`.
.. c:function:: double _Py_c_abs(Py_complex num)
Return the absolute value of the complex number *num*.
Set :c:data:`errno` to :c:macro:`!ERANGE` on overflows.
.. deprecated:: 3.15
This function is :term:`soft deprecated`.
Complex Numbers as Python Objects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

5
Doc/whatsnew/3.15.rst
View file

@ -548,6 +548,11 @@ Deprecated C APIs
signed integer type of the same size is now deprecated.
(Contributed by Serhiy Storchaka in :gh:`132629`.)
* Functions :c:func:`_Py_c_sum`, :c:func:`_Py_c_diff`, :c:func:`_Py_c_neg`,
:c:func:`_Py_c_prod`, :c:func:`_Py_c_quot`, :c:func:`_Py_c_pow` and
:c:func:`_Py_c_abs` are :term:`soft deprecated`.
(Contributed by Sergey B Kirpichev in :gh:`128813`.)
.. Add C API deprecations above alphabetically, not here at the end.
Removed C APIs

3
Include/cpython/complexobject.h
View file

@ -7,7 +7,8 @@ typedef struct {
double imag;
} Py_complex;
// Operations on complex numbers.
/* Operations on complex numbers (soft deprecated
since Python 3.15). */
PyAPI_FUNC(Py_complex) _Py_c_sum(Py_complex, Py_complex);
PyAPI_FUNC(Py_complex) _Py_c_diff(Py_complex, Py_complex);
PyAPI_FUNC(Py_complex) _Py_c_neg(Py_complex);

4
Misc/NEWS.d/next/C_API/2025-07-31-04-30-42.gh-issue-128813.opL-Pv.rst Normal file
View file

@ -0,0 +1,4 @@
Functions :c:func:`_Py_c_sum`, :c:func:`_Py_c_diff`, :c:func:`_Py_c_neg`,
:c:func:`_Py_c_prod`, :c:func:`_Py_c_quot`, :c:func:`_Py_c_pow` and
previously undocumented :c:func:`_Py_c_abs` are :term:`soft deprecated`.
Patch by Sergey B Kirpichev.