summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/none.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-01-20 09:30:57 (GMT)
committerGeorg Brandl <georg@python.org>2008-01-20 09:30:57 (GMT)
commit54a3faae0806ab1dd8290e16acc8ab7acdd4762b (patch)
tree3f58890aaea549244ca64e911f8deee3ca5bd08d /Doc/c-api/none.rst
parent135bf209ac9a44244a97fd3bf5ff638a320e1a43 (diff)
downloadcpython-54a3faae0806ab1dd8290e16acc8ab7acdd4762b.zip
cpython-54a3faae0806ab1dd8290e16acc8ab7acdd4762b.tar.gz
cpython-54a3faae0806ab1dd8290e16acc8ab7acdd4762b.tar.bz2
Split C API docs in Py3k branch.
Diffstat (limited to 'Doc/c-api/none.rst')
-rw-r--r--Doc/c-api/none.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/Doc/c-api/none.rst b/Doc/c-api/none.rst
new file mode 100644
index 0000000..70e2c04
--- /dev/null
+++ b/Doc/c-api/none.rst
@@ -0,0 +1,26 @@
+.. highlightlang:: c
+
+.. _noneobject:
+
+The None Object
+---------------
+
+.. index:: object: None
+
+Note that the :ctype:`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 :cfunc:`PyNone_Check` function for the
+same reason.
+
+
+.. cvar:: 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.
+
+
+.. cmacro:: Py_RETURN_NONE
+
+ Properly handle returning :cdata:`Py_None` from within a C function (that is,
+ increment the reference count of None and return it.)