File: //usr/local/ssl/local/ssl/share/doc/python-docs-2.4.3/html/api/longObjects.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="floatObjects.html" />
<link rel="prev" href="boolObjects.html" />
<link rel="parent" href="numericObjects.html" />
<link rel="next" href="floatObjects.html" />
<meta name='aesop' content='information' />
<title>7.2.3 Long 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.2 Boolean Objects"
href="boolObjects.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.4 Floating Point Objects"
href="floatObjects.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="boolObjects.html">7.2.2 Boolean 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="floatObjects.html">7.2.4 Floating Point Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION009230000000000000000"></A><A NAME="longObjects"></A>
<BR>
7.2.3 Long Integer Objects
</H2>
<P>
<a id='l2h-389' xml:id='l2h-389'></a><dl><dt><b><tt class="ctype"><a id='l2h-390' xml:id='l2h-390'>PyLongObject</a></tt></b></dt>
<dd>
This subtype of <tt class="ctype">PyObject</tt> represents a Python long integer
object.
</dl>
<P>
<dl><dt>PyTypeObject <b><tt id='l2h-391' xml:id='l2h-391' class="cdata">PyLong_Type</tt></b></dt>
<dd>
This instance of <tt class="ctype">PyTypeObject</tt> represents the Python long
integer type. This is the same object as <code>types.LongType</code>.
<a id='l2h-393' xml:id='l2h-393'></a></dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-394' xml:id='l2h-394' class="cfunction">PyLong_Check</tt></b>(</nobr></td><td>PyObject *<var>p</var>)</td></tr></table></dt>
<dd>
Return true if its argument is a <tt class="ctype">PyLongObject</tt> or a subtype
of <tt class="ctype">PyLongObject</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-395' xml:id='l2h-395' class="cfunction">PyLong_CheckExact</tt></b>(</nobr></td><td>PyObject *<var>p</var>)</td></tr></table></dt>
<dd>
Return true if its argument is a <tt class="ctype">PyLongObject</tt>, but not a
subtype of <tt class="ctype">PyLongObject</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-396' xml:id='l2h-396' class="cfunction">PyLong_FromLong</tt></b>(</nobr></td><td>long <var>v</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return a new <tt class="ctype">PyLongObject</tt> object from <var>v</var>, or <tt class="constant">NULL</tt>
on failure.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-397' xml:id='l2h-397' class="cfunction">PyLong_FromUnsignedLong</tt></b>(</nobr></td><td>unsigned long <var>v</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return a new <tt class="ctype">PyLongObject</tt> object from a C <tt class="ctype">unsigned
long</tt>, or <tt class="constant">NULL</tt> on failure.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-398' xml:id='l2h-398' class="cfunction">PyLong_FromLongLong</tt></b>(</nobr></td><td>long long <var>v</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return a new <tt class="ctype">PyLongObject</tt> object from a C <tt class="ctype">long long</tt>,
or <tt class="constant">NULL</tt> on failure.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-399' xml:id='l2h-399' class="cfunction">PyLong_FromUnsignedLongLong</tt></b>(</nobr></td><td>unsigned long long <var>v</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return a new <tt class="ctype">PyLongObject</tt> object from a C <tt class="ctype">unsigned
long long</tt>, or <tt class="constant">NULL</tt> on failure.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-400' xml:id='l2h-400' class="cfunction">PyLong_FromDouble</tt></b>(</nobr></td><td>double <var>v</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return a new <tt class="ctype">PyLongObject</tt> object from the integer part of
<var>v</var>, or <tt class="constant">NULL</tt> on failure.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-401' xml:id='l2h-401' class="cfunction">PyLong_FromString</tt></b>(</nobr></td><td>char *<var>str</var>, char **<var>pend</var>,
int <var>base</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return a new <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.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-402' xml:id='l2h-402' class="cfunction">PyLong_FromUnicode</tt></b>(</nobr></td><td>Py_UNICODE *<var>u</var>,
int <var>length</var>, int <var>base</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Convert a sequence of Unicode digits to a Python long integer
value. The first parameter, <var>u</var>, points to the first character
of the Unicode string, <var>length</var> gives the number of characters,
and <var>base</var> is the radix for the conversion. The radix must be
in the range [2, 36]; if it is out of range, <tt class="exception">ValueError</tt>
will be raised.
<span class="versionnote">New in version 1.6.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-403' xml:id='l2h-403' class="cfunction">PyLong_FromVoidPtr</tt></b>(</nobr></td><td>void *<var>p</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 Python integer or long integer from the pointer <var>p</var>.
The pointer value can be retrieved from the resulting value using
<tt class="cfunction">PyLong_AsVoidPtr()</tt>.
<span class="versionnote">New in version 1.5.2.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>long <b><tt id='l2h-404' xml:id='l2h-404' class="cfunction">PyLong_AsLong</tt></b>(</nobr></td><td>PyObject *<var>pylong</var>)</td></tr></table></dt>
<dd>
Return a C <tt class="ctype">long</tt> representation of the contents of
<var>pylong</var>. If <var>pylong</var> is greater than
<tt class="constant">LONG_MAX</tt><a id='l2h-416' xml:id='l2h-416'></a>, an <tt class="exception">OverflowError</tt>
is raised.
<a id='l2h-406' xml:id='l2h-406'></a></dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>unsigned long <b><tt id='l2h-407' xml:id='l2h-407' class="cfunction">PyLong_AsUnsignedLong</tt></b>(</nobr></td><td>PyObject *<var>pylong</var>)</td></tr></table></dt>
<dd>
Return a C <tt class="ctype">unsigned long</tt> representation of the contents of
<var>pylong</var>. If <var>pylong</var> is greater than
<tt class="constant">ULONG_MAX</tt><a id='l2h-417' xml:id='l2h-417'></a>, an
<tt class="exception">OverflowError</tt> is raised.
<a id='l2h-409' xml:id='l2h-409'></a></dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>long long <b><tt id='l2h-410' xml:id='l2h-410' class="cfunction">PyLong_AsLongLong</tt></b>(</nobr></td><td>PyObject *<var>pylong</var>)</td></tr></table></dt>
<dd>
Return a C <tt class="ctype">long long</tt> from a Python long integer. If
<var>pylong</var> cannot be represented as a <tt class="ctype">long long</tt>, an
<tt class="exception">OverflowError</tt> will be raised.
<span class="versionnote">New in version 2.2.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>unsigned long long <b><tt id='l2h-411' xml:id='l2h-411' class="cfunction">PyLong_AsUnsignedLongLong</tt></b>(</nobr></td><td>PyObject
*<var>pylong</var>)</td></tr></table></dt>
<dd>
Return a C <tt class="ctype">unsigned long long</tt> from a Python long integer.
If <var>pylong</var> cannot be represented as an <tt class="ctype">unsigned long
long</tt>, an <tt class="exception">OverflowError</tt> will be raised if the value is
positive, or a <tt class="exception">TypeError</tt> will be raised if the value is
negative.
<span class="versionnote">New in version 2.2.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>unsigned long <b><tt id='l2h-412' xml:id='l2h-412' class="cfunction">PyLong_AsUnsignedLongMask</tt></b>(</nobr></td><td>PyObject *<var>io</var>)</td></tr></table></dt>
<dd>
Return a C <tt class="ctype">unsigned long</tt> from a Python long integer, 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>unsigned long <b><tt id='l2h-413' xml:id='l2h-413' class="cfunction">PyLong_AsUnsignedLongLongMask</tt></b>(</nobr></td><td>PyObject *<var>io</var>)</td></tr></table></dt>
<dd>
Return a C <tt class="ctype">unsigned long long</tt> from a Python long integer, 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>double <b><tt id='l2h-414' xml:id='l2h-414' class="cfunction">PyLong_AsDouble</tt></b>(</nobr></td><td>PyObject *<var>pylong</var>)</td></tr></table></dt>
<dd>
Return a C <tt class="ctype">double</tt> representation of the contents of
<var>pylong</var>. If <var>pylong</var> cannot be approximately represented
as a <tt class="ctype">double</tt>, an <tt class="exception">OverflowError</tt> exception is
raised and <code>-1.0</code> will be returned.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>void* <b><tt id='l2h-415' xml:id='l2h-415' class="cfunction">PyLong_AsVoidPtr</tt></b>(</nobr></td><td>PyObject *<var>pylong</var>)</td></tr></table></dt>
<dd>
Convert a Python integer or long integer <var>pylong</var> to a C
<tt class="ctype">void</tt> pointer. If <var>pylong</var> cannot be converted, an
<tt class="exception">OverflowError</tt> will be raised. This is only assured to
produce a usable <tt class="ctype">void</tt> pointer for values created with
<tt class="cfunction">PyLong_FromVoidPtr()</tt>.
<span class="versionnote">New in version 1.5.2.</span>
</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.2 Boolean Objects"
href="boolObjects.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.4 Floating Point Objects"
href="floatObjects.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="boolObjects.html">7.2.2 Boolean 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="floatObjects.html">7.2.4 Floating Point 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>