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

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

例如:

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

当前回答

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

例如,我让用户为用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。

其他回答

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

如果你想获得当前文件中定义的所有函数的列表,你可以这样做:

# Get this script's name.
import os
script_name = os.path.basename(__file__).rstrip(".py")

# Import it from its path so that you can use it as a Python object.
import importlib.util
spec = importlib.util.spec_from_file_location(script_name, __file__)
x = importlib.util.module_from_spec(spec)
spec.loader.exec_module(x)

# List the functions defined in it.
from inspect import getmembers, isfunction
list_of_functions = getmembers(x, isfunction)

作为一个应用程序示例,我使用它来调用单元测试脚本中定义的所有函数。

这是一个密码组合,改编自Thomas Wouters和adrian的答案,以及Sebastian Rittau对另一个问题的回答。

这样就可以了:

dir(module) 

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

for i in dir(module): print i

使用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模块中所有已定义的函数。

在当前脚本__main__中查找名称(和可调用对象)

我试图创建一个独立的python脚本,只使用标准库来查找当前文件中带有task_前缀的函数,以创建npm run提供的最小自制版本。

博士TL;

如果正在运行独立脚本,则需要运行inspect。在sys.modules['__main__']中定义的模块上的Getmembers。例如,

inspect.getmembers(sys.modules['__main__'], inspect.isfunction)

但我想通过前缀过滤方法列表,并剥离前缀以创建查找字典。

def _inspect_tasks():
    import inspect
    return { f[0].replace('task_', ''): f[1] 
        for f in inspect.getmembers(sys.modules['__main__'], inspect.isfunction)
        if f[0].startswith('task_')
    }

示例输出:

{
 'install': <function task_install at 0x105695940>,
 'dev': <function task_dev at 0x105695b80>,
 'test': <function task_test at 0x105695af0>
}

完整版

我希望用方法的名称来定义CLI任务名称,而不必重复。

。/ tasks.py

#!/usr/bin/env python3
import sys
from subprocess import run

def _inspect_tasks():
    import inspect
    return { f[0].replace('task_', ''): f[1] 
        for f in inspect.getmembers(sys.modules['__main__'], inspect.isfunction)
        if f[0].startswith('task_')
    }

def _cmd(command, args):
    return run(command.split(" ") + args)

def task_install(args):
    return _cmd("python3 -m pip install -r requirements.txt -r requirements-dev.txt --upgrade", args)

def task_test(args):
    return _cmd("python3 -m pytest", args)

def task_dev(args):
    return _cmd("uvicorn api.v1:app", args)

if __name__ == "__main__":
    tasks = _inspect_tasks()

    if len(sys.argv) >= 2 and sys.argv[1] in tasks.keys():
        tasks[sys.argv[1]](sys.argv[2:])
    else:
        print(f"Must provide a task from the following: {list(tasks.keys())}")

示例无参数:

λ ./tasks.py
Must provide a task from the following: ['install', 'dev', 'test']

使用额外参数运行test的示例:

λ ./tasks.py test -qq
s.ssss.sF..Fs.sssFsss..ssssFssFs....s.s    

你懂的。随着我的项目越来越多地涉及到,保持脚本的更新比保持README的更新更容易,我可以将其抽象为:

./tasks.py install
./tasks.py dev
./tasks.py test
./tasks.py publish
./tasks.py logs