python：如何获取函数的信息？

Question

当你需要了解某种类型的信息时，可以使用：

my_list = []
dir(my_list)

获取：

['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__delslice__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__getslice__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__setslice__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

或者：

dir(my_list)[36:]

获取：

['append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

现在，在Python的文档中可以找到关于这些函数的信息，但我想在终端或命令行中获取这些函数的信息。应该怎么做呢？

Answer 1

你可以使用 pydoc 这个工具。

打开你的终端，输入 python -m pydoc list.append 来查看关于 list.append 的帮助信息。

使用 pydoc 的好处是，你不需要先导入一个模块就能查看它的帮助文档。比如，你可以输入 python -m pydoc random.randint 来查看 random.randint 的帮助。

另外，你还可以通过输入 python -m pydoc -b 来启动一个 HTTP 服务器，这样就可以在网页上浏览文档了（适用于 Python 3）。

想要了解更多信息，可以输入 python -m pydoc。

Answer 2

试试看

help(my_list)

来获取内置的帮助信息。

Answer 3

在Python中，比如你输入 help(my_list.append)，这条命令会给你这个函数的说明文档。

>>> my_list = []
>>> help(my_list.append)

    Help on built-in function append:

    append(...)
        L.append(object) -- append object to end