pyspark.pandas.Series.str.startswith

str.startswith(pattern, na=None)

Test if the start of each string element matches a pattern.

Equivalent to str.startswith().

Parameters

patternstr

Character sequence. Regular expressions are not accepted.

naobject, default None

Object shown if element is not a string. NaN converted to None.

Returns

Series of bool or object

pandas-on-Spark Series of booleans indicating whether the given pattern matches the start of each string element.

Examples

>>> s = ps.Series(['bat', 'Bear', 'cat', np.nan])
>>> s
0     bat
1    Bear
2     cat
3    None
dtype: object

>>> s.str.startswith('b')
0     True
1    False
2    False
3     None
dtype: object

Specifying na to be False instead of None.

>>> s.str.startswith('b', na=False)
0     True
1    False
2    False
3    False
dtype: bool