Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="api.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="api.html" title='Python/C API Reference Manual' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="longObjects.html" /> | |
13 | <link rel="prev" href="intObjects.html" /> | |
14 | <link rel="parent" href="numericObjects.html" /> | |
15 | <link rel="next" href="longObjects.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>7.2.2 Boolean Objects </title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="7.2.1 Plain Integer Objects" | |
25 | href="intObjects.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="7.2 Numeric Objects" | |
28 | href="numericObjects.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="7.2.3 Long Integer Objects" | |
31 | href="longObjects.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Python/C API Reference Manual</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><img src='../icons/blank.png' | |
38 | border='0' height='32' alt='' width='32' /></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="intObjects.html">7.2.1 Plain Integer Objects</A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="numericObjects.html">7.2 Numeric Objects</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="longObjects.html">7.2.3 Long Integer Objects</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H2><A NAME="SECTION009220000000000000000"></A><A NAME="boolObjects"></A> | |
56 | <BR> | |
57 | 7.2.2 Boolean Objects | |
58 | </H2> | |
59 | ||
60 | <P> | |
61 | Booleans in Python are implemented as a subclass of integers. There | |
62 | are only two booleans, <tt class="constant">Py_False</tt> and <tt class="constant">Py_True</tt>. As | |
63 | such, the normal creation and deletion functions don't apply to | |
64 | booleans. The following macros are available, however. | |
65 | ||
66 | <P> | |
67 | <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> | |
68 | <dd> | |
69 | Return true if <var>o</var> is of type <tt class="cdata">PyBool_Type</tt>. | |
70 | ||
71 | <span class="versionnote">New in version 2.3.</span> | |
72 | ||
73 | </dd></dl> | |
74 | ||
75 | <P> | |
76 | <dl><dt>PyObject* <b><tt id='l2h-385' xml:id='l2h-385' class="cdata">Py_False</tt></b></dt> | |
77 | <dd> | |
78 | The Python <code>False</code> object. This object has no methods. It needs to | |
79 | be treated just like any other object with respect to reference counts. | |
80 | </dd></dl> | |
81 | ||
82 | <P> | |
83 | <dl><dt>PyObject* <b><tt id='l2h-386' xml:id='l2h-386' class="cdata">Py_True</tt></b></dt> | |
84 | <dd> | |
85 | The Python <code>True</code> object. This object has no methods. It needs to | |
86 | be treated just like any other object with respect to reference counts. | |
87 | </dd></dl> | |
88 | ||
89 | <P> | |
90 | <dl><dt><b><tt id='l2h-387' xml:id='l2h-387' class="macro">Py_RETURN_FALSE</tt></b></dt> | |
91 | <dd> | |
92 | Return <tt class="constant">Py_False</tt> from a function, properly incrementing its | |
93 | reference count. | |
94 | ||
95 | <span class="versionnote">New in version 2.4.</span> | |
96 | ||
97 | </dl> | |
98 | ||
99 | <P> | |
100 | <dl><dt><b><tt id='l2h-388' xml:id='l2h-388' class="macro">Py_RETURN_TRUE</tt></b></dt> | |
101 | <dd> | |
102 | Return <tt class="constant">Py_True</tt> from a function, properly incrementing its | |
103 | reference count. | |
104 | ||
105 | <span class="versionnote">New in version 2.4.</span> | |
106 | ||
107 | </dl> | |
108 | ||
109 | <P> | |
110 | <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> | |
111 | <dd> | |
112 | Return a new reference to <tt class="constant">Py_True</tt> or <tt class="constant">Py_False</tt> | |
113 | depending on the truth value of <var>v</var>. | |
114 | ||
115 | <span class="versionnote">New in version 2.3.</span> | |
116 | ||
117 | </dd></dl> | |
118 | ||
119 | <P> | |
120 | ||
121 | <DIV CLASS="navigation"> | |
122 | <div class='online-navigation'> | |
123 | <p></p><hr /> | |
124 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
125 | <tr> | |
126 | <td class='online-navigation'><a rel="prev" title="7.2.1 Plain Integer Objects" | |
127 | href="intObjects.html"><img src='../icons/previous.png' | |
128 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
129 | <td class='online-navigation'><a rel="parent" title="7.2 Numeric Objects" | |
130 | href="numericObjects.html"><img src='../icons/up.png' | |
131 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
132 | <td class='online-navigation'><a rel="next" title="7.2.3 Long Integer Objects" | |
133 | href="longObjects.html"><img src='../icons/next.png' | |
134 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
135 | <td align="center" width="100%">Python/C API Reference Manual</td> | |
136 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
137 | href="contents.html"><img src='../icons/contents.png' | |
138 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
139 | <td class='online-navigation'><img src='../icons/blank.png' | |
140 | border='0' height='32' alt='' width='32' /></td> | |
141 | <td class='online-navigation'><a rel="index" title="Index" | |
142 | href="genindex.html"><img src='../icons/index.png' | |
143 | border='0' height='32' alt='Index' width='32' /></A></td> | |
144 | </tr></table> | |
145 | <div class='online-navigation'> | |
146 | <b class="navlabel">Previous:</b> | |
147 | <a class="sectref" rel="prev" href="intObjects.html">7.2.1 Plain Integer Objects</A> | |
148 | <b class="navlabel">Up:</b> | |
149 | <a class="sectref" rel="parent" href="numericObjects.html">7.2 Numeric Objects</A> | |
150 | <b class="navlabel">Next:</b> | |
151 | <a class="sectref" rel="next" href="longObjects.html">7.2.3 Long Integer Objects</A> | |
152 | </div> | |
153 | </div> | |
154 | <hr /> | |
155 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
156 | </DIV> | |
157 | <!--End of Navigation Panel--> | |
158 | <ADDRESS> | |
159 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
160 | </ADDRESS> | |
161 | </BODY> | |
162 | </HTML> |