Na}{

File Content: slice.html

<!DOCTYPE html>

<title>Slice Objects &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <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 3.10.12 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="MemoryView objects" href="memoryview.html" />
 <link rel="prev" title="Descriptor Objects" href="descriptor.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/c-api/slice.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Slice Objects</a></li>
<li><a class="reference internal" href="#ellipsis-object">Ellipsis Object</a></li>
</ul>

<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="memoryview.html" title="MemoryView objects"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="descriptor.html" title="Descriptor Objects"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 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="">Slice Objects</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="slice-objects">
<h1>Slice Objects<a class="headerlink" href="#slice-objects" title="Permalink to this headline">¶</a></h1>
<dl class="c var">
<dt class="sig sig-object c" id="c.PySlice_Type">
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PySlice_Type<a class="headerlink" href="#c.PySlice_Type" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.The type object for slice objects. This is the same as <a class="reference internal" href="../library/functions.html#slice" title="slice"><code class="xref py py-class docutils literal notranslate">slice</code></a> in the
Python layer.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySlice_Check">
int PySlice_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *ob)<a class="headerlink" href="#c.PySlice_Check" title="Permalink to this definition">¶</a> </dt>
<dd>Return true if ob is a slice object; ob must not be <code class="docutils literal notranslate">NULL</code>. This
function always succeeds.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySlice_New">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PySlice_New(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *stop, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *step)<a class="headerlink" href="#c.PySlice_New" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Return a new slice object with the given values. The start, stop, and
step parameters are used as the values of the slice object attributes of
the same names. Any of the values may be <code class="docutils literal notranslate">NULL</code>, in which case the
<code class="docutils literal notranslate">None</code> will be used for the corresponding attribute. Return <code class="docutils literal notranslate">NULL</code> if
the new object could not be allocated.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySlice_GetIndices">
int PySlice_GetIndices(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *slice, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> length, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *stop, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *step)<a class="headerlink" href="#c.PySlice_GetIndices" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Retrieve the start, stop and step indices from the slice object slice,
assuming a sequence of length length. Treats indices greater than
length as errors.
Returns <code class="docutils literal notranslate">0</code> on success and <code class="docutils literal notranslate">-1</code> on error with no exception set (unless one of
the indices was not <a class="reference internal" href="../library/constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> and failed to be converted to an integer,
in which case <code class="docutils literal notranslate">-1</code> is returned with an exception set).
You probably do not want to use this function.
<div class="versionchanged">
Changed in version 3.2: The parameter type for the slice parameter was <code class="docutils literal notranslate">PySliceObject*</code>
before.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySlice_GetIndicesEx">
int PySlice_GetIndicesEx(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *slice, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> length, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *stop, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *step, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *slicelength)<a class="headerlink" href="#c.PySlice_GetIndicesEx" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Usable replacement for <a class="reference internal" href="#c.PySlice_GetIndices" title="PySlice_GetIndices"><code class="xref c c-func docutils literal notranslate">PySlice_GetIndices()</code></a>. Retrieve the start,
stop, and step indices from the slice object slice assuming a sequence of
length length, and store the length of the slice in slicelength. Out
of bounds indices are clipped in a manner consistent with the handling of
normal slices.
Returns <code class="docutils literal notranslate">0</code> on success and <code class="docutils literal notranslate">-1</code> on error with exception set.
<div class="admonition note">
Note
This function is considered not safe for resizable sequences.
Its invocation should be replaced by a combination of
<a class="reference internal" href="#c.PySlice_Unpack" title="PySlice_Unpack"><code class="xref c c-func docutils literal notranslate">PySlice_Unpack()</code></a> and <a class="reference internal" href="#c.PySlice_AdjustIndices" title="PySlice_AdjustIndices"><code class="xref c c-func docutils literal notranslate">PySlice_AdjustIndices()</code></a> where
<div class="highlight-c notranslate"><div class="highlight"><pre>if (PySlice_GetIndicesEx(slice, length, &amp;start, &amp;stop, &amp;step, &amp;slicelength) &lt; 0) {
 // return error
}
</pre></div>
</div>
is replaced by
<div class="highlight-c notranslate"><div class="highlight"><pre>if (PySlice_Unpack(slice, &amp;start, &amp;stop, &amp;step) &lt; 0) {
 // return error
}
slicelength = PySlice_AdjustIndices(length, &amp;start, &amp;stop, step);
</pre></div>
</div>
</div>
<div class="versionchanged">
Changed in version 3.2: The parameter type for the slice parameter was <code class="docutils literal notranslate">PySliceObject*</code>
before.
</div>
<div class="versionchanged">
Changed in version 3.6.1: If <code class="docutils literal notranslate">Py_LIMITED_API</code> is not set or set to the value between <code class="docutils literal notranslate">0x03050400</code>
and <code class="docutils literal notranslate">0x03060000</code> (not including) or <code class="docutils literal notranslate">0x03060100</code> or higher
!<a class="reference internal" href="#c.PySlice_GetIndicesEx" title="PySlice_GetIndicesEx">PySlice_GetIndicesEx</a> is implemented as a macro using
!<a class="reference internal" href="#c.PySlice_Unpack" title="PySlice_Unpack">PySlice_Unpack</a> and !<a class="reference internal" href="#c.PySlice_AdjustIndices" title="PySlice_AdjustIndices">PySlice_AdjustIndices</a>.
Arguments start, stop and step are evaluated more than once.
</div>
<div class="deprecated">
Deprecated since version 3.6.1: If <code class="docutils literal notranslate">Py_LIMITED_API</code> is set to the value less than <code class="docutils literal notranslate">0x03050400</code> or
between <code class="docutils literal notranslate">0x03060000</code> and <code class="docutils literal notranslate">0x03060100</code> (not including)
!<a class="reference internal" href="#c.PySlice_GetIndicesEx" title="PySlice_GetIndicesEx">PySlice_GetIndicesEx</a> is a deprecated function.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySlice_Unpack">
int PySlice_Unpack(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *slice, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *stop, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *step)<a class="headerlink" href="#c.PySlice_Unpack" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Extract the start, stop and step data members from a slice object as
C integers. Silently reduce values larger than <code class="docutils literal notranslate">PY_SSIZE_T_MAX</code> to
<code class="docutils literal notranslate">PY_SSIZE_T_MAX</code>, silently boost the start and stop values less than
<code class="docutils literal notranslate">PY_SSIZE_T_MIN</code> to <code class="docutils literal notranslate">PY_SSIZE_T_MIN</code>, and silently boost the step
values less than <code class="docutils literal notranslate">-PY_SSIZE_T_MAX</code> to <code class="docutils literal notranslate">-PY_SSIZE_T_MAX</code>.
Return <code class="docutils literal notranslate">-1</code> on error, <code class="docutils literal notranslate">0</code> on success.
<div class="versionadded">
New in version 3.6.1.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PySlice_AdjustIndices">
<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PySlice_AdjustIndices(<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> length, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *start, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> *stop, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> step)<a class="headerlink" href="#c.PySlice_AdjustIndices" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.7.Adjust start/end slice indices assuming a sequence of the specified length.
Out of bounds indices are clipped in a manner consistent with the handling
of normal slices.
Return the length of the slice. Always successful. Doesn’t call Python
code.
<div class="versionadded">
New in version 3.6.1.
</div>
</dd></dl>

