xarray.core.accessor_str.StringAccessor.index#
- StringAccessor.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 ofstr
) – Substring being searched. If array-like, it is broadcast.start (
int
or array-like ofint
) – Left edge index. If array-like, it is broadcast.end (
int
or array-like ofint
) – Right edge index. If array-like, it is broadcast.side (
{"left", "right"}
, default:"left"
) – Starting side for search.
- Returns
- Raises
ValueError – substring is not found