pandas.io.formats.style.Styler.to_string#

Styler.to_string(buf=None, *, encoding=None, sparse_index=None, sparse_columns=None, max_rows=None, max_columns=None, delimiter=' ')[源代码]#

将 Styler 以文本格式写入文件、缓冲区或字符串。

在 1.5.0 版本加入.

Parameters:
buf字符串, 路径对象, 文件类对象, 可选

字符串、路径对象(实现了 os.PathLike[str])或实现了字符串 write() 函数的文件类对象。如果为 None,则结果将作为字符串返回。

encodingbool, default False

文件输出(以及可用时的元标记)的字符编码设置。默认为 pandas.options.styler.render.encoding 值 “utf-8”。

sparse_indexbool, optional

是否稀疏显示分层索引。设置为 False 会为每一行中分层键的每个显式级别元素进行显示。默认为 pandas.options.styler.sparse.index 的值。

sparse_columnsbool, optional

是否稀疏显示分层索引。设置为 False 会为每一列中分层键的每个显式级别元素进行显示。默认为 pandas.options.styler.sparse.columns 的值。

max_rowsint, optional

将要呈现的最大行数。默认为 pandas.options.styler.render.max_rows,该值为 None。

max_columnsint, optional

将要渲染的列数上限。默认为 pandas.options.styler.render.max_columns,即 None。

如果总元素数量庞大,行数和列数可能会被减少。此值设置为 pandas.options.styler.render.max_elements,即 262144(18 位浏览器渲染)。

delimiterstr,默认为单个空格

数据元素之间的分隔符。

Returns:
str 或 None

如果 buf 为 None,则将结果作为字符串返回。否则返回 None

Examples

>>> df = pd.DataFrame({'A': [1, 2], 'B': [3, 4]})
>>> df.style.to_string()
' A B\n0 1 3\n1 2 4\n'