File: //usr/share/doc/python-docs-2.4.3/html/api/intObjects.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<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="boolObjects.html" />
<link rel="prev" href="numericObjects.html" />
<link rel="parent" href="numericObjects.html" />
<link rel="next" href="boolObjects.html" />
<meta name='aesop' content='information' />
<title>7.2.1 Plain Integer Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.2 Numeric Objects"
href="numericObjects.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.2 Boolean Objects"
href="boolObjects.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="numericObjects.html">7.2 Numeric 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="boolObjects.html">7.2.2 Boolean Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION009210000000000000000"></A><A NAME="intObjects"></A>
<BR>
7.2.1 Plain Integer Objects
</H2>
<P>
<a id='l2h-368' xml:id='l2h-368'></a><dl><dt><b><tt class="ctype"><a id='l2h-369' xml:id='l2h-369'>PyIntObject</a></tt></b></dt>
<dd>
This subtype of <tt class="ctype">PyObject</tt> represents a Python integer
object.
</dl>
<P>
<dl><dt>PyTypeObject <b><tt id='l2h-370' xml:id='l2h-370' class="cdata">PyInt_Type</tt></b></dt>
<dd>
This instance of <tt class="ctype">PyTypeObject</tt> represents the Python plain
integer type. This is the same object as <code>types.IntType</code>.
<a id='l2h-372' xml:id='l2h-372'></a></dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-373' xml:id='l2h-373' class="cfunction">PyInt_Check</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
Return true if <var>o</var> is of type <tt class="cdata">PyInt_Type</tt> or a subtype
of <tt class="cdata">PyInt_Type</tt>.
<span class="versionnote">Changed in version 2.2:
Allowed subtypes to be accepted.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-374' xml:id='l2h-374' class="cfunction">PyInt_CheckExact</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
Return true if <var>o</var> is of type <tt class="cdata">PyInt_Type</tt>, but not a
subtype of <tt class="cdata">PyInt_Type</tt>.
<span class="versionnote">New in version 2.2.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-375' xml:id='l2h-375' class="cfunction">PyInt_FromString</tt></b>(</nobr></td><td>char *<var>str</var>, char **<var>pend</var>,
int <var>base</var>)</td></tr></table></dt>
<dd>
Return a new <tt class="ctype">PyIntObject</tt> or <tt class="ctype">PyLongObject</tt> based on the
string value in <var>str</var>, which is interpreted according to the radix in
<var>base</var>. If <var>pend</var> is non-<tt class="constant">NULL</tt>, <code>*<var>pend</var></code> will point to
the first character in <var>str</var> which follows the representation of the
number. If <var>base</var> is <code>0</code>, the radix will be determined based on
the leading characters of <var>str</var>: if <var>str</var> starts with <code>'0x'</code>
or <code>'0X'</code>, radix 16 will be used; if <var>str</var> starts with
<code>'0'</code>, radix 8 will be used; otherwise radix 10 will be used. If
<var>base</var> is not <code>0</code>, it must be between <code>2</code> and <code>36</code>,
inclusive. Leading spaces are ignored. If there are no digits,
<tt class="exception">ValueError</tt> will be raised. If the string represents a number
too large to be contained within the machine's <tt class="ctype">long int</tt> type and
overflow warnings are being suppressed, a <tt class="ctype">PyLongObject</tt> will be
returned. If overflow warnings are not being suppressed, <tt class="constant">NULL</tt> will be
returned in this case.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-376' xml:id='l2h-376' class="cfunction">PyInt_FromLong</tt></b>(</nobr></td><td>long <var>ival</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Create a new integer object with a value of <var>ival</var>.
<P>
The current implementation keeps an array of integer objects for all
integers between <code>-1</code> and <code>100</code>, when you create an int in
that range you actually just get back a reference to the existing
object. So it should be possible to change the value of <code>1</code>. I
suspect the behaviour of Python in this case is undefined. :-)
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>long <b><tt id='l2h-377' xml:id='l2h-377' class="cfunction">PyInt_AsLong</tt></b>(</nobr></td><td>PyObject *<var>io</var>)</td></tr></table></dt>
<dd>
Will first attempt to cast the object to a <tt class="ctype">PyIntObject</tt>, if
it is not already one, and then return its value.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>long <b><tt id='l2h-378' xml:id='l2h-378' class="cfunction">PyInt_AS_LONG</tt></b>(</nobr></td><td>PyObject *<var>io</var>)</td></tr></table></dt>
<dd>
Return the value of the object <var>io</var>. No error checking is
performed.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>unsigned long <b><tt id='l2h-379' xml:id='l2h-379' class="cfunction">PyInt_AsUnsignedLongMask</tt></b>(</nobr></td><td>PyObject *<var>io</var>)</td></tr></table></dt>
<dd>
Will first attempt to cast the object to a <tt class="ctype">PyIntObject</tt> or
<tt class="ctype">PyLongObject</tt>, if it is not already one, and then return its
value as unsigned long. This function does not check for overflow.
<span class="versionnote">New in version 2.3.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>unsigned long long <b><tt id='l2h-380' xml:id='l2h-380' class="cfunction">PyInt_AsUnsignedLongLongMask</tt></b>(</nobr></td><td>PyObject *<var>io</var>)</td></tr></table></dt>
<dd>
Will first attempt to cast the object to a <tt class="ctype">PyIntObject</tt> or
<tt class="ctype">PyLongObject</tt>, if it is not already one, and then return its
value as unsigned long long, without checking for overflow.
<span class="versionnote">New in version 2.3.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>long <b><tt id='l2h-381' xml:id='l2h-381' class="cfunction">PyInt_GetMax</tt></b>(</nobr></td><td>)</td></tr></table></dt>
<dd>
Return the system's idea of the largest integer it can handle
(<tt class="constant">LONG_MAX</tt><a id='l2h-382' xml:id='l2h-382'></a>, as defined in the system
header files).
</dd></dl>
<P>
<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.2 Numeric Objects"
href="numericObjects.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.2 Boolean Objects"
href="boolObjects.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="numericObjects.html">7.2 Numeric 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="boolObjects.html">7.2.2 Boolean Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.3, documentation updated on 29 March 2006.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>