我的系统上安装了一个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
当前回答
import types
import yourmodule
print([getattr(yourmodule, a) for a in dir(yourmodule)
if isinstance(getattr(yourmodule, a), types.FunctionType)])
其他回答
对于全局函数,dir()是要使用的命令(正如大多数回答中提到的那样),但是它同时列出了公共函数和非公共函数。
例如:
>>> import re
>>> dir(re)
返回如下函数/类:
'__all__', '_MAXCACHE', '_alphanum_bytes', '_alphanum_str', '_pattern_type', '_pickle', '_subx'
其中一些通常不用于一般编程使用(而是由模块本身使用,除非DunderAliases如__doc__, __file__等)。由于这个原因,将它们与公共对象一起列出可能没有用处(这就是Python如何知道从模块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。
ast模块就是一个例子:
>>> import ast
>>> ast.__all__
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: module 'ast' has no attribute '__all__'
>>>
为了完整起见,我想指出,有时您可能希望解析代码而不是导入代码。导入将执行顶级表达式,这可能是一个问题。
例如,我让用户为用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)
但是,如果您发现阅读返回的列表很烦人,只需使用下面的循环来每行获取一个名称。
for i in dir(module): print i
如果你想获得当前文件中定义的所有函数的列表,你可以这样做:
# 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对另一个问题的回答。
r = globals()
sep = '\n'+100*'*'+'\n' # To make it clean to read.
for k in list(r.keys()):
try:
if str(type(r[k])).count('function'):
print(sep+k + ' : \n' + str(r[k].__doc__))
except Exception as e:
print(e)
输出:
******************************************************************************************
GetNumberOfWordsInTextFile :
Calcule et retourne le nombre de mots d'un fichier texte
:param path_: le chemin du fichier à analyser
:return: le nombre de mots du fichier
******************************************************************************************
write_in :
Ecrit les donnees (2nd arg) dans un fichier txt (path en 1st arg) en mode a,
:param path_: le path du fichier texte
:param data_: la liste des données à écrire ou un bloc texte directement
:return: None
******************************************************************************************
write_in_as_w :
Ecrit les donnees (2nd arg) dans un fichier txt (path en 1st arg) en mode w,
:param path_: le path du fichier texte
:param data_: la liste des données à écrire ou un bloc texte directement
:return: None