Edit File: int.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>Plain Integer Objects — Python 2.7.5 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.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 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 2.7.5 documentation" href="../index.html" /> <link rel="up" title="Concrete Objects Layer" href="concrete.html" /> <link rel="next" title="Boolean Objects" href="bool.html" /> <link rel="prev" title="The None Object" href="none.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </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="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="bool.html" title="Boolean Objects" accesskey="N">next</a> |</li> <li class="right" > <a href="none.html" title="The None Object" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 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="plain-integer-objects"> <span id="intobjects"></span><h1>Plain Integer Objects<a class="headerlink" href="#plain-integer-objects" title="Permalink to this headline">¶</a></h1> <span class="target" id="index-0"></span><dl class="type"> <dt id="PyIntObject"> <tt class="descname">PyIntObject</tt><a class="headerlink" href="#PyIntObject" title="Permalink to this definition">¶</a></dt> <dd><p>This subtype of <a class="reference internal" href="structures.html#PyObject" title="PyObject"><tt class="xref c c-type docutils literal"><span class="pre">PyObject</span></tt></a> represents a Python integer object.</p> </dd></dl> <dl class="var"> <dt id="PyInt_Type"> <a class="reference internal" href="type.html#PyTypeObject" title="PyTypeObject">PyTypeObject</a> <tt class="descname">PyInt_Type</tt><a class="headerlink" href="#PyInt_Type" title="Permalink to this definition">¶</a></dt> <dd><p id="index-1">This instance of <a class="reference internal" href="type.html#PyTypeObject" title="PyTypeObject"><tt class="xref c c-type docutils literal"><span class="pre">PyTypeObject</span></tt></a> represents the Python plain integer type. This is the same object as <tt class="docutils literal"><span class="pre">int</span></tt> and <tt class="docutils literal"><span class="pre">types.IntType</span></tt>.</p> </dd></dl> <dl class="function"> <dt id="PyInt_Check"> int <tt class="descname">PyInt_Check</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyInt_Check" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if <em>o</em> is of type <a class="reference internal" href="#PyInt_Type" title="PyInt_Type"><tt class="xref c c-data docutils literal"><span class="pre">PyInt_Type</span></tt></a> or a subtype of <a class="reference internal" href="#PyInt_Type" title="PyInt_Type"><tt class="xref c c-data docutils literal"><span class="pre">PyInt_Type</span></tt></a>.</p> <p class="versionchanged"> <span class="versionmodified">Changed in version 2.2: </span>Allowed subtypes to be accepted.</p> </dd></dl> <dl class="function"> <dt id="PyInt_CheckExact"> int <tt class="descname">PyInt_CheckExact</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *o</em><big>)</big><a class="headerlink" href="#PyInt_CheckExact" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if <em>o</em> is of type <a class="reference internal" href="#PyInt_Type" title="PyInt_Type"><tt class="xref c c-data docutils literal"><span class="pre">PyInt_Type</span></tt></a>, but not a subtype of <a class="reference internal" href="#PyInt_Type" title="PyInt_Type"><tt class="xref c c-data docutils literal"><span class="pre">PyInt_Type</span></tt></a>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.2.</span></p> </dd></dl> <dl class="function"> <dt id="PyInt_FromString"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyInt_FromString</tt><big>(</big>char<em> *str</em>, char<em> **pend</em>, int<em> base</em><big>)</big><a class="headerlink" href="#PyInt_FromString" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Return a new <a class="reference internal" href="#PyIntObject" title="PyIntObject"><tt class="xref c c-type docutils literal"><span class="pre">PyIntObject</span></tt></a> or <a class="reference internal" href="long.html#PyLongObject" title="PyLongObject"><tt class="xref c c-type docutils literal"><span class="pre">PyLongObject</span></tt></a> based on the string value in <em>str</em>, which is interpreted according to the radix in <em>base</em>. If <em>pend</em> is non-<em>NULL</em>, <tt class="docutils literal"><span class="pre">*pend</span></tt> will point to the first character in <em>str</em> which follows the representation of the number. If <em>base</em> is <tt class="docutils literal"><span class="pre">0</span></tt>, the radix will be determined based on the leading characters of <em>str</em>: if <em>str</em> starts with <tt class="docutils literal"><span class="pre">'0x'</span></tt> or <tt class="docutils literal"><span class="pre">'0X'</span></tt>, radix 16 will be used; if <em>str</em> starts with <tt class="docutils literal"><span class="pre">'0'</span></tt>, radix 8 will be used; otherwise radix 10 will be used. If <em>base</em> is not <tt class="docutils literal"><span class="pre">0</span></tt>, it must be between <tt class="docutils literal"><span class="pre">2</span></tt> and <tt class="docutils literal"><span class="pre">36</span></tt>, inclusive. Leading spaces are ignored. If there are no digits, <a class="reference internal" href="../library/exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> will be raised. If the string represents a number too large to be contained within the machine’s <tt class="xref c c-type docutils literal"><span class="pre">long</span> <span class="pre">int</span></tt> type and overflow warnings are being suppressed, a <a class="reference internal" href="long.html#PyLongObject" title="PyLongObject"><tt class="xref c c-type docutils literal"><span class="pre">PyLongObject</span></tt></a> will be returned. If overflow warnings are not being suppressed, <em>NULL</em> will be returned in this case.</p> </dd></dl> <dl class="function"> <dt id="PyInt_FromLong"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyInt_FromLong</tt><big>(</big>long<em> ival</em><big>)</big><a class="headerlink" href="#PyInt_FromLong" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a new integer object with a value of <em>ival</em>.</p> <p>The current implementation keeps an array of integer objects for all integers between <tt class="docutils literal"><span class="pre">-5</span></tt> and <tt class="docutils literal"><span class="pre">256</span></tt>, 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 <tt class="docutils literal"><span class="pre">1</span></tt>. I suspect the behaviour of Python in this case is undefined. :-)</p> </dd></dl> <dl class="function"> <dt id="PyInt_FromSsize_t"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyInt_FromSsize_t</tt><big>(</big>Py_ssize_t<em> ival</em><big>)</big><a class="headerlink" href="#PyInt_FromSsize_t" title="Permalink to this definition">¶</a></dt> <dd><em class="refcount">Return value: New reference.</em><p>Create a new integer object with a value of <em>ival</em>. If the value is larger than <tt class="docutils literal"><span class="pre">LONG_MAX</span></tt> or smaller than <tt class="docutils literal"><span class="pre">LONG_MIN</span></tt>, a long integer object is returned.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.5.</span></p> </dd></dl> <dl class="function"> <dt id="PyInt_FromSize_t"> <a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a>* <tt class="descname">PyInt_FromSize_t</tt><big>(</big>size_t<em> ival</em><big>)</big><a class="headerlink" href="#PyInt_FromSize_t" title="Permalink to this definition">¶</a></dt> <dd><p>Create a new integer object with a value of <em>ival</em>. If the value exceeds <tt class="docutils literal"><span class="pre">LONG_MAX</span></tt>, a long integer object is returned.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.5.</span></p> </dd></dl> <dl class="function"> <dt id="PyInt_AsLong"> long <tt class="descname">PyInt_AsLong</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *io</em><big>)</big><a class="headerlink" href="#PyInt_AsLong" title="Permalink to this definition">¶</a></dt> <dd><p>Will first attempt to cast the object to a <a class="reference internal" href="#PyIntObject" title="PyIntObject"><tt class="xref c c-type docutils literal"><span class="pre">PyIntObject</span></tt></a>, if it is not already one, and then return its value. If there is an error, <tt class="docutils literal"><span class="pre">-1</span></tt> is returned, and the caller should check <tt class="docutils literal"><span class="pre">PyErr_Occurred()</span></tt> to find out whether there was an error, or whether the value just happened to be -1.</p> </dd></dl> <dl class="function"> <dt id="PyInt_AS_LONG"> long <tt class="descname">PyInt_AS_LONG</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *io</em><big>)</big><a class="headerlink" href="#PyInt_AS_LONG" title="Permalink to this definition">¶</a></dt> <dd><p>Return the value of the object <em>io</em>. No error checking is performed.</p> </dd></dl> <dl class="function"> <dt id="PyInt_AsUnsignedLongMask"> unsigned long <tt class="descname">PyInt_AsUnsignedLongMask</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *io</em><big>)</big><a class="headerlink" href="#PyInt_AsUnsignedLongMask" title="Permalink to this definition">¶</a></dt> <dd><p>Will first attempt to cast the object to a <a class="reference internal" href="#PyIntObject" title="PyIntObject"><tt class="xref c c-type docutils literal"><span class="pre">PyIntObject</span></tt></a> or <a class="reference internal" href="long.html#PyLongObject" title="PyLongObject"><tt class="xref c c-type docutils literal"><span class="pre">PyLongObject</span></tt></a>, if it is not already one, and then return its value as unsigned long. This function does not check for overflow.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.3.</span></p> </dd></dl> <dl class="function"> <dt id="PyInt_AsUnsignedLongLongMask"> unsigned PY_LONG_LONG <tt class="descname">PyInt_AsUnsignedLongLongMask</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *io</em><big>)</big><a class="headerlink" href="#PyInt_AsUnsignedLongLongMask" title="Permalink to this definition">¶</a></dt> <dd><p>Will first attempt to cast the object to a <a class="reference internal" href="#PyIntObject" title="PyIntObject"><tt class="xref c c-type docutils literal"><span class="pre">PyIntObject</span></tt></a> or <a class="reference internal" href="long.html#PyLongObject" title="PyLongObject"><tt class="xref c c-type docutils literal"><span class="pre">PyLongObject</span></tt></a>, if it is not already one, and then return its value as unsigned long long, without checking for overflow.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.3.</span></p> </dd></dl> <dl class="function"> <dt id="PyInt_AsSsize_t"> Py_ssize_t <tt class="descname">PyInt_AsSsize_t</tt><big>(</big><a class="reference internal" href="structures.html#PyObject" title="PyObject">PyObject</a><em> *io</em><big>)</big><a class="headerlink" href="#PyInt_AsSsize_t" title="Permalink to this definition">¶</a></dt> <dd><p>Will first attempt to cast the object to a <a class="reference internal" href="#PyIntObject" title="PyIntObject"><tt class="xref c c-type docutils literal"><span class="pre">PyIntObject</span></tt></a> or <a class="reference internal" href="long.html#PyLongObject" title="PyLongObject"><tt class="xref c c-type docutils literal"><span class="pre">PyLongObject</span></tt></a>, if it is not already one, and then return its value as <tt class="xref c c-type docutils literal"><span class="pre">Py_ssize_t</span></tt>.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.5.</span></p> </dd></dl> <dl class="function"> <dt id="PyInt_GetMax"> long <tt class="descname">PyInt_GetMax</tt><big>(</big><big>)</big><a class="headerlink" href="#PyInt_GetMax" title="Permalink to this definition">¶</a></dt> <dd><p id="index-2">Return the system’s idea of the largest integer it can handle (<tt class="xref py py-const docutils literal"><span class="pre">LONG_MAX</span></tt>, as defined in the system header files).</p> </dd></dl> <dl class="function"> <dt id="PyInt_ClearFreeList"> int <tt class="descname">PyInt_ClearFreeList</tt><big>(</big><big>)</big><a class="headerlink" href="#PyInt_ClearFreeList" title="Permalink to this definition">¶</a></dt> <dd><p>Clear the integer free list. Return the number of items that could not be freed.</p> <p class="versionadded"> <span class="versionmodified">New in version 2.6.</span></p> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="none.html" title="previous chapter">The None Object</a></p> <h4>Next topic</h4> <p class="topless"><a href="bool.html" title="next chapter">Boolean 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/int.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" /> <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="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="bool.html" title="Boolean Objects" >next</a> |</li> <li class="right" > <a href="none.html" title="The None Object" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 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-2020, 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 Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>