Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

#2691: document PyLong (s)size_t APIs, patch by Alexander Belopolsky.

This commit is contained in:
Georg Brandl 2008-04-26 18:31:07 +00:00
parent a3bb57caee
commit 78b3ee8c7b
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Doc/c-api/long.rst
View File

@ -49,6 +49,22 @@ Long Integer Objects
*NULL* on failure. *NULL* on failure.
.. cfunction:: PyObject* PyLong_FromSsize_t(Py_ssize_t v)
Return a new :ctype:`PyLongObject` object from a C :ctype:`Py_ssize_t`, or
*NULL* on failure.
.. versionadded:: 2.5
.. cfunction:: PyObject* PyLong_FromSize_t(size_t v)
Return a new :ctype:`PyLongObject` object from a C :ctype:`size_t`, or
*NULL* on failure.
.. versionadded:: 2.5
.. cfunction:: PyObject* PyLong_FromLongLong(PY_LONG_LONG v) .. cfunction:: PyObject* PyLong_FromLongLong(PY_LONG_LONG v)
Return a new :ctype:`PyLongObject` object from a C :ctype:`long long`, or *NULL* Return a new :ctype:`PyLongObject` object from a C :ctype:`long long`, or *NULL*
@ -109,7 +125,21 @@ Long Integer Objects
single: OverflowError (built-in exception) single: OverflowError (built-in exception)
Return a C :ctype:`long` representation of the contents of *pylong*. If Return a C :ctype:`long` representation of the contents of *pylong*. If
*pylong* is greater than :const:`LONG_MAX`, an :exc:`OverflowError` is raised. *pylong* is greater than :const:`LONG_MAX`, an :exc:`OverflowError` is raised
and ``-1`` will be returned.
.. cfunction:: Py_ssize_t PyLong_AsSsize_t(PyObject *pylong)
.. index::
single: PY_SSIZE_T_MAX
single: OverflowError (built-in exception)
Return a C :ctype:`Py_ssize_t` representation of the contents of *pylong*. If
*pylong* is greater than :const:`PY_SSIZE_T_MAX`, an :exc:`OverflowError` is raised
and ``-1`` will be returned.
.. versionadded:: 2.5
.. cfunction:: unsigned long PyLong_AsUnsignedLong(PyObject *pylong) .. cfunction:: unsigned long PyLong_AsUnsignedLong(PyObject *pylong)