pandas df.to_html() 转换为 HTML 表格格式 pandas 教程

pandas df.to_html() 转换为 HTML 表格格式

看过来

《pandas 教程》 持续更新中，提供建议、纠错、催更等加作者微信: gr99123（备注：pandas教程）和关注公众号「盖若」ID: gairuo。跟作者学习，请进入 Python学习课程。欢迎关注作者出版的书籍：《深入浅出Pandas》 和 《Python之光》。

Python培训

本内容来自：https://gairuo.com

pandas.DataFrame.to_html() 是 Pandas 库中用于将 DataFrame 对象转换为 HTML 表格格式的方法。该方法可以将数据以 HTML 表格的形式导出，便于在网页中展示、报告中嵌入或与其他 Web 应用程序集成。

语法

函数签名

DataFrame.to_html(
    buf=None, 
    *, 
    columns=None, 
    col_space=None, 
    header=True, 
    index=True, 
    na_rep='NaN', 
    formatters=None, 
    float_format=None, 
    sparsify=None, 
    index_names=True, 
    justify=None, 
    max_rows=None, 
    max_cols=None, 
    show_dimensions=False, 
    decimal='.', 
    bold_rows=True, 
    classes=None, 
    escape=True, 
    notebook=False, 
    border=None, 
    table_id=None, 
    render_links=False, 
    encoding=None
)

参数详解

以下是 DataFrame.to_html 方法的各个参数及其意义：

  1. buf

    • 类型: str、pathlib.Path、file-like object、None
    • 默认值: None
    • 意义: 指定输出的目标位置。如果为 None，则返回生成的 HTML 字符串；如果指定为文件路径或文件对象，则将 HTML 写入该位置。

  2. columns

    • 类型: list-like 或 None
    • 默认值: None
    • 意义: 指定要包含在输出中的列。如果为 None，则包含所有列。

  3. col_space

    • 类型: int 或 dict，可选
    • 默认值: None
    • 意义: 指定每一列的最小宽度。可以是单个整数应用于所有列，或为每列指定不同的宽度。

  4. header

    • 类型: bool 或 list-like，可选
    • 默认值: True
    • 意义: 是否包含列名作为表头。可以为 True（包含）、False（不包含）或指定特定的行作为表头。

  5. index

    • 类型: bool，可选
    • 默认值: True
    • 意义: 是否包含行索引。True 表示包含，False 表示不包含。

  6. na_rep

    • 类型: str
    • 默认值: 'NaN'
    • 意义: 指定缺失值（NaN）的表示方式。

  7. formatters

    • 类型: dict 或 list，可选
    • 默认值: None
    • 意义: 指定用于格式化各列的函数。例如，可以为特定列设置自定义的格式化函数。

  8. float_format

    • 类型: str 或 callable，可选
    • 默认值: None
    • 意义: 指定浮点数的格式。例如，'%.2f' 表示保留两位小数。

  9. sparsify

    • 类型: bool 或 None，可选
    • 默认值: None
    • 意义: 控制多级索引的显示方式。True 表示在重复的索引标签处显示空白，False 表示重复显示。

  10. index_names

    • 类型: bool，可选
    • 默认值: True
    • 意义: 是否在表格中包含索引名称。

  11. justify

    • 类型: {'left', 'right', 'center', 'justify', None}
    • 默认值: None
    • 意义: 指定文本的对齐方式。可以为 'left'、'right'、'center'、'justify' 或 None（自动选择）。

  12. max_rows

    • 类型: int 或 None，可选
    • 默认值: None
    • 意义: 指定显示的最大行数。超过该行数的数据将被截断。

  13. max_cols

    • 类型: int 或 None，可选
    • 默认值: None
    • 意义: 指定显示的最大列数。超过该列数的数据将被截断。

  14. show_dimensions

    • 类型: bool，可选
    • 默认值: False
    • 意义: 是否在表格下方显示 DataFrame 的维度信息（行数和列数）。

  15. decimal

    • 类型: str
    • 默认值: '.'
    • 意义: 指定小数点符号，用于浮点数格式化。

  16. bold_rows

    • 类型: bool
    • 默认值: True
    • 意义: 是否将索引行加粗显示。

  17. classes

    • 类型: str 或 list-like，可选
    • 默认值: None
    • 意义: 为生成的 HTML 表格添加 CSS 类。可以是单个字符串或字符串列表。

  18. escape

    • 类型: bool
    • 默认值: True
    • 意义: 是否对 HTML 特殊字符进行转义。如果设置为 False，则允许 HTML 标签直接渲染。

  19. notebook

    • 类型: bool
    • 默认值: False
    • 意义: 如果为 True，则生成适用于 Jupyter Notebook 的 HTML 表格。

  20. border

    • 类型: int 或 None，可选
    • 默认值: None
    • 意义: 指定表格的边框宽度。None 表示不添加边框。

  21. table_id

    • 类型: str，可选
    • 默认值: None
    • 意义: 为生成的 HTML 表格指定 id 属性。

  22. render_links

    • 类型: bool
    • 默认值: False
    • 意义: 是否将包含 URL 的字符串转换为 HTML 链接。如果为 True，则将符合 URL 格式的字符串转换为可点击的链接。

  23. encoding

    • 类型: str，可选
    • 默认值: None
    • 意义: 指定输出文件的编码格式，例如 'utf-8'。

