ak.str.slice#

Defined in awkward.operations.str.akstr_slice on line 13.

ak.str.slice(array, start, stop=None, step=1, *, highlevel=True, behavior=None, attrs=None)#
Parameters:

  • array – Array-like data (anything ak.to_layout recognizes).

  • start (int) – Index to start slicing at (inclusive).

  • stop (None or int) – Index to stop slicing at (exclusive). If not given, slicing will stop at the end.

  • step (int) – Slice step.

  • highlevel (bool) – If True, return an ak.Array; otherwise, return a low-level ak.contents.Content subclass.

  • behavior (None or dict) – Custom ak.behavior for the output array, if high-level.

  • attrs (None or dict) – Custom attributes for the output array, if high-level.

Replaces any string or bytestring-valued data with a slice between start and stop indexes; start is inclusive and stop is exclusive and both are 0-indexed.

For strings, start and stop are measured in Unicode characters; for bytestrings, start and stop are measured in bytes.

The start, stop, and replacement are scalars; they cannot be different for each string/bytestring in the sample.

Note: this function does not raise an error if the array does not contain any string or bytestring data.

Requires the pyarrow library and calls pyarrow.compute.utf8_slice_codeunits or performs a literal slice on strings and bytestrings, respectively.