mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-29 03:35:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Issue #13522: document error return values of some float and complex C API functions.

Browse source
This commit is contained in:
Antoine Pitrou 2011-12-18 01:25:27 +01:00
parent 13c82d00c4
commit c9e180043c
3 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -63,12 +63,18 @@ pointers. This is consistent throughout the API.
Return the quotient of two complex numbers, using the C :ctype:`Py_complex` Return the quotient of two complex numbers, using the C :ctype:`Py_complex`
representation. representation.
If *divisor* is null, this method returns zero and sets
:cdata:`errno` to :cdata:`EDOM`.
.. cfunction:: Py_complex _Py_c_pow(Py_complex num, Py_complex exp) .. cfunction:: Py_complex _Py_c_pow(Py_complex num, Py_complex exp)
Return the exponentiation of *num* by *exp*, using the C :ctype:`Py_complex` Return the exponentiation of *num* by *exp*, using the C :ctype:`Py_complex`
representation. representation.
If :attr:`exp.imag` is not null, or :attr:`exp.real` is negative,
this method returns zero and sets :cdata:`errno` to :cdata:`EDOM`.
Complex Numbers as Python Objects Complex Numbers as Python Objects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -125,6 +131,7 @@ Complex Numbers as Python Objects
.. cfunction:: Py_complex PyComplex_AsCComplex(PyObject *op) .. cfunction:: Py_complex PyComplex_AsCComplex(PyObject *op)
Return the :ctype:`Py_complex` value of the complex number *op*. Return the :ctype:`Py_complex` value of the complex number *op*.
Upon failure, this method returns ``-1.0`` as a real value.
.. versionchanged:: 2.6 .. versionchanged:: 2.6
If *op* is not a Python complex number object but has a :meth:`__complex__` If *op* is not a Python complex number object but has a :meth:`__complex__`

2
Doc/c-api/float.rst
View file

@ -55,6 +55,8 @@ Floating Point Objects
Return a C :ctype:`double` representation of the contents of *pyfloat*. If Return a C :ctype:`double` representation of the contents of *pyfloat*. If
*pyfloat* is not a Python floating point object but has a :meth:`__float__` *pyfloat* is not a Python floating point object but has a :meth:`__float__`
method, this method will first be called to convert *pyfloat* into a float. method, this method will first be called to convert *pyfloat* into a float.
This method returns ``-1.0`` upon failure, so one should call
:cfunc:`PyErr_Occurred` to check for errors.
.. cfunction:: double PyFloat_AS_DOUBLE(PyObject *pyfloat) .. cfunction:: double PyFloat_AS_DOUBLE(PyObject *pyfloat)

1
Misc/ACKS
View file

@ -120,6 +120,7 @@ Tarn Weisner Burton
Lee Busby Lee Busby
Ralph Butler Ralph Butler
Jp Calderone Jp Calderone
Arnaud Calmettes
Daniel Calvelo Daniel Calvelo
Tony Campbell Tony Campbell
Brett Cannon Brett Cannon