Slice Objects¶

PyTypeObjectPySlice_Type¶

Part of theStable ABI.

The type object for slice objects. This is the same asslice in thePython layer.

intPySlice_Check(PyObject*ob)¶

Return true ifob is a slice object;ob must not beNULL. Thisfunction always succeeds.

PyObject*PySlice_New(PyObject*start,PyObject*stop,PyObject*step)¶

Return value: New reference. Part of theStable ABI.

Return a new slice object with the given values. Thestart,stop, andstep parameters are used as the values of the slice object attributes ofthe same names. Any of the values may beNULL, in which case theNone will be used for the corresponding attribute.

ReturnNULL with an exception set ifthe new object could not be allocated.

intPySlice_GetIndices(PyObject*slice,Py_ssize_tlength,Py_ssize_t*start,Py_ssize_t*stop,Py_ssize_t*step)¶

Part of theStable ABI.

Retrieve the start, stop and step indices from the slice objectslice,assuming a sequence of lengthlength. Treats indices greater thanlength as errors.

Returns0 on success and-1 on error with no exception set (unless one ofthe indices was notNone and failed to be converted to an integer,in which case-1 is returned with an exception set).

You probably do not want to use this function.

Changed in version 3.2:The parameter type for theslice parameter wasPySliceObject*before.

intPySlice_GetIndicesEx(PyObject*slice,Py_ssize_tlength,Py_ssize_t*start,Py_ssize_t*stop,Py_ssize_t*step,Py_ssize_t*slicelength)¶

Part of theStable ABI.

Usable replacement forPySlice_GetIndices(). Retrieve the start,stop, and step indices from the slice objectslice assuming a sequence oflengthlength, and store the length of the slice inslicelength. Outof bounds indices are clipped in a manner consistent with the handling ofnormal slices.

Return0 on success and-1 on error with an exception set.

Note

This function is considered not safe for resizable sequences.Its invocation should be replaced by a combination ofPySlice_Unpack() andPySlice_AdjustIndices() where

if(PySlice_GetIndicesEx(slice,length,&start,&stop,&step,&slicelength)<0){// return error}

is replaced by

if(PySlice_Unpack(slice,&start,&stop,&step)<0){// return error}slicelength=PySlice_AdjustIndices(length,&start,&stop,step);

Changed in version 3.2:The parameter type for theslice parameter wasPySliceObject*before.

Changed in version 3.6.1:IfPy_LIMITED_API is not set or set to the value between0x03050400and0x03060000 (not including) or0x03060100 or higherPySlice_GetIndicesEx() is implemented as a macro usingPySlice_Unpack() andPySlice_AdjustIndices().Argumentsstart,stop andstep are evaluated more than once.

Deprecated since version 3.6.1:IfPy_LIMITED_API is set to the value less than0x03050400 orbetween0x03060000 and0x03060100 (not including)PySlice_GetIndicesEx() is a deprecated function.

intPySlice_Unpack(PyObject*slice,Py_ssize_t*start,Py_ssize_t*stop,Py_ssize_t*step)¶

Part of theStable ABI since version 3.7.

Extract the start, stop and step data members from a slice object asC integers. Silently reduce values larger thanPY_SSIZE_T_MAX toPY_SSIZE_T_MAX, silently boost the start and stop values less thanPY_SSIZE_T_MIN toPY_SSIZE_T_MIN, and silently boost the stepvalues less than-PY_SSIZE_T_MAX to-PY_SSIZE_T_MAX.

Return-1 with an exception set on error,0 on success.

Added in version 3.6.1.

Py_ssize_tPySlice_AdjustIndices(Py_ssize_tlength,Py_ssize_t*start,Py_ssize_t*stop,Py_ssize_tstep)¶

Part of theStable ABI 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 handlingof normal slices.

Return the length of the slice. Always successful. Doesn’t call Pythoncode.

Added in version 3.6.1.