<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"api.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"api.html" title='Python/C API Reference Manual'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"longObjects.html" />
<link rel=
"prev" href=
"intObjects.html" />
<link rel=
"parent" href=
"numericObjects.html" />
<link rel=
"next" href=
"longObjects.html" />
<meta name='aesop' content='information'
/>
<title>7.2.2 Boolean Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.2.1 Plain Integer Objects"
href=
"intObjects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.2 Numeric Objects"
href=
"numericObjects.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.2.3 Long Integer Objects"
href=
"longObjects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"intObjects.html">7.2.1 Plain Integer Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"numericObjects.html">7.2 Numeric Objects
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"longObjects.html">7.2.3 Long Integer Objects
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION009220000000000000000"></A><A NAME=
"boolObjects"></A>
Booleans in Python are implemented as a subclass of integers. There
are only two booleans,
<tt class=
"constant">Py_False
</tt> and
<tt class=
"constant">Py_True
</tt>. As
such, the normal creation and deletion functions don't apply to
booleans. The following macros are available, however.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>int
<b><tt id='l2h-
384' xml:id='l2h-
384'
class=
"cfunction">PyBool_Check
</tt></b>(
</nobr></td><td>PyObject *
<var>o
</var>)
</td></tr></table></dt>
Return true if
<var>o
</var> is of type
<tt class=
"cdata">PyBool_Type
</tt>.
<span class=
"versionnote">New in version
2.3.
</span>
<dl><dt>PyObject*
<b><tt id='l2h-
385' xml:id='l2h-
385'
class=
"cdata">Py_False
</tt></b></dt>
The Python
<code>False
</code> object. This object has no methods. It needs to
be treated just like any other object with respect to reference counts.
<dl><dt>PyObject*
<b><tt id='l2h-
386' xml:id='l2h-
386'
class=
"cdata">Py_True
</tt></b></dt>
The Python
<code>True
</code> object. This object has no methods. It needs to
be treated just like any other object with respect to reference counts.
<dl><dt><b><tt id='l2h-
387' xml:id='l2h-
387'
class=
"macro">Py_RETURN_FALSE
</tt></b></dt>
Return
<tt class=
"constant">Py_False
</tt> from a function, properly incrementing its
<span class=
"versionnote">New in version
2.4.
</span>
<dl><dt><b><tt id='l2h-
388' xml:id='l2h-
388'
class=
"macro">Py_RETURN_TRUE
</tt></b></dt>
Return
<tt class=
"constant">Py_True
</tt> from a function, properly incrementing its
<span class=
"versionnote">New in version
2.4.
</span>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline"><td><nobr>PyObject*
<b><tt id='l2h-
389' xml:id='l2h-
389'
class=
"cfunction">PyBool_FromLong
</tt></b>(
</nobr></td><td>long
<var>v
</var>)
</td></tr></table></dt>
Return a new reference to
<tt class=
"constant">Py_True
</tt> or
<tt class=
"constant">Py_False
</tt>
depending on the truth value of
<var>v
</var>.
<span class=
"versionnote">New in version
2.3.
</span>
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"7.2.1 Plain Integer Objects"
href=
"intObjects.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"7.2 Numeric Objects"
href=
"numericObjects.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"7.2.3 Long Integer Objects"
href=
"longObjects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python/C API Reference Manual
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"intObjects.html">7.2.1 Plain Integer Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"numericObjects.html">7.2 Numeric Objects
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"longObjects.html">7.2.3 Long Integer Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.