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

我想对每一个都调用帮助函数。在Ruby中,我可以做一些类似ClassName的事情。方法获取该类上所有可用方法的列表。Python中有类似的东西吗?

例如:

from somemodule import foo
print(foo.methods)  # or whatever is the correct method to call

当前回答

Python文档提供了使用内置函数dir的完美解决方案。

您可以只使用dir(module_name),然后它将返回该模块中的函数列表。

例如,dir(time)将返回

[' _STRUCT_TM_ITEMS’,‘__doc__’,‘__loader__’,‘__name__’,‘__package__’,‘__spec__’,‘altzone’,‘asctime’,‘ctime’,‘阳光’,‘get_clock_info’,‘gmtime’,‘作用’,‘mktime’,‘单调’,‘monotonic_ns’,‘perf_counter’,‘perf_counter_ns’,‘process_time’,‘process_time_ns’,‘睡眠’,‘strftime’,‘strptime’,‘struct_time’,‘时间’,‘time_ns’,“时区”,“tzname”,“tzset”)

它是'time'模块包含的函数列表。

其他回答

import sys
from inspect import getmembers, isfunction
fcn_list = [o[0] for o in getmembers(sys.modules[__name__], isfunction)]

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

导入模块

module.*?

为了完整起见,我想指出,有时您可能希望解析代码而不是导入代码。导入将执行顶级表达式,这可能是一个问题。

例如,我让用户为用zipapp生成的包选择入口点函数。使用导入和检查的风险包括运行错误的代码、导致崩溃、打印帮助消息、弹出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。

对于你不想评估的代码,我推荐一种基于ast的方法(就像csl的答案),例如:

import ast

source = open(<filepath_to_parse>).read()
functions = [f.name for f in ast.parse(source).body
             if isinstance(f, ast.FunctionDef)]

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

import inspect

import <module_to_inspect> as module

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

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

上面的简单答案在各种回应和评论中都有暗示,但没有明确地指出来。

使用vars(module),然后使用inspect.isfunction过滤掉任何不是函数的东西:

import inspect
import my_module

my_module_functions = [f for _, f in vars(my_module).values() if inspect.isfunction(f)]

vars相对于dir或inspect的优势。Getmembers是按函数定义的顺序返回函数,而不是按字母顺序排序。

此外,这将包括my_module导入的函数,如果你想过滤掉它们,只获得my_module中定义的函数,请参阅我的问题获取Python模块中所有已定义的函数。