在Python的标准库中，help函数是快速查看对象文档的主要入口。它既能查询内置函数、模块、类、方法，也能搜索关键字和帮助主题。帮助信息并非硬编码在help内部，而是来自对象的__doc__属性，并由pydoc模块负责格式化。理解这一点后，就很容易明白为什么有些第三方库的help输出非常详细，而有些只显示一行空白。
一、help函数的基础调用方式
在Python解释器中，help最常见的用法是传入一个对象。例如执行help(len)，终端会显示len函数的签名、参数说明和返回值描述。如果直接调用help()不带参数，会进入一个独立的帮助环境，提示符变为help>，此时可以继续输入模块名、函数名或主题词来浏览，也可以输入keywords查看关键字列表，输入quit或按q退出。
help还能接收字符串参数。比如help('keywords')会列出Python当前版本的全部关键字，help('json')或help('os.path')可以查看模块和子模块的说明。接收字符串时，help会先把它当作模块名、主题名或对象名进行解析，如果找不到再报错。这也是它和直接传对象的一个重要区别：传对象时拿到的是该对象自身的文档，传字符串时则依赖pydoc的查找规则。
从实现角度看，help并不是Python核心语法的一部分，而是site模块在启动解释器时注入到内置命名空间的函数，真正干活的是pydoc模块。因此它的输出格式、换行和分页行为在不同环境中会有差异。
二、在脚本里使用help：输出重定向与常见限制
在交互式解释器里，help的输出会经过分页器，方便逐页阅读。但在.py脚本或IDE中调用help时，它只是把文本一次性写到标准输出，通常不会进入分页模式。如果你想把帮助内容保存到文件，可以用上下文管理器临时重定向stdout。
import contextlib
import io
buffer = io.StringIO()
with contextlib.redirect_stdout(buffer):
help(str)
text = buffer.getvalue()
print(text[:200])
上面这段代码把str的完整帮助信息写入内存缓冲区，再截取前200个字符打印，适合提取部分内容做二次处理。不过help的输出内容面向人类阅读，不适合作为程序间稳定的API返回。如果程序需要结构化信息，例如判断某个参数是否存在，直接读取__doc__或使用inspect.signature、inspect.getdoc会更合适。
另一个需要注意的限制是：help在输出长文档时可能会主动截断或等待用户翻页。虽然在脚本里通常不会等待，但在某些嵌入式环境或设置了PAGER变量的系统中，行为可能不同。如果你只是想知道一个函数有哪些参数，使用help(func)输出会很长，反而增加阅读成本，此时print(func.__doc__)可能更轻量。
三、让help输出更有价值：编写规范的docstring
help函数展示的文档大部分来自对象的__doc__属性。对于自己编写的函数、类或模块，只要在定义体第一行写入字符串字面量作为docstring，help就会把这些内容原样展示出来。因此，docstring写得越具体，help对使用者的帮助越大。
比如下面这个函数带有完整的三段式docstring，说明了功能、参数和返回值：
def add(a: int, b: int) -> int:
"""Return the sum of two integers.
Args:
a: The first integer.
b: The second integer.
Returns:
int: The result of a + b.
"""
return a + b
help(add)
执行help(add)后，终端会显示函数签名add(a: int, b: int) -> int以及docstring里的详细说明。这里的Args、Returns是Google风格注释的常见字段，help本身不会解析这些字段，只是原样输出。对于团队协作或公开库，还可以采用Sphinx reStructuredText风格，让后续工具自动生成API文档。
除了函数，模块级docstring、类docstring和方法docstring也同样会被help读取。模块的第一行字符串可以说明模块用途和主要导出内容，类的docstring可以描述构造参数、属性和使用示例。当多个开发人员维护同一个包时，这些文档信息比口头约定可靠得多。
四、help的常见查询对象与实用技巧
help内置了一个主题索引，除了对象和模块名，还支持一些特殊关键词。输入help('keywords')可以查看当前Python版本的关键字；输入help('symbols')可以查看运算符和特殊符号；输入help('modules')会尝试列出当前环境中已经安装的模块列表。这个列表可能很长，通常在交互式环境配合分页器查看比较方便。
对标准库不熟悉时，可以先从模块名入手。例如help('re')会显示re模块的介绍、函数和常量摘要；help('collections')可以了解常用容器类型；help(list.append)则直接定位到列表的append方法，展示参数和返回值说明。对初学者来说，这种“点进去看方法”的方式比翻官方网页更快。
如果在help环境中迷路，可以输入help查看帮助环境自身的说明，输入topics查看所有可浏览的主题，输入q返回上一层或退出。在自动测试或CI环境中，尽量避免调用help产生大量输出，因为日志会被刷屏。真要检查某个对象是否有文档，可以用assert obj.__doc__或inspect.getdoc(obj)做轻量验证。
最后要注意，help返回的是None而不是文本字符串。初学者常以为doc = help(str)会拿到帮助文本，实际上doc会变成None，帮助文本已经直接打印出来了。需要文本时必须用上面提到的重定向方式，或者改用obj.__doc__、pydoc.render_doc等接口。这个细节虽小，但能避免很多无谓的调试。
help函数Python内置函数查看文档修改时间：2026-09-23 02:42:08