返回值

使用场景

DataFrame.to_html() 常用于以下场景：

示例

示例 1：将 DataFrame 转换为 HTML 字符串

import pandas as pd

# 构造示例数据
data = {
    '姓名': ['艾丽丝', '鲍勃', '查理'],
    '年龄': [30, 25, 35],
    '城市': ['纽约', '洛杉矶', '芝加哥']
}
df = pd.DataFrame(data)

# 将 DataFrame 转换为 HTML 字符串
html_str = df.to_html()

print(html_str)

输出

<table border="1" class="dataframe">
  <thead>
    <tr style="text-align: right;">
      <th></th>
      <th>姓名</th>
      <th>年龄</th>
      <th>城市</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th>0</th>
      <td>艾丽丝</td>
      <td>30</td>
      <td>纽约</td>
    </tr>
    <tr>
      <th>1</th>
      <td>鲍勃</td>
      <td>25</td>
      <td>洛杉矶</td>
    </tr>
    <tr>
      <th>2</th>
      <td>查理</td>
      <td>35</td>
      <td>芝加哥</td>
    </tr>
  </tbody>
</table>

示例 2：将 DataFrame 写入 HTML 文件

import pandas as pd

# 构造示例数据
data = {
    '姓名': ['艾丽丝', '鲍勃', '查理'],
    '年龄': [30, 25, 35],
    '城市': ['纽约', '洛杉矶', '芝加哥']
}
df = pd.DataFrame(data)

# 将 DataFrame 写入 HTML 文件
df.to_html('data.html', index=False, classes='table table-striped', border=0)

# 读取并打印 HTML 文件内容
with open('data.html', 'r', encoding='utf-8') as file:
    content = file.read()
    print(content)

输出

<table class="table table-striped" border="0">
  <thead>
    <tr style="text-align: right;">
      <th>姓名</th>
      <th>年龄</th>
      <th>城市</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>艾丽丝</td>
      <td>30</td>
      <td>纽约</td>
    </tr>
    <tr>
      <td>鲍勃</td>
      <td>25</td>
      <td>洛杉矶</td>
    </tr>
    <tr>
      <td>查理</td>
      <td>35</td>
      <td>芝加哥</td>
    </tr>
  </tbody>
</table>

示例 3：指定列和不包含索引

import pandas as pd

# 构造示例数据
data = {
    '姓名': ['艾丽丝', '鲍勃', '查理'],
    '年龄': [30, 25, 35],
    '城市': ['纽约', '洛杉矶', '芝加哥'],
    '职业': ['工程师', '设计师', '医生']
}
df = pd.DataFrame(data)

# 将指定列转换为 HTML，并不包含索引
html_str = df.to_html(columns=['姓名', '城市'], index=False)

print(html_str)

输出

<table border="1" class="dataframe">
  <thead>
    <tr style="text-align: right;">
      <th>姓名</th>
      <th>城市</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>艾丽丝</td>
      <td>纽约</td>
    </tr>
    <tr>
      <td>鲍勃</td>
      <td>洛杉矶</td>
    </tr>
    <tr>
      <td>查理</td>
      <td>芝加哥</td>
    </tr>
  </tbody>
</table>

示例 4：使用格式化函数和浮点数格式

import pandas as pd

# 构造示例数据
data = {
    '姓名': ['艾丽丝', '鲍勃', '查理'],
    '成绩': [95.123456, 88.987654, 92.456789]
}
df = pd.DataFrame(data)

# 定义格式化函数
formatters = {
    '成绩': lambda x: f"{x:.2f}"
}

# 将 DataFrame 转换为 HTML，应用格式化函数
html_str = df.to_html(formatters=formatters, float_format="%.2f")

print(html_str)

输出

