pyspark.pandas.Series.str.index

str.index(sub, start=0, end=None)

Return lowest indexes in each string 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

substr

Substring being searched.

startint

Left edge index.

endint

Right edge index.

Returns

Series of int

Series of lowest matching indexes.

Examples

>>> s = ps.Series(['apple', 'oranges', 'bananas'])

>>> s.str.index('a')
0    0
1    2
2    1
dtype: int64

The following expression throws an exception:

>>> s.str.index('a', start=2)