Python help 函数
上次修改时间：2025 年 4 月 11 日
这份全面指南探讨了 Python 的 help 函数，该函数为 Python 对象提供交互式文档。我们将涵盖基本用法、模块、类、函数和自定义帮助文档。
基本定义
help 函数是 Python 内置的交互式帮助系统。当不带参数调用时，它会启动交互式帮助实用程序。
带参数调用时，它会显示有关指定对象的文档。它适用于模块、函数、类、方法、关键字和其他 Python 对象。
基本交互式帮助
以下是如何在交互模式下使用 help 来探索 Python 的文档系统。
# Start interactive help help() # Then try these commands at the help> prompt: # help> list # help> str.split # help> keywords # help> modules # help> quit
这展示了如何进入 Python 的交互式帮助系统。进入后，您可以探索各种对象、关键字和模块的文档。
输入 quit 以退出交互式帮助系统并返回到 Python 解释器。
获取关于内置函数的帮助
您可以通过将任何内置函数传递给 help 来获取其文档。此示例展示了如何获取 print 的帮助。
# Get help for the print function help(print) # Output will show: # print(...) # print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False) # Prints the values to a stream, or to sys.stdout by default...
这会显示 print 函数的完整文档，包括其参数和默认值。相同的方法适用于所有内置函数。
输出显示函数签名、参数描述和用法示例（如果可用）。
探索模块文档
help 可以显示整个模块的文档。此示例展示了如何获取 math 模块的帮助。
import math # Get help for the entire math module help(math) # Output will show: # NAME # math - This module provides access to the mathematical functions... # # DESCRIPTION # This module provides access to the mathematical functions... # # FUNCTIONS # acos(x, /) # Return the arc cosine (measured in radians) of x...
这会显示 math 模块的全面文档，包括所有可用的函数、常量及其描述。
您可以滚动输出以探索模块中所有可用的数学运算。
获取类文档
help 提供关于类的详细信息，包括方法、属性和继承。此示例检查 list 类。
# Get help for the list class help(list) # Output will show: # class list(object) # | list() -> new empty list # | list(iterable) -> new list initialized from iterable's items # | # | Methods defined here: # | # | append(self, object, /) # | Append object to the end of the list...
这会显示完整的类文档，包括构造函数签名、所有可用的方法及其描述。
输出有助于理解如何使用该类以及它支持哪些操作。
自定义帮助文档
您可以使用文档字符串 (docstrings) 为您自己的函数和类提供帮助文档。此示例演示了自定义帮助。
def calculate_area(radius):
"""Calculate the area of a circle.
Args:
radius (float): The radius of the circle in meters
Returns:
float: The area in square meters
"""
return 3.14159 * radius ** 2
# Now get help for our function
help(calculate_area)
# Output will show:
# calculate_area(radius)
# Calculate the area of a circle.
#
# Args:
# radius (float): The radius of the circle in meters
#
# Returns:
# float: The area in square meters
这展示了文档字符串如何成为帮助系统的一部分。当对函数调用 help 时，该函数的文档字符串会出现。
编写良好的文档字符串使您的代码具有自文档性，并通过帮助系统更易于使用。
最佳实践
- 使用文档字符串： 始终使用文档字符串记录您的函数和类
- 描述性强： 包括参数类型、返回值和示例
- 交互式探索： 在 REPL 中使用 help() 来发现功能
- 检查模块： 对导入的模块使用 help 来了解它们的 API
- 遵循约定： 使用标准的文档字符串格式，例如 Google 或 NumPy 风格
资料来源
作者
列出所有 Python 教程。