ak.str.replace_substring_regex
------------------------------

.. py:module: ak.str.replace_substring_regex

Defined in `awkward.operations.str.akstr_replace_substring_regex <https://github.com/scikit-hep/awkward/blob/36da52cfa8846355c390beb6555eac1d31c27c26/src/awkward/operations/str/akstr_replace_substring_regex.py>`__ on `line 13 <https://github.com/scikit-hep/awkward/blob/36da52cfa8846355c390beb6555eac1d31c27c26/src/awkward/operations/str/akstr_replace_substring_regex.py#L13>`__.

.. py:function:: ak.str.replace_substring_regex(array, pattern, replacement, *, max_replacements=None, highlevel=True, behavior=None, attrs=None)


    :param array: Array-like data (anything :py:obj:`ak.to_layout` recognizes).
    :param pattern: Regular expression pattern to look for inside input values.
    :type pattern: str
    :param replacement: What to replace the pattern with.
    :type replacement: str or bytes
    :param max_replacements: If not None and not -1, limits the
                         maximum number of replacements per string/bytestring, counting from
                         the left.
    :type max_replacements: None or int
    :param highlevel: If True, return an :py:obj:`ak.Array`; otherwise, return
                  a low-level :py:obj:`ak.contents.Content` subclass.
    :type highlevel: bool
    :param behavior: Custom :py:obj:`ak.behavior` for the output array, if
                 high-level.
    :type behavior: None or dict
    :param attrs: Custom attributes for the output array, if
              high-level.
    :type attrs: None or dict

Replaces non-overlapping subsequences of any string or bytestring-valued
data that match a regular expression ``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_regex <https://arrow.apache.org/docs/python/generated/pyarrow.compute.replace_substring_regex.html>`__
or
`pyarrow.compute.replace_substring_regex <https://arrow.apache.org/docs/python/generated/pyarrow.compute.replace_substring_regex.html>`__
on strings and bytestrings, respectively.

See also: :py:obj:`ak.str.replace_substring_regex`.