</section>
<section id="ellipsis-object">
<h1>Ellipsis Object<a class="headerlink" href="#ellipsis-object" title="Permalink to this headline">¶</a></h1>
<dl class="c var">
<dt class="sig sig-object c" id="c.Py_Ellipsis">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_Ellipsis<a class="headerlink" href="#c.Py_Ellipsis" title="Permalink to this definition">¶</a> </dt>
<dd>The Python <code class="docutils literal notranslate">Ellipsis</code> object. This object has no methods. It needs to be
treated just like any other object with respect to reference counts. Like
<a class="reference internal" href="none.html#c.Py_None" title="Py_None"><code class="xref c c-data docutils literal notranslate">Py_None</code></a> it is a singleton object.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Slice Objects</a></li>
<li><a class="reference internal" href="#ellipsis-object">Ellipsis Object</a></li>
</ul>

<h4>Previous topic</h4>
 <a href="descriptor.html"
 title="previous chapter">Descriptor Objects</a>
 <h4>Next topic</h4>
 <a href="memoryview.html"
 title="next chapter">MemoryView objects</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/slice.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </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="memoryview.html" title="MemoryView objects"
 >next</a> |</li>
 <li class="right" >
 <a href="descriptor.html" title="Descriptor Objects"
 >previous</a> |</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="">Slice Objects</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" 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>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on March 03, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

Name	Size	Permission
abstract.html	13785 bytes	0644
allocation.html	21792 bytes	0644
apiabiversion.html	16211 bytes	0644
arg.html	108002 bytes	0644
bool.html	14930 bytes	0644
buffer.html	85039 bytes	0644
bytearray.html	24599 bytes	0644
bytes.html	39748 bytes	0644
call.html	65686 bytes	0644
capsule.html	34281 bytes	0644
cell.html	18115 bytes	0644
code.html	25584 bytes	0644
codec.html	40461 bytes	0644
complex.html	31208 bytes	0644
concrete.html	21917 bytes	0644
contextvars.html	30987 bytes	0644
conversion.html	29280 bytes	0644
coro.html	14342 bytes	0644
datetime.html	54364 bytes	0644
descriptor.html	19959 bytes	0644
dict.html	57456 bytes	0644
exceptions.html	195384 bytes	0644
file.html	25550 bytes	0644
float.html	22362 bytes	0644
function.html	27764 bytes	0644
gcsupport.html	44468 bytes	0644
gen.html	16594 bytes	0644
import.html	63313 bytes	0644
index.html	22769 bytes	0644
init.html	230417 bytes	0644
init_config.html	209078 bytes	0644
intro.html	98922 bytes	0644
iter.html	20085 bytes	0644
iterator.html	17273 bytes	0644
list.html	35749 bytes	0644
long.html	63626 bytes	0644
mapping.html	29107 bytes	0644
marshal.html	24464 bytes	0644
memory.html	98209 bytes	0644
memoryview.html	20482 bytes	0644
method.html	24549 bytes	0644
module.html	100658 bytes	0644
none.html	12386 bytes	0644
number.html	76417 bytes	0644
objbuffer.html	19572 bytes	0644
object.html	82873 bytes	0644
objimpl.html	13343 bytes	0644
refcounting.html	26236 bytes	0644
reflection.html	21182 bytes	0644
sequence.html	48060 bytes	0644
set.html	42499 bytes	0644
slice.html	31675 bytes	0644
stable.html	200491 bytes	0644
structures.html	75498 bytes	0644
sys.html	71094 bytes	0644
tuple.html	48635 bytes	0644
type.html	56345 bytes	0644
typehints.html	17013 bytes	0644
typeobj.html	438681 bytes	0644
unicode.html	294070 bytes	0644
utilities.html	12163 bytes	0644
veryhigh.html	83644 bytes	0644
weakref.html	21557 bytes	0644