Gecko [ v99win.today ]

Name	Size	Permission
abstract.html	7.8 KB	-rw-r--r--
allocation.html	24.04 KB	-rw-r--r--
arg.html	64.25 KB	-rw-r--r--
bool.html	11.44 KB	-rw-r--r--
buffer.html	58.49 KB	-rw-r--r--
bytearray.html	18.39 KB	-rw-r--r--
capsule.html	26.78 KB	-rw-r--r--
cell.html	13.74 KB	-rw-r--r--
class.html	14.3 KB	-rw-r--r--
cobject.html	15.67 KB	-rw-r--r--
code.html	15.57 KB	-rw-r--r--
codec.html	29.28 KB	-rw-r--r--
complex.html	25.03 KB	-rw-r--r--
concrete.html	15.93 KB	-rw-r--r--
conversion.html	29.24 KB	-rw-r--r--
datetime.html	35.92 KB	-rw-r--r--
descriptor.html	15.74 KB	-rw-r--r--
dict.html	42.03 KB	-rw-r--r--
exceptions.html	112.66 KB	-rw-r--r--
file.html	28.8 KB	-rw-r--r--
float.html	21.5 KB	-rw-r--r--
function.html	17.69 KB	-rw-r--r--
gcsupport.html	29.5 KB	-rw-r--r--
gen.html	9.84 KB	-rw-r--r--
import.html	43.14 KB	-rw-r--r--
index.html	13.69 KB	-rw-r--r--
init.html	122.91 KB	-rw-r--r--
int.html	24.28 KB	-rw-r--r--
intro.html	57.73 KB	-rw-r--r--
iter.html	11.38 KB	-rw-r--r--
iterator.html	13.32 KB	-rw-r--r--
list.html	31.45 KB	-rw-r--r--
long.html	39.54 KB	-rw-r--r--
mapping.html	20.85 KB	-rw-r--r--
marshal.html	18.82 KB	-rw-r--r--
memory.html	37.51 KB	-rw-r--r--
method.html	16.77 KB	-rw-r--r--
module.html	21.95 KB	-rw-r--r--
none.html	8.76 KB	-rw-r--r--
number.html	64.95 KB	-rw-r--r--
objbuffer.html	14.62 KB	-rw-r--r--
object.html	74.9 KB	-rw-r--r--
objimpl.html	7.59 KB	-rw-r--r--
refcounting.html	14.46 KB	-rw-r--r--
reflection.html	12.81 KB	-rw-r--r--
sequence.html	41.73 KB	-rw-r--r--
set.html	35.44 KB	-rw-r--r--
slice.html	16.89 KB	-rw-r--r--
string.html	46.73 KB	-rw-r--r--
structures.html	41.96 KB	-rw-r--r--
sys.html	26.72 KB	-rw-r--r--
tuple.html	27.17 KB	-rw-r--r--
type.html	19.18 KB	-rw-r--r--
typeobj.html	209.91 KB	-rw-r--r--
unicode.html	160.87 KB	-rw-r--r--
utilities.html	7.88 KB	-rw-r--r--
veryhigh.html	66.91 KB	-rw-r--r--
weakref.html	15.68 KB	-rw-r--r--

Code Editor : tuple.html

<!DOCTYPE html>

<title>Tuple Objects &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="List Objects" href="list.html" />
 <link rel="prev" title="Buffers and Memoryview Objects" href="buffer.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/c-api/tuple.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/c-api/tuple.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="list.html" title="List Objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="buffer.html" title="Buffers and Memoryview Objects"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Tuple Objects</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="tuple-objects">
