xorbits.pandas.Series.str.startswith#
- Series.str.startswith(pat: str | tuple[str, ...], na: Scalar | None = None) Series | Index #
Test if the start of each string element matches a pattern.
Equivalent to
str.startswith()
.- Parameters
pat (str or tuple[str, ...]) – Character sequence or tuple of strings. Regular expressions are not accepted.
na (object, default NaN) – Object shown if element tested is not a string. The default depends on dtype of the array. For object-dtype,
numpy.nan
is used. ForStringDtype
,pandas.NA
is used.
- Returns
A Series of booleans indicating whether the given pattern matches the start of each string element.
- Return type
Series or Index of bool
See also
str.startswith
Python standard library string method.
Series.str.endswith
Same as startswith, but tests the end of string.
Series.str.contains
Tests if string element contains a pattern.
Examples
>>> s = pd.Series(['bat', 'Bear', 'cat', np.nan]) >>> s 0 bat 1 Bear 2 cat 3 NaN dtype: object
>>> s.str.startswith('b') 0 True 1 False 2 False 3 NaN dtype: object
>>> s.str.startswith(('b', 'B')) 0 True 1 True 2 False 3 NaN dtype: object
Specifying na to be False instead of NaN.
>>> s.str.startswith('b', na=False) 0 True 1 False 2 False 3 False dtype: bool
This docstring was copied from pandas.core.strings.accessor.StringMethods.