本文为 Python 60 Days Challenge 课程学习整理,原作者与原 Notebook 链接见「课程资料」。代码按章节顺序运行;语法示意和故意报错的反例已单独标注。
打卡任务
- 阅读本节讲义或 Notebook
- 跑通示例代码
- 整理 3 个关键点
- 完成当日打卡输出
课程资料
- 训练营讲义:https://docs.qq.com/doc/DTFhndExSRGNHS3B6?nlc=1
- GitHub 仓库:https://github.com/cheer932041235/Python60DaysChallenge
- 本日 Notebook:Day7 复习日+查看函数参数.ipynb
学习内容
函数参数的查看方法
本教程介绍在 VSCode 中查看 Python 函数参数的多种方法。
1. 鼠标悬停查看(Hover)
1.1 操作步骤
将鼠标移动到函数名上(如
fillna)等待约 0.5 秒,会自动弹出提示框
提示框会显示:
- 函数签名(包含所有参数)
- 参数类型提示
- 简短的功能说明
- 参数默认值
1.2 示例演示
import pandas as pd
# 示例数据
data = pd.DataFrame({'A': [1, None, 3], 'B': [4, 5, None]})
# 将鼠标悬停在 fillna 上,会看到完整的参数列表
data.fillna(value=0)
2. 参数提示(Parameter Hints)
2.1 触发方式
- 输入函数名和左括号
(后自动显示
2.2 特点
- 会高亮当前正在输入的参数
- 显示参数类型和默认值
- 可以看到参数的顺序
以下是语法示意或故意报错的反例,不是需要整段运行的正常程序。
# 当你输入左括号时,会自动显示参数提示
data.fillna()
3. 查看完整文档
3.1 使用 help() 函数
# 使用 help() 函数查看完整文档
help(data.fillna)
# 输出包含:
# - 函数签名
# - 参数说明(Parameters)
# - 返回值说明(Returns)
# - 使用示例(Examples)
3.2 使用 Jupyter 魔法命令
help(data.fillna) # 普通 Python 与 Notebook 均可使用;Notebook 也支持 ?data.fillna
3.3 help() 与 ? 的区别
虽然两者都用于查看文档,但它们的输出格式和内容有所不同:
help() 函数
- 来源: Python 内置函数
- 格式: 纯文本格式,在终端中显示
- 内容: 读取对象的
__doc__属性(docstring) - 显示: 使用分页器显示(如
less),可以上下滚动 - 退出: 按
q退出查看 - 适用: 任何 Python 环境(包括普通 Python 解释器)
? 魔法命令
来源: IPython/Jupyter 特有功能
格式: 带格式的文本,可能包含颜色高亮
内容: 除了 docstring,还包括:
- 对象类型信息
- 定义所在文件
- 源代码位置
- 更丰富的格式化
显示: 在 Jupyter 中以弹出窗口或下方面板显示
适用: 仅在 IPython/Jupyter 环境中可用
方法总结对比
| 方法 | 快捷键 | 优点 | 适用场景 |
|---|---|---|---|
| 鼠标悬停 | 无 | 自动、快速 | 快速查看参数列表 |
| 强制悬停 | Ctrl+K Ctrl+I | 主动触发 | 悬停不显示时 |
| 参数提示 | Ctrl+Shift+Space | 高亮当前参数 | 输入参数时 |
| help() | 无 | 最详细、兼容性好 | 需要完整文档时 |
| ? | 无 | Jupyter 友好、格式美观 | Jupyter 环境中 |
| ?? | 无 | 可查看源码 | 深入理解实现 |
| 跳转定义 | F12 | 直接查看源码 | 深入理解实现 |
原创
Day7 复习日+查看函数参数
本文采用 CC BY-NC-SA 4.0 许可协议,转载请注明出处。
评论交流
欢迎留下你的想法