• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. highlight:: c
2
3.. _boolobjects:
4
5Boolean Objects
6---------------
7
8Booleans in Python are implemented as a subclass of integers.  There are only
9two booleans, :const:`Py_False` and :const:`Py_True`.  As such, the normal
10creation and deletion functions don't apply to booleans.  The following macros
11are available, however.
12
13
14.. c:function:: int PyBool_Check(PyObject *o)
15
16   Return true if *o* is of type :c:data:`PyBool_Type`.  This function always
17   succeeds.
18
19
20.. c:var:: PyObject* Py_False
21
22   The Python ``False`` object.  This object has no methods.  It needs to be
23   treated just like any other object with respect to reference counts.
24
25
26.. c:var:: PyObject* Py_True
27
28   The Python ``True`` object.  This object has no methods.  It needs to be treated
29   just like any other object with respect to reference counts.
30
31
32.. c:macro:: Py_RETURN_FALSE
33
34   Return :const:`Py_False` from a function, properly incrementing its reference
35   count.
36
37
38.. c:macro:: Py_RETURN_TRUE
39
40   Return :const:`Py_True` from a function, properly incrementing its reference
41   count.
42
43
44.. c:function:: PyObject* PyBool_FromLong(long v)
45
46   Return a new reference to :const:`Py_True` or :const:`Py_False` depending on the
47   truth value of *v*.
48