如何列出一个Python模块中的所有函数？

我的系统中安装了一个Python模块，我希望能够看到其中有哪些函数/类/方法可用。

我想在每个模块上调用文档函数。在Ruby中，我可以做一些类似ClassName.methods的事情来获得该类所有可用方法的列表。在python中是否有类似的东西？

例如，类似的东西。

from somemodule import foo
print foo.methods # or whatever is the correct method to call
codeforester
已编辑的问题 2日 三月 2019 в 3:05
编程
reflection python module inspect
26日 九月 2008 в 12:38
41 种观点
对该问题的评论 (1)

你可以使用dir(module)来查看所有可用的方法/属性。 还可以查看PyDocs。

评论(5)

一旦你'了导入模块，你就可以直接做。

 help(modulename)

... 要获得所有功能的文档一次，交互式的。 或者你可以使用:

 dir(modulename)

... 简单地列出模块中定义的所有函数和变量的名称。

评论(2)
解决办法

inspect模块。也请看 pydoc 模块，交互式解释器中的help()函数和pydoc命令行工具，它可以生成你想要的文档。你可以给他们提供你希望看到的文档的类。它们还可以生成，例如，HTML输出并写入磁盘。

Nathaniel Jones
编辑本段答案22日 六月 2019 в 1:21
评论(4)

以检查为例。

from inspect import getmembers, isfunction
from my_project import my_module

functions_list = [o for o in getmembers(my_module) if isfunction(o[1])]

getmembers 返回一个 (object_name, object_type) 元组的列表。

你可以用检查模块中的任何一个isXXX函数代替isfunction。

评论(3)
 
import types
import yourmodule

print([getattr(yourmodule, a) for a in dir(yourmodule)
  if isinstance(getattr(yourmodule, a), types.FunctionType)])
Aran-Fey
编辑本段答案11日 六月 2018 в 4:24
评论(4)

为了完整性&#39。 的缘故，我'想指出，有时你可能想要_解析代码，而不是导入它。 import会执行顶层表达式，这可能是个问题。

例如，我让用户为使用[zipapp][1]制作的包选择入口点函数。 使用 "import "和 "inspect "有可能跑错代码，导致崩溃，帮助信息被打印出来，GUI对话框弹出等等。

相反，我使用[ast][2]模块来列出所有的顶层函数。

import ast
import sys

def top_level_functions(body):
    return (f for f in body if isinstance(f, ast.FunctionDef))

def parse_ast(filename):
    with open(filename, "rt") as file:
        return ast.parse(file.read(), filename=filename)

if __name__ == "__main__":
    for filename in sys.argv[1:]:
        print(filename)
        tree = parse_ast(filename)
        for func in top_level_functions(tree.body):
            print("  %s" % func.name)

将这段代码放在list.py中，并将其本身作为输入，我得到了。

$ python list.py list.py
list.py
  top_level_functions
  parse_ast

当然，即使对于像Python这样相对简单的语言来说，浏览AST有时也是很棘手的，因为AST是相当低级的。 但是，如果你有一个简单而明确的用例，它既可行又安全。

虽然，一个缺点是你不能检测到在运行时生成的函数，比如foo = lambda x,y: x*y.

[1]: https://docs.python.org/dev/library/zipapp.html [2]: https://docs.python.org/3.2/library/ast.html#module-ast

csl
编辑本段答案11日 四月 2017 в 8:08
评论(2)

这样就可以了。

dir(module)

但是，如果你觉得读取返回的列表很烦人，只需使用下面的循环就可以每行得到一个名字。

for i in dir(module): print i
评论(1)

对于你不想解析的代码，我推荐上面@csl的基于AST的方法。

对于其他的代码，检查模块是正确的。

import inspect

import  as module

functions = inspect.getmembers(module, inspect.isfunction)

这给出了一个形式为[(<name:str>，<value:function>)，...]的2元组列表。

上面的简单答案在各种回复和评论中都有提示，但没有明确地叫出来。

评论(1)

dir(module)是使用脚本或标准解释器时的标准方法，正如大多数答案中提到的那样。

