xarray.DataArray.str.index

xarray.DataArray.str.index#

DataArray.str.index(sub, start=0, end=None, side='left')[source]#

Return lowest or highest indexes in each strings where the substring is fully contained between [start:end]. This is the same as str.find except instead of returning -1, it raises a ValueError when the substring is not found.

If start, end, or ‘sub` is array-like, they are broadcast against the array and applied elementwise.

Parameters

  • sub (str or array-like of str) – Substring being searched. If array-like, it is broadcast.

  • start (int or array-like of int) – Left edge index. If array-like, it is broadcast.

  • end (int or array-like of int) – Right edge index. If array-like, it is broadcast.

  • side ({"left", "right"}, default: "left") – Starting side for search.

Returns

found (array of int)

Raises

ValueError – substring is not found

Contents