HOWTO · Pandas

使用 Python 将 Pandas DataFrame 保存为 HTML

本教程演示如何将 Pandas DataFrame 转换为 Python 中的 HTML 表格。

本页内容

pandas 的 DataFrame 可以直接转换为 HTML 表格,因此无需手动逐个构建单元格。to_html() 可以将标记作为字符串返回,也可以写入指定位置。下面的示例会创建一个小表格并将其保存到临时文件中,因此无需输入 CSV 文件或预先创建目录即可运行。

使用 to_html() 将 DataFrame 保存为 HTML 文件

运行以下示例:

本节中的代码以及显示的标签或输出仍为英文。

from pathlib import Path
from tempfile import TemporaryDirectory

import pandas as pd

df = pd.DataFrame(
    {
        "ST_Name": ["Jhon", "Alia", "Sam", "Smith"],
        "Department": ["CS", "EE", "EE", "CS"],
        "Marks": [60, 80, 90, 88],
    }
)

with TemporaryDirectory() as folder:
    html_path = Path(folder) / "students.html"
    df.to_html(html_path)
    print(f"HTML file created: {html_path.is_file()}")

将目标位置传给 to_html(),即可把表格写入该位置。该方法默认会包含 DataFrame 的索引;如果不希望 HTML 表格中显示行号,可以传入 index=False。如果索引包含读者需要查看的有意义标识符,则应保留它。

选择输出路径并检查生成的 HTML

相对文件名(例如 students.html)会相对于 Python 当前工作目录解析。若要选择其他位置,可以传入类似 reports/students.html 的路径;该目录必须已经存在。绝对路径则会指定一个固定位置,不受当前目录影响。示例中,TemporaryDirectory 提供一个已存在的目录,Path 则以跨平台的方式构建目标路径。

要检查结果,可以在浏览器中打开保存的文件,或将它作为文本读取。pandas 会生成一个 <table>,其中列标题位于 <thead>,数据行位于 <tbody>。使用默认索引设置时,每一行的索引也会显示在表格中。生成的标记包含表格数据,但不是带有外层 <html> 文档的完整网页。如果只需要内存中的标记,可以在不指定目标位置的情况下调用 df.to_html();它会返回 HTML 字符串,而不会写入文件。之后可以将该字符串传给程序的其他部分,或使用自己的文件处理代码写入文件。

手动构建 HTML 表格

当你需要精确控制哪些值成为单元格,或需要将表格与其他生成的标记组合时,手动构建会很有用。对于常见的 DataFrame 导出,to_html() 更简洁,并会替你处理表格结构。自行拼接标记时,应转义每个标题和单元格的值,使 <、> 和 & 等字符作为文本保留,而不会被当作 HTML 解析。示例将表头和表格主体分开,并把结果写入临时文件:

本节中的代码以及显示的标签或输出仍为英文。

from html import escape
from pathlib import Path
from tempfile import TemporaryDirectory

import pandas as pd

df = pd.DataFrame(
    {
        "ST_Name": ["Jhon", "Alia", "Sam", "Smith"],
        "Department": ["CS", "EE", "EE", "CS"],
        "Marks": [60, 80, 90, 88],
    }
)

headings = "".join(f"<th>{escape(str(column))}</th>" for column in df.columns)
rows = []
for row in df.itertuples(index=False, name=None):
    cells = "".join(f"<td>{escape(str(value))}</td>" for value in row)
    rows.append(f"<tr>{cells}</tr>")

markup = f"<table><thead><tr>{headings}</tr></thead><tbody>{''.join(rows)}</tbody></table>"
with TemporaryDirectory() as folder:
    html_path = Path(folder) / "students.html"
    html_path.write_text(markup, encoding="utf-8")
    print(f"HTML file created: {html_path.is_file()}")

这个手动版本有意省略了 DataFrame 索引,与表头中明确列出的数据列相对应。如果读者需要索引列,可以自行添加。两种方法都会生成可作为文本检查的 HTML 源码;保存的文件是表格标记,并非 DataFrame 的截图。