ak.str.replace_substring#

ak.str.replace_substring(array, pattern, replacement, *, max_replacements=None, highlevel=True, behavior=None, attrs=None)#

Parameters:

array – Array-like data (anything ak.to_layout recognizes).
pattern (str) – Substring pattern to look for inside input values.
replacement (str or bytes) – What to replace the pattern with.
max_replacements (None or int) – If not None and not -1, limits the maximum number of replacements per string/bytestring, counting from the left.
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 non-overlapping subsequences of any string or bytestring-valued data that match a literal pattern with replacement.

The pattern 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.replace_substring or pyarrow.compute.replace_substring on strings and bytestrings, respectively.