Edit File: bool.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Boolean Objects — Python v2.6.6 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.6.6', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python v2.6.6 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python v2.6.6 documentation" href="../index.html" /> <link rel="up" title="Concrete Objects Layer" href="concrete.html" /> <link rel="next" title="Long Integer Objects" href="long.html" /> <link rel="prev" title="Plain Integer Objects" href="int.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> <li class="right" > <a href="long.html" title="Long Integer Objects" accesskey="N">next</a> |</li> <li class="right" > <a href="int.html" title="Plain Integer Objects" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" >Python/C API Reference Manual</a> »</li> <li><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="boolean-objects"> <span id="boolobjects"></span><h1>Boolean Objects<a class="headerlink" href="#boolean-objects" title="Permalink to this headline">¶</a></h1> <p>Booleans in Python are implemented as a subclass of integers. There are only two booleans, <a title="Py_False" class="reference internal" href="#Py_False"><tt class="xref docutils literal"><span class="pre">Py_False</span></tt></a> and <a title="Py_True" class="reference internal" href="#Py_True"><tt class="xref docutils literal"><span class="pre">Py_True</span></tt></a>. As such, the normal creation and deletion functions don’t apply to booleans. The following macros are available, however.</p> <dl class="cfunction"> <dt id="PyBool_Check"> int <tt class="descname">PyBool_Check</tt><big>(</big><a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyBool_Check" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if <em>o</em> is of type <tt class="xref docutils literal"><span class="pre">PyBool_Type</span></tt>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.3.</span></p> </dd></dl> <dl class="cvar"> <dt id="Py_False"> <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">Py_False</tt><a class="headerlink" href="#Py_False" title="Permalink to this definition">¶</a></dt> <dd>The Python <tt class="xref docutils literal"><span class="pre">False</span></tt> object. This object has no methods. It needs to be treated just like any other object with respect to reference counts.</dd></dl> <dl class="cvar"> <dt id="Py_True"> <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">Py_True</tt><a class="headerlink" href="#Py_True" title="Permalink to this definition">¶</a></dt> <dd>The Python <tt class="xref docutils literal"><span class="pre">True</span></tt> object. This object has no methods. It needs to be treated just like any other object with respect to reference counts.</dd></dl> <dl class="cmacro"> <dt id="Py_RETURN_FALSE"> <tt class="descname">Py_RETURN_FALSE</tt><a class="headerlink" href="#Py_RETURN_FALSE" title="Permalink to this definition">¶</a></dt> <dd><p>Return <a title="Py_False" class="reference internal" href="#Py_False"><tt class="xref docutils literal"><span class="pre">Py_False</span></tt></a> from a function, properly incrementing its reference count.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.4.</span></p> </dd></dl> <dl class="cmacro"> <dt id="Py_RETURN_TRUE"> <tt class="descname">Py_RETURN_TRUE</tt><a class="headerlink" href="#Py_RETURN_TRUE" title="Permalink to this definition">¶</a></dt> <dd><p>Return <a title="Py_True" class="reference internal" href="#Py_True"><tt class="xref docutils literal"><span class="pre">Py_True</span></tt></a> from a function, properly incrementing its reference count.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.4.</span></p> </dd></dl> <dl class="cfunction"> <dt id="PyBool_FromLong"> <a title="PyObject" class="reference external" href="structures.html#PyObject">PyObject</a>* <tt class="descname">PyBool_FromLong</tt><big>(</big>long<em> v</em><big>)</big><a class="headerlink" href="#PyBool_FromLong" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a new reference to <a title="Py_True" class="reference internal" href="#Py_True"><tt class="xref docutils literal"><span class="pre">Py_True</span></tt></a> or <a title="Py_False" class="reference internal" href="#Py_False"><tt class="xref docutils literal"><span class="pre">Py_False</span></tt></a> depending on the truth value of <em>v</em>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.3.</span></p> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="int.html" title="previous chapter">Plain Integer Objects</a></p> <h4>Next topic</h4> <p class="topless"><a href="long.html" title="next chapter">Long Integer Objects</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/c-api/bool.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../modindex.html" title="Global Module Index" >modules</a> |</li> <li class="right" > <a href="long.html" title="Long Integer Objects" >next</a> |</li> <li class="right" > <a href="int.html" title="Plain Integer Objects" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" >Python/C API Reference Manual</a> »</li> <li><a href="concrete.html" >Concrete Objects Layer</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2011, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Jul 20, 2011. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6. </div> </body> </html>
Back to File Manager