Python help()函数用法详解

help()函数的基本用法

help()函数有两种主要使用方式：

1. 交互式帮助模式

在Python解释器中直接输入help()即可进入交互式帮助模式：

>>> help()
Welcome to Python 3.10's help utility!

To get a list of available modules, keywords, symbols, or topics, type "modules", "keywords", "symbols", or "topics".

help> modules
help> keywords
help> quit
    

在此模式下，你可以输入模块名、函数名、类名或关键字来查看其文档。输入quit可退出帮助模式。

2. 直接查询对象

你也可以直接查询特定对象的帮助信息：

>>> help(print)
Help on built-in function print in module builtins:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
    
    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    ...
    

查看不同类型的帮助文档

查看模块帮助

>>> import math
>>> help(math)
Help on module math:

NAME
    math

DESCRIPTION
    This module provides access to the mathematical functions
    defined by the C standard.

FUNCTIONS
    acos(x, /)
        Return the arc cosine (measured in radians) of x.
    ...
    

查看类帮助

>>> help(str)
Help on class str in module builtins:

class str(object)
 |  str(object='') -> str
 |  str(bytes_or_buffer[, encoding[, errors]]) -> str
 |  
 |  Create a new string object from the given object...
 |  
 |  Methods defined here:
 |  
 |  __add__(self, value, /)
 |      Return self+value.
 |  
 |  capitalize(self, /)
 |      Return a capitalized version of the string.
    ...
    

查看函数/方法帮助

>>> help(str.split)
Help on method_descriptor:

split(self, /, sep=None, maxsplit=-1)
    Return a list of the words in the string, using sep as the delimiter string.
    
    sep
      The delimiter according which to split the string.
      None (the default value) means split according to any whitespace,
      and discard empty strings from the result.
    maxsplit
      Maximum number of splits to do.
      -1 (the default value) means no limit.
    

自定义帮助文档

你可以为自己的函数、类和模块添加文档字符串(docstring)，这样它们也可以通过help()函数显示：

def calculate_area(radius):
    """
    计算圆的面积
    
    参数:
    radius (float): 圆的半径
    
    返回:
    float: 圆的面积
    """
    return 3.14 * radius ** 2

help(calculate_area)
    

输出结果：

Help on function calculate_area in module __main__:

calculate_area(radius)
    计算圆的面积
    
    参数:
    radius (float): 圆的半径
    
    返回:
    float: 圆的面积
    

help()函数的优势

• 快速访问文档：无需离开开发环境即可查看文档
• 学习工具：帮助理解Python内置函数和标准库
• 提高效率：减少在文档和代码编辑器之间切换的时间
• 自文档化：鼓励开发者为自己的代码编写文档

注意事项

1. 某些第三方模块可能没有完整的文档字符串
2. 在脚本中使用help()会暂停程序执行
3. 对于大型模块，帮助信息可能会很长，可使用空格键翻页，q键退出
4. 在IDE中（如PyCharm、VSCode）通常有更直观的文档查看方式