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

gh-102595: Document `PyObject_Format` c-api function (GH-102596) 

Def: 5ffdaf748d/Include/abstract.h (L389)
This commit is contained in:
Nikita Sobolev 2023-03-21 19:46:24 +03:00 committed by GitHub
parent 7f760c2fca
commit 910a64e301
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/c-api/object.rst
View File

@ -179,6 +179,15 @@ Object Protocol
If *o1* and *o2* are the same object, :c:func:`PyObject_RichCompareBool`
will always return ``1`` for :const:`Py_EQ` and ``0`` for :const:`Py_NE`.
.. c:function:: PyObject* PyObject_Format(PyObject *obj, PyObject *format_spec)
Format *obj* using *format_spec*. This is equivalent to the Python
expression ``format(obj, format_spec)``.
*format_spec* may be ``NULL``. In this case the call is equivalent
to ``format(obj)``.
Returns the formatted string on success, ``NULL`` on failure.
.. c:function:: PyObject* PyObject_Repr(PyObject *o)
.. index:: builtin: repr