diff options
| author |   Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-03-22 02:32:02 -0700 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2023-03-22 02:32:02 -0700 |
| commit | a7a373e1c56bdc3df5b8b14bab068258c974ddba (patch) | |
| tree | 0efc832c6ef91000f794580d873e15ca51c8854b | |
| parent | Add link to `sys.exit` function documentation (GH-102805) (diff) | |
| download | cpython-a7a373e1c56bdc3df5b8b14bab068258c974ddba.tar.gz cpython-a7a373e1c56bdc3df5b8b14bab068258c974ddba.tar.bz2 cpython-a7a373e1c56bdc3df5b8b14bab068258c974ddba.zip | |
[3.11] gh-102595: Document `PyObject_Format` c-api function (GH-102596) (GH-102879)
(cherry picked from commit 910a64e3013bce821bfac75377cbe88bedf265de)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Def: https://github.com/python/cpython/blame/5ffdaf748d98da6065158534720f1996a45a0072/Include/abstract.hGH-L389
Automerge-Triggered-By: GH:encukou
| -rw-r--r-- | Doc/c-api/object.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst index 84c72e7e108..0a12bb9e8c5 100644 --- a/Doc/c-api/object.rst +++ b/Doc/c-api/object.rst @@ -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 |