githubmirror/cpython

Doc/c-api/none.rst

26 строк743 B

Serhiy Storchaka

[3.11] gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) (GH-107381)

28 июл 2023, 11:31

28 июл 2023, 11:31d9392c0

.. highlight:: c

.. _noneobject:

The ``None`` Object
-------------------

.. index:: pair: object; None

Note that the :c:type:`PyTypeObject` for ``None`` is not directly exposed in the
Python/C API.  Since ``None`` is a singleton, testing for object identity (using
``==`` in C) is sufficient. There is no :c:func:`!PyNone_Check` function for the
same reason.


.. c:var:: PyObject* Py_None

   The Python ``None`` object, denoting lack of value.  This object has no methods.
   It needs to be treated just like any other object with respect to reference
   counts.


.. c:macro:: Py_RETURN_NONE

   Properly handle returning :c:data:`Py_None` from within a C function (that is,
   increment the reference count of ``None`` and return it.)