kbe/src/lib/python/Doc/c-api/bool.rst
.. highlightlang:: c
.. _boolobjects:
Booleans in Python are implemented as a subclass of integers. There are only
two booleans, :const:Py_False and :const:Py_True. As such, the normal
creation and deletion functions don't apply to booleans. The following macros
are available, however.
.. c:function:: int PyBool_Check(PyObject *o)
Return true if o is of type :c:data:PyBool_Type.
.. c:var:: PyObject* Py_False
The Python False object. This object has no methods. It needs to be
treated just like any other object with respect to reference counts.
.. c:var:: PyObject* Py_True
The Python True object. This object has no methods. It needs to be treated
just like any other object with respect to reference counts.
.. c:macro:: Py_RETURN_FALSE
Return :const:Py_False from a function, properly incrementing its reference
count.
.. c:macro:: Py_RETURN_TRUE
Return :const:Py_True from a function, properly incrementing its reference
count.
.. c:function:: PyObject* PyBool_FromLong(long v)
Return a new reference to :const:Py_True or :const:Py_False depending on the
truth value of v.