~ubuntu-branches/ubuntu/trusty/python3.4/trusty-proposed

« back to all changes in this revision

Viewing changes to Doc/c-api/none.rst

  • Committer: Package Import Robot
  • Author(s): Matthias Klose
  • Date: 2013-11-25 09:44:27 UTC
  • Revision ID: package-import@ubuntu.com-20131125094427-lzxj8ap5w01lmo7f
Tags: upstream-3.4~b1
ImportĀ upstreamĀ versionĀ 3.4~b1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. highlightlang:: c
 
2
 
 
3
.. _noneobject:
 
4
 
 
5
The None Object
 
6
---------------
 
7
 
 
8
.. index:: object: None
 
9
 
 
10
Note that the :c:type:`PyTypeObject` for ``None`` is not directly exposed in the
 
11
Python/C API.  Since ``None`` is a singleton, testing for object identity (using
 
12
``==`` in C) is sufficient. There is no :c:func:`PyNone_Check` function for the
 
13
same reason.
 
14
 
 
15
 
 
16
.. c:var:: PyObject* Py_None
 
17
 
 
18
   The Python ``None`` object, denoting lack of value.  This object has no methods.
 
19
   It needs to be treated just like any other object with respect to reference
 
20
   counts.
 
21
 
 
22
 
 
23
.. c:macro:: Py_RETURN_NONE
 
24
 
 
25
   Properly handle returning :c:data:`Py_None` from within a C function (that is,
 
26
   increment the reference count of None and return it.)