xorbits.pandas.Series.str.index#

Series.str.index(sub, start: int = 0, end=None)#

Return lowest indexes in each string in Series/Index.

Each of the returned indexes corresponds to the position 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. Equivalent to standard str.index.

Parameters

  • sub (str) – Substring being searched.

  • start (int) – Left edge index.

  • end (int) – Right edge index.

Return type

Series or Index of object

See also

rindex

Return highest indexes in each strings.

Examples

For Series.str.index:

>>> ser = pd.Series(["horse", "eagle", "donkey"])  
>>> ser.str.index("e")  
0   4
1   0
2   4
dtype: int64

For Series.str.rindex:

>>> ser = pd.Series(["Deer", "eagle", "Sheep"])  
>>> ser.str.rindex("e")  
0   2
1   4
2   3
dtype: int64

This docstring was copied from pandas.core.strings.accessor.StringMethods.