Python中的帮助函数

在编写Python代码时，我们难免会遇到不熟悉的模块、函数、方法等，这时候我们就需要使用Python中的帮助函数来帮助我们解决问题。

help函数

在Python中，我们可以使用内置函数help()来获取帮助信息。help()函数会返回一个有关指定模块、函数、方法等的详细文档。

使用方法

语法：help([object])

参数：

• object：可选参数，要获取帮助信息的对象。如果不提供参数，将打开Python帮助交互界面。

示例

假设我们想要获取math模块的帮助信息：

import math
help(math)

运行输出结果为：

Help on module math:

NAME
    math

MODULE REFERENCE
    https://docs.python.org/3/library/math

    The following documentation is automatically generated from the Python
    source files.  It may be incomplete, incorrect or include features that
    are considered implementation detail and may vary between Python
    implementations.  When in doubt, consult the module reference at the
    location listed above.

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

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

    acosh(x, /)
        Return the inverse hyperbolic cosine of x.

    asin(x, /)
        Return the arc sine (measured in radians) of x.

    asinh(x, /)
        Return the inverse hyperbolic sine of x.

    atan(x, /)
        Return the arc tangent (measured in radians) of x.

    atan2(y, x, /) ...
...

可以看到，help函数会将math模块的详细信息打印出来。

另外的方式

除了使用内置函数help()外，我们还可以使用?和??来获取帮助信息。

• ?：用于获取简要的帮助信息。
• ??：用于获取源代码。

示例：

import math
math.sqrt?

math.sqrt??

help(math.sqrt)

输出结果为：

Signature: math.sqrt(x, /)
Docstring:
Return the square root of x.
Type:      builtin_function_or_method
File:      /usr/local/Cellar/python/3.7.2_2/Frameworks/Python.framework/Versions/3.7/lib/python3.7/lib-dynload/math.cpython-37m-darwin.so
Source:
def sqrt(x, /):
    """
    Return the square root of x.
    """
    pass

可见，?和??可以快速获取简要的帮助信息和源代码。不过它并不能得到与help函数一样详细的文档。

总结

• help函数可以获取Python中模块、函数、方法等的详细文档信息。
• ?和??也可以获取帮助信息，但只能得到简要信息和源代码。
• 在编写Python代码时，不知道具体用法时可以使用以上函数来获取帮助信息。