cpython/Doc/c-api/none.rst

.. 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
   and is `immortal <https://peps.python.org/pep-0683/>`_.

.. versionchanged:: 3.12
   :c:data:`Py_None` is immortal.

.. c:macro:: Py_RETURN_NONE

   Return :c:data:`Py_None` from a function.
Doc: Replace the deprecated highlightlang directive by highlight. (#13377) highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845 2019-05-17 11:55:34 +02:00			`.. highlight:: c`
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00
			`.. _noneobject:`

Issue #19795: Mark up None as literal text. 2016-10-19 16:29:26 +03:00			The ``None`` Object
			`-------------------`
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00
GH-97950: Use new-style index directive ('object') (#104158) * Uncomment object removal in pairindextypes * Use new-style index directive ('object') - C API * Use new-style index directive ('object') - Library * Use new-style index directive ('object') - Reference * Use new-style index directive ('object') - Tutorial 2023-05-04 11:04:41 +01:00			`.. index:: pair: object; None`
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00			Note that the :c:type:`PyTypeObject` for ``None`` is not directly exposed in the
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00			Python/C API. Since ``None`` is a singleton, testing for object identity (using
gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) 2023-07-27 18:44:32 +03:00			``==`` in C) is sufficient. There is no :c:func:`!PyNone_Check` function for the
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00			`same reason.`


Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00			`.. c:var:: PyObject* Py_None`
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00
gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal (#105195) 2023-06-21 21:13:25 +01:00			The Python ``None`` object, denoting lack of value. This object has no methods
			and is `immortal <https://peps.python.org/pep-0683/>`_.
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00
gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal (#105195) 2023-06-21 21:13:25 +01:00			`.. versionchanged:: 3.12`
			:c:data:`Py_None` is immortal.
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00
Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00			`.. c:macro:: Py_RETURN_NONE`
Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00
gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal (#105195) 2023-06-21 21:13:25 +01:00			Return :c:data:`Py_None` from a function.