ak.str.split_pattern_regex
--------------------------

.. py:module: ak.str.split_pattern_regex

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

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


    :param array: Array-like data (anything :py:obj:`ak.to_layout` recognizes).
    :param pattern: Regular expression of characters/bytes to
                split on.
    :type pattern: str or bytes
    :param max_splits: Maximum number of splits for each input
                   value. If None, unlimited.
    :type max_splits: None or int
    :param reverse: 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.
    :type reverse: bool
    :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

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 <https://arrow.apache.org/docs/python/generated/pyarrow.compute.split_pattern.html>`__.

See also: :py:obj:`ak.str.split_whitespace`, :py:obj:`ak.str.split_pattern`.