xarray.core.accessor_str.StringAccessor.match#

StringAccessor.match(pat, case=None, flags=0)[source]#

Determine if each string in the array matches a regular expression.

The pattern pat can either be a single str or re.Pattern or array-like of str or re.Pattern. If array-like, it is broadcast against the array and applied elementwise.

Parameters:
  • pat (str or re.Pattern or array-like of str or re.Pattern) โ€“ A string containing a regular expression or a compiled regular expression object. If array-like, it is broadcast.

  • case (bool, default: True) โ€“ If True, case sensitive. Cannot be set if pat is a compiled regex. Equivalent to setting the re.IGNORECASE flag.

  • flags (int, default: 0) โ€“ Flags to pass through to the re module, e.g. re.IGNORECASE. see compilation-flags. 0 means no flags. Flags can be combined with the bitwise or operator |. Cannot be set if pat is a compiled regex.

Returns:

matched (array of bool)