我的系统上安装了一个Python模块,我希望能够看到其中有哪些函数/类/方法可用。
我想对每一个都调用帮助函数。在Ruby中,我可以做一些类似ClassName的事情。方法获取该类上所有可用方法的列表。Python中有类似的东西吗?
例如:
from somemodule import foo
print(foo.methods) # or whatever is the correct method to call
我的系统上安装了一个Python模块,我希望能够看到其中有哪些函数/类/方法可用。
我想对每一个都调用帮助函数。在Ruby中,我可以做一些类似ClassName的事情。方法获取该类上所有可用方法的列表。Python中有类似的东西吗?
例如:
from somemodule import foo
print(foo.methods) # or whatever is the correct method to call
当前回答
对于你不想评估的代码,我推荐一种基于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>),…]的二元组列表。
上面的简单答案在各种回应和评论中都有暗示,但没有明确地指出来。
其他回答
你可以使用下面的方法从shell中获取模块中的所有函数:
导入模块
module.*?
如果你不能在没有导入错误的情况下导入上述Python文件,这些答案都不会起作用。当我检查一个来自大量依赖的大型代码库的文件时,我就遇到了这种情况。下面的代码将把文件作为文本处理,搜索所有以“def”开头的方法名,并打印它们及其行号。
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])
在当前脚本__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
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'模块包含的函数列表。
Dir(模块)是使用脚本或标准解释器时的标准方式,正如大多数回答中提到的那样。
然而,对于交互式python shell(如IPython),您可以使用制表符完成来获得模块中定义的所有对象的概述。 这比使用脚本和打印查看模块中定义的内容要方便得多。
模块。<tab>将显示模块中定义的所有对象(函数,类等) module.ClassX。<tab>将显示一个类的方法和属性 module.function_xy吗?还是module.ClassX.method_xy ?是否会显示该函数/方法的文档字符串 module.function_x ? ?还是module.SomeClass.method_xy ? ?将显示函数/方法的源代码。