pandas.DataFrame.to_markdown

DataFrame.to_markdown(buf=None, *, mode='wt', index=True, storage_options=None, **kwargs)

以Markdown友好格式打印DataFrame。

参数:

bufstr, Path 或 StringIO-like, 可选, 默认 None

要写入的缓冲区。如果为 None，则输出将作为字符串返回。

模式str, 可选

文件打开的模式，默认为 “wt”。

索引bool, 可选, 默认 True

添加索引（行）标签。

storage_optionsdict, 可选

对于特定存储连接有意义的额外选项，例如主机、端口、用户名、密码等。对于HTTP(S) URL，键值对被转发到 urllib.request.Request 作为头部选项。对于其他URL（例如以“s3://”和“gcs://”开头），键值对被转发到 fsspec.open。请参阅 fsspec 和 urllib 了解更多详情，关于存储选项的更多示例请参考 这里。

**kwargs

这些参数将被传递给 tabulate.

返回:

str

Markdown友好格式的DataFrame。

参见

DataFrame.to_html

将 DataFrame 渲染为 HTML 格式的表格。

DataFrame.to_latex

渲染 DataFrame 为 LaTeX 格式的表格。

备注

需要 tabulate 包。

例子

>>> df = pd.DataFrame(
...     data={"animal_1": ["elk", "pig"], "animal_2": ["dog", "quetzal"]}
... )
>>> print(df.to_markdown())
|    | animal_1   | animal_2   |
|---:|:-----------|:-----------|
|  0 | elk        | dog        |
|  1 | pig        | quetzal    |

使用 tabulate 选项输出 markdown。

>>> print(df.to_markdown(tablefmt="grid"))
+----+------------+------------+
|    | animal_1   | animal_2   |
+====+============+============+
|  0 | elk        | dog        |
+----+------------+------------+
|  1 | pig        | quetzal    |
+----+------------+------------+