pyspark.pandas.Series.str.wrap

str.wrap(width, **kwargs)

Wrap long strings in the Series to be formatted in paragraphs with length less than a given width.

This method has the same keyword parameters and defaults as textwrap.TextWrapper.

Parameters

widthint

Maximum line-width. Lines separated with newline char.

expand_tabsbool, optional

If true, tab characters will be expanded to spaces (default: True).

replace_whitespacebool, optional

If true, each whitespace character remaining after tab expansion will be replaced by a single space (default: True).

drop_whitespacebool, optional

If true, whitespace that, after wrapping, happens to end up at the beginning or end of a line is dropped (default: True).

break_long_wordsbool, optional

If true, then words longer than width will be broken to ensure that no lines are longer than width. If it is false, long words will not be broken, and some lines may be longer than width (default: True).

break_on_hyphensbool, optional

If true, wrapping will occur preferably on whitespace and right after hyphens in compound words, as it is customary in English. If false, only whitespaces will be considered as potentially good places for line breaks, but you need to set break_long_words to false if you want truly insecable words (default: True).

Returns

Series of object

Series with wrapped strings.

Examples

>>> s = ps.Series(['line to be wrapped', 'another line to be wrapped'])
>>> s.str.wrap(12)
0             line to be\nwrapped
1    another line\nto be\nwrapped
dtype: object