pyspark.pandas.Series.str.rindex

str.rindex(sub: str, start: int = 0, end: Optional[int] = None) → pyspark.pandas.series.Series

Return highest indexes in each string where the substring is fully contained between [start:end].

This is the same as str.rfind() except instead of returning -1, it raises a ValueError when the substring is not found. Equivalent to standard str.rindex().

Parameters
substr

Substring being searched.

startint

Left edge index.

endint

Right edge index.

Returns
Series of int

Series of highest matching indexes.

Examples

>>> s = ps.Series(['apple', 'oranges', 'bananas'])
>>> s.str.rindex('a')
0    0
1    2
2    5
dtype: int64

The following expression throws an exception:

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