xorbits.pandas.Series.str.pad#
- Series.str.pad(width: int, side: Literal['left', 'right', 'both'] = 'left', fillchar: str = ' ')#
Pad strings in the Series/Index up to width.
- Parameters
width (int) – Minimum width of resulting string; additional characters will be filled with character defined in fillchar.
side ({'left', 'right', 'both'}, default 'left') – Side from which to fill resulting string.
fillchar (str, default ' ') – Additional character for filling, default is whitespace.
- Returns
Returns Series or Index with minimum number of char in object.
- Return type
Series or Index of object
See also
Series.str.rjust
Fills the left side of strings with an arbitrary character. Equivalent to
Series.str.pad(side='left')
.Series.str.ljust
Fills the right side of strings with an arbitrary character. Equivalent to
Series.str.pad(side='right')
.Series.str.center
Fills both sides of strings with an arbitrary character. Equivalent to
Series.str.pad(side='both')
.Series.str.zfill
Pad strings in the Series/Index by prepending ‘0’ character. Equivalent to
Series.str.pad(side='left', fillchar='0')
.
Examples
>>> s = pd.Series(["caribou", "tiger"]) >>> s 0 caribou 1 tiger dtype: object
>>> s.str.pad(width=10) 0 caribou 1 tiger dtype: object
>>> s.str.pad(width=10, side='right', fillchar='-') 0 caribou--- 1 tiger----- dtype: object
>>> s.str.pad(width=10, side='both', fillchar='-') 0 -caribou-- 1 --tiger--- dtype: object
This docstring was copied from pandas.core.strings.accessor.StringMethods.