Python help()函数完全指南：掌握内置帮助系统的使用方法与技巧

2 年 ago

清, 宇

2 minutes

Python中的help()函数用于获取指定模块、类、函数、变量等的文档。这个方法通常与Python解释器控制台一起使用，以获取关于Python对象的详细信息。

Python的help()函数

Python的help()函数的语法是：

help([object])

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

如果你想退出帮助控制台，请键入退出。我们也可以通过向help()函数传递参数直接从Python控制台获取帮助文档。

>>> help('collections')

>>> help(print)

>>> help(globals)

让我们看一下globals()函数的help()函数输出是什么。

>>> help('builtins.globals')

关于内置模块中的内置函数globals的帮助：

builtins.globals = globals()
    返回包含当前作用域全局变量的字典。
    
    注意：对此字典的更新将影响当前全局作用域中的名称查找，反之亦然。

为自定义类和函数定义help()函数

我们可以通过定义文档字符串（docstring）来为我们的自定义类和函数定义help()函数的输出。默认情况下，方法体中的第一行注释字符串被用作其文档字符串。它被三个双引号包围。假设我们有一个名为python_help_examples.py的Python文件，其中包含以下代码。

def add(x, y):
    """
    此函数将给定的整数参数相加
    :param x: 整数
    :param y: 整数
    :return: 整数
    """
    return x + y


class Employee:
    """
    Employee类，映射到数据库中的"employee"表
    """
    id = 0
    name = ''

    def __init__(self, i, n):
        """
        Employee对象构造函数
        :param i: 整数，必须为正数
        :param n: 字符串
        """
        self.id = i
        self.name = n

请注意，我们已经为函数、类以及它们的方法定义了文档字符串。您应该遵循一些文档格式，我已经使用PyCharm IDE自动生成了一部分文档。NumPy文档字符串指南是了解正确的帮助文档编写方式的好地方。让我们看看如何在Python控制台中将这个文档字符串作为帮助文档获取。首先，我们需要在控制台中执行此脚本以加载我们的函数和类定义。我们可以使用exec()命令来实现这一点。

>>> exec(open("python_help_examples.py").read())

我们可以使用globals()命令验证函数和类定义是否存在。

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__warningregistry__': {'version': 0}, 'add': <function add at 0x100dda1e0>, 'Employee': <class '__main__.Employee'>}

注意到全局范围字典中存在’Employee’和’add’。现在我们可以使用help()函数来获取帮助文档。让我们看一些例子。

>>> help('python_help_examples')

>>> help('python_help_examples.add')

关于python_help_examples中函数add的帮助：

python_help_examples.add = add(x, y)
    此函数将给定的整数参数相加
    :param x: 整数
    :param y: 整数
    :return: 整数
(END)

>>> help('python_help_examples.Employee')

>>> help('python_help_examples.Employee.__init__')


关于python_help_examples.Employee中函数__init__的帮助：

python_help_examples.Employee.__init__ = __init__(self, i, n)
    Employee对象构造函数
    :param i: 整数，必须为正数
    :param n: 字符串
(END)

总结

Python的help()函数非常有帮助，可以获取关于模块、类和函数的详细信息。对于自定义的类和函数，最佳实践是定义文档字符串来解释它们的用法。

您可以从我们的GitHub代码库中检出完整的Python脚本和更多的Python示例。

参考：官方文档

#help()函数 #Python内置函数 #Python帮助系统 #Python教程 #Python编程技巧