cpython/Doc/c-api/none.rst

27 lines
742 B
ReStructuredText
Raw Normal View History

.. highlight:: c
2008-01-20 05:30:57 -04:00
.. _noneobject:
The ``None`` Object
-------------------
2008-01-20 05:30:57 -04:00
.. index:: pair: object; None
2008-01-20 05:30:57 -04:00
Note that the :c:type:`PyTypeObject` for ``None`` is not directly exposed in the
2008-01-20 05:30:57 -04:00
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
2008-01-20 05:30:57 -04:00
same reason.
.. c:var:: PyObject* Py_None
2008-01-20 05:30:57 -04:00
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
2008-01-20 05:30:57 -04:00
Properly handle returning :c:data:`Py_None` from within a C function (that is,
increment the reference count of ``None`` and return it.)