ak.str.match_substring#

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

ak.str.match_substring(array, pattern, *, ignore_case=False, highlevel=True, behavior=None, attrs=None)#
Parameters:

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

  • pattern (str or bytes) – Substring pattern to look for inside 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-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.

For each string in the array, determine whether it contains the given literal pattern.

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

See also: ak.str.match_substring_regex.