Python案例如何查官方文档

本文目录导读：

1. 最常用：内置 help() 函数
2. 在线官方文档（推荐）
3. 使用 dir() 探索模块
4. 查看源代码
5. IDE内置文档（最实用）
6. 命令行快速查询
7. 实际案例：查 json.dumps() 用法
8. 高效搜索技巧
9. 快速定位到特定模块
10. 推荐流程

在Python开发中，查询官方文档是非常关键的技能,下面我整理几种主要的方法和场景：

最常用：内置 help() 函数

这是最快的方式,直接在终端或代码中使用：

# 查看模块
import json
help(json)
# 查看函数
help(print)
# 查看类
help(list)
# 查看字符串方法
help(str)

输出示例（部分）：

Help on class list in module builtins:
class list(object)
 |  list(iterable=(), /)
 |  
 |  Built-in mutable sequence.

在线官方文档（推荐）

类型	链接	适用场景
Python 标准库	docs.python.org/zh-cn/3/	内置模块、语法
第三方库	pypi.org/project/包名/	pip安装的包
特定库文档	库名.readthedocs.io	大型库（如NumPy）

示例：

• 查 datetime：https://docs.python.org/zh-cn/3/library/datetime.html
• 查 requests：https://requests.readthedocs.io/zh-cn/latest/

使用 dir() 探索模块

快速了解模块有哪些功能：

import json
# 查看所有属性和方法
print(dir(json))
# 只看公开方法（过滤掉__xx__）
[m for m in dir(json) if not m.startswith('_')]

查看源代码

适合想知道具体实现细节时：

import inspect
import json
# 查看模块路径
print(json.__file__)
# 查看函数源代码
print(inspect.getsource(json.dumps))

IDE内置文档（最实用）

VS Code：

• 鼠标悬停在函数上 → 显示签名和简介
• 选中函数 + Ctrl+Shift+P → Python: Show Docs

PyCharm：

• 鼠标悬停 + Ctrl+Q（Mac: F1）
• View → Quick Documentation

Jupyter Notebook：

# 在单元格中
help(list.append)
# 或
list.append?

命令行快速查询

# 在终端中
python -m pydoc json         # 查看模块
python -m pydoc json.dumps   # 查看函数
python -m pydoc -b           # 启动本地浏览器文档

实际案例：查 json.dumps() 用法

假设你想知道 json.dumps 的参数和用法：

# 方法1：help()
help(json.dumps)
# 输出：
# dumps(obj, *, skipkeys=False, ensure_ascii=True, 
#        check_circular=True, allow_nan=True, cls=None, 
#        indent=None, separators=None, ...)
# 方法2：查看官方文档
# 浏览器访问：
# https://docs.python.org/zh-cn/3/library/json.html#json.dumps
# 方法3：快速测试
import json
data = {"name": "张三", "age": 30}
# 默认输出
print(json.dumps(data))  
# 带缩进
print(json.dumps(data, indent=2, ensure_ascii=False))

高效搜索技巧

当你不确定具体函数名时：

1. Google搜索：python 3 如何 读取JSON
2. Stack Overflow：python json.loads vs json.load
3. 官方文档搜索：右上角搜索框

快速定位到特定模块

# 查看模块位置
print(json.__file__)
# 输出类似：/usr/lib/python3.10/json/__init__.py
# 查看包的依赖
print(json.__all__)
# 输出：['dump', 'dumps', 'load', 'loads', ...]

推荐流程

1. 快速查看：help(函数名) 或 函数名?（Jupyter）
2. 了解结构：dir(模块)
3. 找官方文档：书签 docs.python.org/zh-cn/3/library/模块名.html
4. 细节测试：在REPL或Jupyter中实际跑代码
5. 深究源码：inspect.getsource(函数名)

这些方法覆盖了从快速查询到深入学习的所有场景，建议先练熟 help() 和在线文档这两个方法。