ak.str.starts_with#
Defined in awkward.operations.str.akstr_starts_with on line 13.
- ak.str.starts_with(array, pattern, *, ignore_case=False, highlevel=True, behavior=None, attrs=None)#
- Parameters:
array – Array-like data (anything
ak.to_layoutrecognizes).pattern (str or bytes) – Substring pattern to test against the start of each string in
array.ignore_case (bool) – If True, perform a case-insensitive match; otherwise, the match is case-sensitive.
highlevel (bool) – If True, return an
ak.Array; otherwise, return a low-levelak.contents.Contentsubclass.behavior (None or dict) – Custom
ak.behaviorfor the output array, if high-level.attrs (None or dict) – Custom attributes for the output array, if high-level.
Returns True for every string in array if it starts with the given literal
suffix pattern. Depending upon the value of ignore_case, the matching
function will be case-insensitive.
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.starts_with.