Doc/c-api/slice.rst

   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
  26    the same names.  Any of the values may be *NULL*, in which case the
  27    ``None`` will be used for the corresponding attribute.  Return *NULL* if
  28    the new object could not 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
  35    *length* as errors.
  36
  37    Returns 0 on success and -1 on error with no exception set (unless one of
  38    the indices was not :const:`None` and failed to be converted to an integer,
  39    in which case -1 is returned with an exception set).
  40
  41    You probably do not want to use this function.
  42
  43
  44 .. 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)
  45
  46    Usable replacement for :cfunc:`PySlice_GetIndices`.  Retrieve the start,
  47    stop, and step indices from the slice object *slice* assuming a sequence of
  48    length *length*, and store the length of the slice in *slicelength*.  Out
  49    of bounds indices are clipped in a manner consistent with the handling of
  50    normal slices.
  51
  52    Returns 0 on success and -1 on error with exception set.
  53