然而，如果使用像IPython这样的交互式python shell，你可以使用tab-completion来获得模块中定义的所有对象的概览。 这比使用脚本和 "print "来查看模块中定义的内容要方便得多。

  • module.<tab>将显示模块中定义的所有对象（函数、类等）。
  • module.ClassX.<tab>将向你展示一个类的方法和属性。
  • module.function_xy?或module.ClassX.method_xy?将显示该函数/方法的docstring。
  • module.function_x??或module.SomeClass.method_xy??将显示该函数/方法的源代码。
评论(0)

对于全局函数来说，dir()是要使用的命令(在大多数答案中都提到了)，然而这将公共函数和非公共函数一起列出。

例如，运行

>>> import re
>>> dir(re)

返回函数/类，如：{{{5337016}}。

'__all__', '_MAXCACHE', '_alphanum_bytes', '_alphanum_str', '_pattern_type', '_pickle', '_subx'

其中一些通常不是为了一般的编程使用 (而是由模块本身使用，除了像 __doc__, __file__等 DunderAliases)。 出于这个原因，把它们和公共的一起列出可能没有什么用 (当使用 "from module import *"时，Python 就是这样知道要得到什么)。

__all__ 可以用来解决这个问题，它返回一个模块中所有公共函数和类的列表 (那些 * 不以下划线开头的函数 - _)。 参见 https://stackoverflow.com/questions/44834/can-someone-explain-all-in-python，以便使用"__all__"。

下面是一个例子。

>>> import re
>>> re.__all__
['match', 'fullmatch', 'search', 'sub', 'subn', 'split', 'findall', 'finditer', 'compile', 'purge', 'template', 'escape', 'error', 'A', 'I', 'L', 'M', 'S', 'X', 'U', 'ASCII', 'IGNORECASE', 'LOCALE', 'MULTILINE', 'DOTALL', 'VERBOSE', 'UNICODE']
>>>

所有带下划线的函数和类都被删除了，只留下那些被定义为公共的函数和类，因此可以通过import *使用。

请注意，__all__并不总是被定义。 如果它没有被包含，那么就会引发AttributeError。

ast模块就是一个例子。

>>> import ast
>>> ast.__all__
Traceback (most recent call last):
  File "", line 1, in 
AttributeError: module 'ast' has no attribute '__all__'
>>>
Simon
编辑本段答案9日 四月 2018 в 1:28
评论(0)

如果你无法导入上述Python文件而不出现导入错误，这些答案都是行不通的。 当我在检查一个文件时就遇到了这种情况，这个文件来自于一个有很多依赖关系的大型代码库。 下面将把文件作为文本处理，搜索所有以"def&quot.开头的方法名，并打印它们和它们的行号。 开头的方法名，并打印它们和它们的行号。

import re
pattern = re.compile("def (.*)\(")
for i, line in enumerate(open('Example.py')):
  for match in re.finditer(pattern, line):
    print '%s: %s' % (i+1, match.groups()[0])
评论(2)

除了前面答案中提到的dir(模块)或help(模块)，你还可以尝试：<br&gt。

  • 打开ipython
  • import module_name <br&gt。
  • 输入module_name，按tab键。 它会打开一个小窗口，列出python模块中的所有函数。
    输入module_name，按tab键。 它看起来非常整洁。
    这里是列出所有函数的片段。

下面是列出hashlib模块所有函数的片段。

(C:\Program Files\Anaconda2) C:\Users\lenovo>ipython
Python 2.7.12 |Anaconda 4.2.0 (64-bit)| (default, Jun 29 2016, 11:07:13) [MSC v.1500 64 bit (AMD64)]
Type "copyright", "credits" or "license" for more information.

IPython 5.1.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.

In [1]: import hashlib

In [2]: hashlib.
             hashlib.algorithms            hashlib.new                   hashlib.sha256
             hashlib.algorithms_available  hashlib.pbkdf2_hmac           hashlib.sha384
             hashlib.algorithms_guaranteed hashlib.sha1                  hashlib.sha512
             hashlib.md5                   hashlib.sha224
Saurya Man Patel
编辑本段答案9日 一月 2017 в 2:05
评论(0)

你可以使用下面的方法从shell中获取模块中的所有函数列表。

import module

module.*?
评论(1)

这将把所有定义在 your_module 中的函数附加到一个列表中。

result=[]
for i in dir(unit8_conversion_methods):
    if type(getattr(your_module, i)).__name__ == "function":
        result.append(getattr(your_module, i))
Stephen Rauch
编辑本段答案16日 九月 2018 в 6:54
评论(2)