source: python/vendor/Python-2.7.6/Doc/c-api/bool.rst

Last change on this file was 388, checked in by dmik, 11 years ago

python: Update vendor to 2.7.6.

  • Property svn:eol-style set to native
File size: 1.3 KB

Boolean Objects

?
.. highlightlang:: c

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`.

   .. versionadded:: 2.3


?
.. 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.

   .. versionadded:: 2.4


?
.. c:macro:: Py_RETURN_TRUE

   Return :const:`Py_True` from a function, properly incrementing its reference
   count.

   .. versionadded:: 2.4


?
.. 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*.

   .. versionadded:: 2.3
Note: See TracBrowser for help on using the repository browser.