string_chunks

grizli.utils.string_chunks(text, length=70, join='\n')[source]

Break a (long) string into chunks

Parameters
textstr

Text string

lengthint

chunk length

joinstr, None

Optional character to join split chunks and return string

Returns
splitstr, list

Result of text broken into chunks, list of chunks or string joined on join

Examples

>>> from grizli import utils
>>> full_string = '-' * 20
>>> print(utils.string_chunks(full_string, length=8, join=None))
['--------', '--------', '----']
>>> print(utils.string_chunks(full_string, length=8, join="x"))
--------x--------x----
>>> print(utils.string_chunks(full_string, length=8)) # default newline
--------
--------
----