<!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.gif" />
<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="mapping.html">
<LINK rel="prev" href="number.html">
<LINK rel="parent" href="abstract.html">
<LINK rel="next" href="mapping.html">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta name='aesop' content='information' />
<META name="description" content="Sequence Protocol ">
<META name="keywords" content="api">
<META name="resource-type" content="document">
<META name="distribution" content="global">
<title>6.3 Sequence Protocol </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.2 Number Protocol"
href="number.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="6. Abstract Objects Layer"
href="abstract.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="6.4 Mapping Protocol"
href="mapping.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="number.html">6.2 Number Protocol</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="abstract.html">6. Abstract Objects Layer</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="mapping.html">6.4 Mapping Protocol</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION008300000000000000000"><!--x--></A><A NAME="sequence"><!--z--></A>
<BR>
6.3 Sequence Protocol
</H1>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-258' class="cfunction">PySequence_Check</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
Return <code>1</code> if the object provides sequence protocol, and
<code>0</code> otherwise. This function always succeeds.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-259' class="cfunction">PySequence_Size</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
Returns the number of objects in sequence <var>o</var> on success, and
<code>-1</code> on failure. For objects that do not provide sequence
protocol, this is equivalent to the Python expression
"<tt class="samp">len(<var>o</var>)</tt>".<a id='l2h-260'><!--x--></a></dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-261' class="cfunction">PySequence_Length</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
Alternate name for <tt class="cfunction">PySequence_Size()</tt>.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-262' class="cfunction">PySequence_Concat</tt></b>(</nobr></td><td>PyObject *<var>o1</var>, PyObject *<var>o2</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return the concatenation of <var>o1</var> and <var>o2</var> on success, and
<tt class="constant">NULL</tt> on failure. This is the equivalent of the Python
expression "<tt class="samp"><var>o1</var> + <var>o2</var></tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-263' class="cfunction">PySequence_Repeat</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>count</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return the result of repeating sequence object <var>o</var> <var>count</var>
times, or <tt class="constant">NULL</tt> on failure. This is the equivalent of the Python
expression "<tt class="samp"><var>o</var> * <var>count</var></tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-264' class="cfunction">PySequence_InPlaceConcat</tt></b>(</nobr></td><td>PyObject *<var>o1</var>,
PyObject *<var>o2</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return the concatenation of <var>o1</var> and <var>o2</var> on success, and
<tt class="constant">NULL</tt> on failure. The operation is done <i>in-place</i> when
<var>o1</var> supports it. This is the equivalent of the Python
expression "<tt class="samp"><var>o1</var> += <var>o2</var></tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-265' class="cfunction">PySequence_InPlaceRepeat</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>count</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return the result of repeating sequence object <var>o</var> <var>count</var>
times, or <tt class="constant">NULL</tt> on failure. The operation is done <i>in-place</i>
when <var>o</var> supports it. This is the equivalent of the Python
expression "<tt class="samp"><var>o</var> *= <var>count</var></tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-266' class="cfunction">PySequence_GetItem</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return the <var>i</var>th element of <var>o</var>, or <tt class="constant">NULL</tt> on failure.
This is the equivalent of the Python expression
"<tt class="samp"><var>o</var>[<var>i</var>]</tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-267' class="cfunction">PySequence_GetSlice</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i1</var>, int <var>i2</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return the slice of sequence object <var>o</var> between <var>i1</var> and
<var>i2</var>, or <tt class="constant">NULL</tt> on failure. This is the equivalent of the
Python expression "<tt class="samp"><var>o</var>[<var>i1</var>:<var>i2</var>]</tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-268' class="cfunction">PySequence_SetItem</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i</var>, PyObject *<var>v</var>)</td></tr></table></dt>
<dd>
Assign object <var>v</var> to the <var>i</var>th element of <var>o</var>. Returns
<code>-1</code> on failure. This is the equivalent of the Python
statement "<tt class="samp"><var>o</var>[<var>i</var>] = <var>v</var></tt>". This function <i>does not</i>
steal a reference to <var>v</var>.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-269' class="cfunction">PySequence_DelItem</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i</var>)</td></tr></table></dt>
<dd>
Delete the <var>i</var>th element of object <var>o</var>. Returns <code>-1</code>
on failure. This is the equivalent of the Python statement
"<tt class="samp">del <var>o</var>[<var>i</var>]</tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-270' class="cfunction">PySequence_SetSlice</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i1</var>,
int <var>i2</var>, PyObject *<var>v</var>)</td></tr></table></dt>
<dd>
Assign the sequence object <var>v</var> to the slice in sequence object
<var>o</var> from <var>i1</var> to <var>i2</var>. This is the equivalent of the
Python statement "<tt class="samp"><var>o</var>[<var>i1</var>:<var>i2</var>] = <var>v</var></tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-271' class="cfunction">PySequence_DelSlice</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i1</var>, int <var>i2</var>)</td></tr></table></dt>
<dd>
Delete the slice in sequence object <var>o</var> from <var>i1</var> to
<var>i2</var>. Returns <code>-1</code> on failure. This is the equivalent of
the Python statement "<tt class="samp">del <var>o</var>[<var>i1</var>:<var>i2</var>]</tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-272' class="cfunction">PySequence_Tuple</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Returns the <var>o</var> as a tuple on success, and <tt class="constant">NULL</tt> on failure.
This is equivalent to the Python expression "<tt class="samp">tuple(<var>o</var>)</tt>".
<a id='l2h-273'><!--x--></a></dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-274' class="cfunction">PySequence_Count</tt></b>(</nobr></td><td>PyObject *<var>o</var>, PyObject *<var>value</var>)</td></tr></table></dt>
<dd>
Return the number of occurrences of <var>value</var> in <var>o</var>, that is,
return the number of keys for which <code><var>o</var>[<var>key</var>] ==
<var>value</var></code>. On failure, return <code>-1</code>. This is equivalent to
the Python expression "<tt class="samp"><var>o</var>.count(<var>value</var>)</tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-275' class="cfunction">PySequence_Contains</tt></b>(</nobr></td><td>PyObject *<var>o</var>, PyObject *<var>value</var>)</td></tr></table></dt>
<dd>
Determine if <var>o</var> contains <var>value</var>. If an item in <var>o</var> is
equal to <var>value</var>, return <code>1</code>, otherwise return <code>0</code>.
On error, return <code>-1</code>. This is equivalent to the Python
expression "<tt class="samp"><var>value</var> in <var>o</var></tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-276' class="cfunction">PySequence_Index</tt></b>(</nobr></td><td>PyObject *<var>o</var>, PyObject *<var>value</var>)</td></tr></table></dt>
<dd>
Return the first index <var>i</var> for which <code><var>o</var>[<var>i</var>] ==
<var>value</var></code>. On error, return <code>-1</code>. This is equivalent to
the Python expression "<tt class="samp"><var>o</var>.index(<var>value</var>)</tt>".
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-277' class="cfunction">PySequence_List</tt></b>(</nobr></td><td>PyObject *<var>o</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 list object with the same contents as the arbitrary
sequence <var>o</var>. The returned list is guaranteed to be new.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-278' class="cfunction">PySequence_Tuple</tt></b>(</nobr></td><td>PyObject *<var>o</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 tuple object with the same contents as the arbitrary
sequence <var>o</var>. If <var>o</var> is a tuple, a new reference will be
returned, otherwise a tuple will be constructed with the appropriate
contents.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-279' class="cfunction">PySequence_Fast</tt></b>(</nobr></td><td>PyObject *<var>o</var>, const char *<var>m</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Returns the sequence <var>o</var> as a tuple, unless it is already a
tuple or list, in which case <var>o</var> is returned. Use
<tt class="cfunction">PySequence_Fast_GET_ITEM()</tt> to access the members of the
result. Returns <tt class="constant">NULL</tt> on failure. If the object is not a
sequence, raises <tt class="exception">TypeError</tt> with <var>m</var> as the message
text.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-280' class="cfunction">PySequence_Fast_GET_ITEM</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">Borrowed reference.</span>
</div>
Return the <var>i</var>th element of <var>o</var>, assuming that <var>o</var> was
returned by <tt class="cfunction">PySequence_Fast()</tt>, <var>o</var> is not <tt class="constant">NULL</tt>,
and that <var>i</var> is within bounds.
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-281' class="cfunction">PySequence_ITEM</tt></b>(</nobr></td><td>PyObject *<var>o</var>, int <var>i</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
<span class="label">Return value:</span>
<span class="value">New reference.</span>
</div>
Return the <var>i</var>th element of <var>o</var> or <tt class="constant">NULL</tt> on failure.
Macro form of <tt class="cfunction">PySequence_GetItem()</tt> but without checking
that <tt class="cfunction">PySequence_Check(<var>o</var>)</tt> is true and without
adjustment for negative indices.
<span class="versionnote">New in version 2.3.</span>
</dd></dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-282' class="cfunction">PySequence_Fast_GET_SIZE</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
Returns the length of <var>o</var>, assuming that <var>o</var> was
returned by <tt class="cfunction">PySequence_Fast()</tt> and that <var>o</var> is
not <tt class="constant">NULL</tt>. The size can also be gotten by calling
<tt class="cfunction">PySequence_Size()</tt> on <var>o</var>, but
<tt class="cfunction">PySequence_Fast_GET_SIZE()</tt> is faster because it can
assume <var>o</var> is a list or tuple.
</dd></dl>
<P>
<DIV CLASS="navigation">
<div class='online-navigation'><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.2 Number Protocol"
rel="prev" title="6.2 Number Protocol"
href="number.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="6. Abstract Objects Layer"
rel="parent" title="6. Abstract Objects Layer"
href="abstract.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="6.4 Mapping Protocol"
rel="next" title="6.4 Mapping Protocol"
href="mapping.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"
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"
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="number.html">6.2 Number Protocol</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="abstract.html">6. Abstract Objects Layer</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="mapping.html">6.4 Mapping Protocol</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.3.4, documentation updated on May 20, 2004.</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>
