ak.str.split_pattern_regex#

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

ak.str.split_pattern_regex(array, pattern, *, max_splits=None, reverse=False, highlevel=True, behavior=None, attrs=None)#
Parameters:

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

  • pattern (str or bytes) – Regular expression of characters/bytes to split on.

  • max_splits (None or int) – Maximum number of splits for each input value. If None, unlimited.

  • reverse (bool) – If True, start splitting from the end of each input value; otherwise, start splitting from the beginning of each value. This flag only has an effect if max_splits is not None.

  • 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.

Splits any string or bytestring-valued data into a list of substrings according to the given regular expression.

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.split_pattern.

See also: ak.str.split_whitespace, ak.str.split_pattern.