1 .. highlightlang:: c

     2 

     3 .. _slice-objects:

     4 

     5 Slice Objects

     6 -------------

     7 

     8 

     9 .. cvar:: PyTypeObject PySlice_Type

    10 

    11    .. index:: single: SliceType (in module types)

    12 

    13    The type object for slice objects.  This is the same as ``slice`` and

    14    ``types.SliceType``.

    15 

    16 

    17 .. cfunction:: int PySlice_Check(PyObject *ob)

    18 

    19    Return true if *ob* is a slice object; *ob* must not be *NULL*.

    20 

    21 

    22 .. cfunction:: PyObject* PySlice_New(PyObject *start, PyObject *stop, PyObject *step)

    23 

    24    Return a new slice object with the given values.  The *start*, *stop*, and

    25    *step* parameters are used as the values of the slice object attributes of the

    26    same names.  Any of the values may be *NULL*, in which case the ``None`` will be

    27    used for the corresponding attribute.  Return *NULL* if the new object could not

    28    be allocated.

    29 

    30 

    31 .. cfunction:: int PySlice_GetIndices(PySliceObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)

    32 

    33    Retrieve the start, stop and step indices from the slice object *slice*,

    34    assuming a sequence of length *length*. Treats indices greater than *length* as

    35    errors.

    36 

    37    Returns 0 on success and -1 on error with no exception set (unless one of the

    38    indices was not :const:`None` and failed to be converted to an integer, in which

    39    case -1 is returned with an exception set).

    40 

    41    You probably do not want to use this function.  If you want to use slice objects

    42    in versions of Python prior to 2.3, you would probably do well to incorporate

    43    the source of :cfunc:`PySlice_GetIndicesEx`, suitably renamed, in the source of

    44    your extension.

    45 

    46 

    47 .. cfunction:: int PySlice_GetIndicesEx(PySliceObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength)

    48 

    49    Usable replacement for :cfunc:`PySlice_GetIndices`.  Retrieve the start, stop,

    50    and step indices from the slice object *slice* assuming a sequence of length

    51    *length*, and store the length of the slice in *slicelength*.  Out of bounds

    52    indices are clipped in a manner consistent with the handling of normal slices.

    53 

    54    Returns 0 on success and -1 on error with exception set.

    55 

    56    .. versionadded:: 2.3