You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何为Pandas DataFrame列添加docstring实现Jupyter鼠标悬停显示?

为Pandas列添加描述并在Jupyter Notebook悬停显示

可以实现,下面是两种实用方法:

方法1:使用Styler的set_tooltips

这是最直接的方式,适合在Jupyter中快速展示列描述:

  1. 定义字典映射列名到对应描述文本
  2. 调用df.style.set_tooltips()传入字典,悬停列标题即可显示说明

示例代码:

import pandas as pd

# 创建示例DataFrame
df = pd.DataFrame({
    'user_id': [1, 2, 3],
    'username': ['alice', 'bob', 'charlie'],
    'signup_date': ['2023-01-01', '2023-02-15', '2023-03-20']
})

# 定义列描述字典
col_descriptions = {
    'user_id': '用户唯一标识ID',
    'username': '用户登录用户名',
    'signup_date': '用户注册日期(YYYY-MM-DD格式)'
}

# 应用tooltips,悬停列标题查看说明
df.style.set_tooltips(col_descriptions)

运行后在Jupyter Notebook中,鼠标悬停列标题就能看到对应的描述文本。

方法2:为DataFrame添加元数据存储列描述

如果需要长期存储列描述信息,可以把描述存入DataFrame的attrs属性,后续可随时调用,也能结合自定义逻辑实现悬停显示:

# 存储列描述到DataFrame的attrs
df.attrs['column_descriptions'] = col_descriptions

# 查看存储的描述
print(df.attrs['column_descriptions']['user_id'])
# 输出:用户唯一标识ID

若要在Jupyter中让悬停显示该元数据,可结合IPython自定义显示钩子,适合有定制需求的场景。

注:原生Pandas列对象本身没有独立的docstring属性,但通过上述方式可实现类似效果,满足Jupyter中悬停查看列说明的需求。

内容的提问来源于stack exchange,提问作者Kerrick Staley

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.10 03:07:38