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

为了完整起见,我想指出有时您可能想要解析代码而不是导入代码.一个import将执行最高水平的表达,这可能是一个问题.

例如,我让用户为使用zipapp制作的包选择入口点函数.使用import和inspect冒险运行误入歧途的代码,导致崩溃,帮助打印出消息,弹出GUI对话框等等.

相反,我使用ast模块列出所有顶级函数:

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

当然,导航AST有时会很棘手,即使是像Python这样相对简单的语言,因为AST非常低级.但是如果你有一个简单明了的用例,它既可行又安全.

但是,缺点是您无法检测在运行时生成的函数,例如foo = lambda x,y: x*y.

这样就可以了:

dir(module) 

但是,如果您发现读取返回的列表很烦人,只需使用以下循环来获取每行一个名称.

for i in dir(module): print i

对于您不想解析的代码,我建议使用上面基于AST的@csl方法.

对于其他一切,检查模块是正确的:

import inspect

import  as module

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

这给出了表单中的2元组列表[(, ), ...].

上面的简单答案在各种回复和评论中被暗示,但未明确提出.

dir(module) 是大多数答案中提到的使用脚本或标准解释器的标准方法.

但是,使用像IPython这样的交互式python shell,您可以使用tab-completion来概览模块中定义的所有对象.这比使用脚本和print查看模块中定义的内容要方便得多.

module. 将显示模块中定义的所有对象(函数,类等)

module.ClassX. 将向您展示一个类的方法和属性

module.function_xy?或者module.ClassX.method_xy?将显示该函数/方法的文档字符串

module.function_x??或者module.SomeClass.method_xy??将显示函数/方法的源代码.

对于全局函数dir()是要使用的命令(如大多数答案中所述),但是它将公共函数和非公共函数一起列出.

例如运行:

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

返回函数/类,如:

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

其中一些通常不用于一般编程用途(但是由模块本身,除了DunderAliases之类的情况,例如__doc__,__file__ect).出于这个原因,将它们与公共列表一起列出可能没有用(这就是Python在使用时知道要获得什么的方式from module import *).

__all__可以用来解决这个问题,它返回一个模块中所有公共函数和类的列表(不以下划线开头的那些- _).请参阅 Python中有人解释__all__吗？供使用__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提出a.

这种情况与ast模块有关:

>>> import ast
>>> ast.__all__
Traceback (most recent call last):
  File "", line 1, in 
AttributeError: module 'ast' has no attribute '__all__'
>>>