cpython/Doc/c-api/bool.rst

48 lines
1.2 KiB
ReStructuredText
Raw Normal View History

.. highlight:: c
2008-01-20 05:30:57 -04:00
.. _boolobjects:
Boolean Objects
---------------
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)
2008-01-20 05:30:57 -04:00
Return true if *o* is of type :c:data:`PyBool_Type`. This function always
succeeds.
2008-01-20 05:30:57 -04:00
.. c:var:: PyObject* Py_False
2008-01-20 05:30:57 -04:00
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
2008-01-20 05:30:57 -04:00
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
2008-01-20 05:30:57 -04:00
Return :const:`Py_False` from a function, properly incrementing its reference
count.
.. c:macro:: Py_RETURN_TRUE
2008-01-20 05:30:57 -04:00
Return :const:`Py_True` from a function, properly incrementing its reference
count.
.. c:function:: PyObject* PyBool_FromLong(long v)
2008-01-20 05:30:57 -04:00
Return a new reference to :const:`Py_True` or :const:`Py_False` depending on the
truth value of *v*.