<table border="1" class="dataframe">
  <thead>
    <tr style="text-align: right;">
      <th></th>
      <th>姓名</th>
      <th>成绩</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th>0</th>
      <td>艾丽丝</td>
      <td>95.12</td>
    </tr>
    <tr>
      <th>1</th>
      <td>鲍勃</td>
      <td>88.99</td>
    </tr>
    <tr>
      <th>2</th>
      <td>查理</td>
      <td>92.46</td>
    </tr>
  </tbody>
</table>

示例 5：不强制 ASCII 并使用缩进美化 HTML

import pandas as pd

# 构造包含非 ASCII 字符的示例数据
data = {
    '姓名': ['艾丽丝', '鲍勃', '查理'],
    '年龄': [30, 25, 35],
    '城市': ['纽约', '洛杉矶', '芝加哥']
}
df = pd.DataFrame(data)

# 将 DataFrame 转换为 HTML 字符串，不强制 ASCII 并使用缩进
html_str = df.to_html(force_ascii=False, indent=2)

print(html_str)

输出

<table border="1" class="dataframe">
  <thead>
    <tr style="text-align: right;">
      <th></th>
      <th>姓名</th>
      <th>年龄</th>
      <th>城市</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th>0</th>
      <td>艾丽丝</td>
      <td>30</td>
      <td>纽约</td>
    </tr>
    <tr>
      <th>1</th>
      <td>鲍勃</td>
      <td>25</td>
      <td>洛杉矶</td>
    </tr>
    <tr>
      <th>2</th>
      <td>查理</td>
      <td>35</td>
      <td>芝加哥</td>
    </tr>
  </tbody>
</table>

示例 6：生成带有 CSS 类和表格 ID 的 HTML

import pandas as pd

# 构造示例数据
data = {
    '姓名': ['艾丽丝', '鲍勃', '查理'],
    '年龄': [30, 25, 35],
    '城市': ['纽约', '洛杉矶', '芝加哥']
}
df = pd.DataFrame(data)

# 将 DataFrame 转换为 HTML，添加 CSS 类和表格 ID
html_str = df.to_html(classes='table table-bordered', table_id='my_table')

print(html_str)

输出

<table border="1" class="dataframe table table-bordered" id="my_table">
  <thead>
    <tr style="text-align: right;">
      <th></th>
      <th>姓名</th>
      <th>年龄</th>
      <th>城市</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th>0</th>
      <td>艾丽丝</td>
      <td>30</td>
      <td>纽约</td>
    </tr>
    <tr>
      <th>1</th>
      <td>鲍勃</td>
      <td>25</td>
      <td>洛杉矶</td>
    </tr>
    <tr>
      <th>2</th>
      <td>查理</td>
      <td>35</td>
      <td>芝加哥</td>
    </tr>
  </tbody>
</table>

示例 7：生成包含链接的 HTML 表格

import pandas as pd

# 构造示例数据
data = {
    '姓名': ['艾丽丝', '鲍勃', '查理'],
    '个人主页': [
        '<a href="https://example.com/alice">Alice\'s Page</a>',
        '<a href="https://example.com/bob">Bob\'s Page</a>',
        '<a href="https://example.com/charlie">Charlie\'s Page</a>'
    ]
}
df = pd.DataFrame(data)

# 将 DataFrame 转换为 HTML，渲染链接
html_str = df.to_html(escape=False, render_links=True)

print(html_str)

输出

<table border="1" class="dataframe">
  <thead>
    <tr style="text-align: right;">
      <th></th>
      <th>姓名</th>
      <th>个人主页</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th>0</th>
      <td>艾丽丝</td>
      <td><a href="https://example.com/alice">Alice's Page</a></td>
    </tr>
    <tr>
      <th>1</th>
      <td>鲍勃</td>
      <td><a href="https://example.com/bob">Bob's Page</a></td>
    </tr>
    <tr>
      <th>2</th>
      <td>查理</td>
      <td><a href="https://example.com/charlie">Charlie's Page</a></td>
    </tr>
  </tbody>
</table>

总结

DataFrame.to_html() 是一个强大的方法，用于将 Pandas 的 DataFrame 对象导出为 HTML 表格格式。通过灵活配置参数，可以控制输出的 HTML 表格的样式、内容和结构，满足不同的展示和集成需求。无论是用于网页展示、报告生成还是数据集成，掌握 to_html() 的使用方法都能显著提升数据的可视化和共享效率。

参考

< to_json() 转换为 JSON 格式字符串 pandas 文件或数据的读取和导出 to_sql() 写入到关系型数据库 >

更新时间：2024-10-10 09:13:59 标签：pandas python html

无「盖若」授权，请勿以任何形式转载，公众号：gairuo
Copyright © 2019 - 2026
Gairuo.com All Rights Reserved v9.1.250909

备案 京公网安备11010502033395号 京ICP备15019454号-4