<h1>Tuple Objects<a class="headerlink" href="#tuple-objects" title="Permalink to this headline">¶</a></h1>
<dl class="c type">
<dt class="sig sig-object c" id="c.PyTupleObject">
type PyTupleObject<a class="headerlink" href="#c.PyTupleObject" title="Permalink to this definition">¶</a> </dt>
<dd>This subtype of <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> represents a Python tuple object.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyTuple_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyTuple_Type<a class="headerlink" href="#c.PyTuple_Type" title="Permalink to this definition">¶</a> </dt>
<dd>This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> represents the Python tuple type; it is
the same object as <code class="docutils literal notranslate">tuple</code> and <code class="docutils literal notranslate">types.TupleType</code> in the Python layer..
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_Check">
int PyTuple_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyTuple_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a tuple object or an instance of a subtype of the tuple
type.
<div class="versionchanged">
Changed in version 2.2: Allowed subtypes to be accepted.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_CheckExact">
int PyTuple_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyTuple_CheckExact" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if p is a tuple object, but not an instance of a subtype of the
tuple type.
<div class="versionadded">
New in version 2.2.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyTuple_New(Py_ssize_t len)<a class="headerlink" href="#c.PyTuple_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return a new tuple object of size len, or NULL on failure.
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for len. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_Pack">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyTuple_Pack(Py_ssize_t n, ...)<a class="headerlink" href="#c.PyTuple_Pack" title="Permalink to this definition">¶</a> </dt>
<dd>Return a new tuple object of size n, or NULL on failure. The tuple values
are initialized to the subsequent n C arguments pointing to Python objects.
<code class="docutils literal notranslate">PyTuple_Pack(2, a, b)</code> is equivalent to <code class="docutils literal notranslate">Py_BuildValue(&quot;(OO)&quot;, a, b)</code>.
<div class="versionadded">
New in version 2.4.
</div>
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for n. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_Size">
Py_ssize_t PyTuple_Size(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyTuple_Size" title="Permalink to this definition">¶</a> </dt>
<dd>Take a pointer to a tuple object, and return the size of that tuple.
<div class="versionchanged">
Changed in version 2.5: This function returned an <code class="xref c c-type docutils literal notranslate">int</code> type. This might require changes
in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_GET_SIZE">
Py_ssize_t PyTuple_GET_SIZE(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p)<a class="headerlink" href="#c.PyTuple_GET_SIZE" title="Permalink to this definition">¶</a> </dt>
<dd>Return the size of the tuple p, which must be non-NULL and point to a tuple;
no error checking is performed.
<div class="versionchanged">
Changed in version 2.5: This function returned an <code class="xref c c-type docutils literal notranslate">int</code> type. This might require changes
in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_GetItem">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyTuple_GetItem(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, Py_ssize_t pos)<a class="headerlink" href="#c.PyTuple_GetItem" title="Permalink to this definition">¶</a> </dt>
<dd>Return the object at position pos in the tuple pointed to by p. If pos is
out of bounds, return NULL and set an <code class="xref py py-exc docutils literal notranslate">IndexError</code> exception.
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for pos. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_GET_ITEM">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyTuple_GET_ITEM(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, Py_ssize_t pos)<a class="headerlink" href="#c.PyTuple_GET_ITEM" title="Permalink to this definition">¶</a> </dt>
<dd>Like <a class="reference internal" href="#c.PyTuple_GetItem" title="PyTuple_GetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_GetItem()</code></a>, but does no checking of its arguments.
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for pos. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_GetSlice">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyTuple_GetSlice(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, Py_ssize_t low, Py_ssize_t high)<a class="headerlink" href="#c.PyTuple_GetSlice" title="Permalink to this definition">¶</a> </dt>
<dd>Return the slice of the tuple pointed to by p between low and high,
or NULL on failure. This is the equivalent of the Python expression
<code class="docutils literal notranslate">p[low:high]</code>. Indexing from the end of the list is not supported.
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for low and high. This might
require changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_SetItem">
int PyTuple_SetItem(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, Py_ssize_t pos, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyTuple_SetItem" title="Permalink to this definition">¶</a> </dt>
<dd>Insert a reference to object o at position pos of the tuple pointed to by
p. Return <code class="docutils literal notranslate">0</code> on success. If pos is out of bounds, return <code class="docutils literal notranslate">-1</code>
and set an <code class="xref py py-exc docutils literal notranslate">IndexError</code> exception.
<div class="admonition note">
Note
This function “steals” a reference to o and discards a reference to
an item already in the tuple at the affected position.
</div>
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for pos. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_SET_ITEM">
void PyTuple_SET_ITEM(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *p, Py_ssize_t pos, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyTuple_SET_ITEM" title="Permalink to this definition">¶</a> </dt>
<dd>Like <a class="reference internal" href="#c.PyTuple_SetItem" title="PyTuple_SetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_SetItem()</code></a>, but does no error checking, and should only be
used to fill in brand new tuples.
<div class="admonition note">
Note
This macro “steals” a reference to o, and, unlike
<a class="reference internal" href="#c.PyTuple_SetItem" title="PyTuple_SetItem"><code class="xref c c-func docutils literal notranslate">PyTuple_SetItem()</code></a>, does not discard a reference to any item that
is being replaced; any reference in the tuple at position pos will be
leaked.
</div>
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for pos. This might require
changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c._PyTuple_Resize">
int _PyTuple_Resize(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> **p, Py_ssize_t newsize)<a class="headerlink" href="#c._PyTuple_Resize" title="Permalink to this definition">¶</a> </dt>
<dd>Can be used to resize a tuple. newsize will be the new length of the tuple.
Because tuples are supposed to be immutable, this should only be used if there
is only one reference to the object. Do not use this if the tuple may already
be known to some other part of the code. The tuple will always grow or shrink
at the end. Think of this as destroying the old tuple and creating a new one,
only more efficiently. Returns <code class="docutils literal notranslate">0</code> on success. Client code should never
assume that the resulting value of <code class="docutils literal notranslate">*p</code> will be the same as before calling
this function. If the object referenced by <code class="docutils literal notranslate">*p</code> is replaced, the original
<code class="docutils literal notranslate">*p</code> is destroyed. On failure, returns <code class="docutils literal notranslate">-1</code> and sets <code class="docutils literal notranslate">*p</code> to NULL, and
raises <code class="xref py py-exc docutils literal notranslate">MemoryError</code> or <code class="xref py py-exc docutils literal notranslate">SystemError</code>.
<div class="versionchanged">
Changed in version 2.2: Removed unused third parameter, last_is_sticky.
</div>
<div class="versionchanged">
Changed in version 2.5: This function used an <code class="xref c c-type docutils literal notranslate">int</code> type for newsize. This might
require changes in your code for properly supporting 64-bit systems.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyTuple_ClearFreeList">
int PyTuple_ClearFreeList()<a class="headerlink" href="#c.PyTuple_ClearFreeList" title="Permalink to this definition">¶</a> </dt>
<dd>Clear the free list. Return the total number of freed items.
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="buffer.html"
 title="previous chapter">Buffers and Memoryview Objects</a>
 <h4>Next topic</h4>
 <a href="list.html"
 title="next chapter">List Objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/c-api/tuple.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="list.html" title="List Objects"
 >next</a> |</li>
 <li class="right" >
 <a href="buffer.html" title="Buffers and Memoryview Objects"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Tuple Objects</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : tuple.html