如何列出模块中的所有功能？
- 2024-12-12 08:41:00
- admin 原创
- 138
问题描述：
我的系统上安装了一个 Python 模块，我想看看其中有哪些可用的函数/类/方法。
我想help在每个方法上调用该函数。在 Ruby 中，我可以执行类似以下操作：ClassName.methods获取该类上所有可用方法的列表。Python 中有类似的东西吗？
例如：
from somemodule import foo
print(foo.methods) # or whatever is the correct method to call
解决方案 1：
您可以使用它dir(module)来查看所有可用的方法/属性。另请查看 PyDocs。
解决方案 2：
使用inspect模块：
from inspect import getmembers, isfunction
from somemodule import foo
print(getmembers(foo, isfunction))
另请参阅pydoc模块、help()交互式解释器中的函数以及pydoc生成所需文档的命令行工具。您只需向它们提供要查看其文档的类即可。它们还可以生成 HTML 输出并将其写入磁盘。
解决方案 3：
一旦您import编辑了模块，您就可以执行以下操作：
help(modulename)
... 以交互方式一次性获取所有函数的文档。或者您可以使用：
dir(modulename)
... 简单列出模块中定义的所有函数和变量的名称。
解决方案 4：
用于inspect.getmembers获取模块中的所有变量/类/函数等，并inspect.isfunction作为谓词传入以仅获取函数：
from inspect import getmembers, isfunction
from my_project import my_module
functions_list = getmembers(my_module, isfunction)
getmembers`(object_name, object)`返回按名称字母顺序排序的元组列表。
您可以用模块中的isfunction任何其他函数进行替换。isXXX`inspect`
解决方案 5：
import types
import yourmodule
print([getattr(yourmodule, a) for a in dir(yourmodule)
if isinstance(getattr(yourmodule, a), types.FunctionType)])
解决方案 6：
为了完整起见，我想指出，有时您可能希望解析代码而不是导入代码。 Animport将执行顶级表达式，这可能会带来问题。
例如，我让用户选择使用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。
解决方案 7：
对于您不想评估的代码，我建议采用基于 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)]
对于其他一切，检查模块是正确的：
import inspect
import <module_to_inspect> as module
functions = inspect.getmembers(module, inspect.isfunction)
这给出了形式为 的 2 元组列表[(<name:str>, <value:function>), ...]。
上述简单的答案在各种回复和评论中有所暗示，但并未明确指出。
解决方案 8：
这将达到目的：
dir(module)
但是，如果您发现阅读返回的列表很烦人，只需使用以下循环每行获取一个名称。
for i in dir(module): print i
解决方案 9：
dir(module)是使用脚本或标准解释器时的标准方式，正如大多数答案中所提到的。
但是，使用IPython等交互式 Python shell，您可以使用制表符补全来概览模块中定义的所有对象。这比使用脚本print查看模块中定义的内容要方便得多。
module.<tab>将显示模块中定义的所有对象（函数、类等等）module.ClassX.<tab>将显示类的方法和属性module.function_xy?或者module.ClassX.method_xy?将显示该函数/方法的文档字符串module.function_x??或者module.SomeClass.method_xy??将向您显示该函数/方法的源代码。
解决方案 10：
对于全局函数来说dir()是使用的命令（正如大多数答案中所提到的），但是这将公共函数和非公共函数一起列出。
例如运行：
>>> import re
>>> dir(re)
返回如下函数/类：
'__all__', '_MAXCACHE', '_alphanum_bytes', '_alphanum_str', '_pattern_type', '_pickle', '_subx'
其中一些通常不用于一般编程用途（但模块本身可以使用，除了 DunderAliases 的情况__doc__，如__file__等）。因此，将它们与公共的列出可能没有什么用（这是 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产生。
ast 模块就是这种情况：
>>> import ast
>>> ast.__all__
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: module 'ast' has no attribute '__all__'
>>>
解决方案 11：
如果您无法导入上述 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])
解决方案 12：
查找当前脚本中的名称（和可调用对象）__main__
我试图创建一个独立的 Python 脚本，该脚本仅使用标准库来查找当前文件中带有前缀的函数，task_以创建所提供内容的最小自制版本npm run。
总结
如果您正在运行独立脚本，则需要在 中定义的inspect.getmembers上运行。例如，module`sys.modules['__main__']`
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']
使用额外参数运行测试的示例：
λ ./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
解决方案 13：
您可以使用以下方法从 shell 中获取模块中的所有函数列表：
import module
module.*?
解决方案 14：
然后使用vars(module)以下方法过滤掉非函数的内容inspect.isfunction：
import inspect
import my_module
my_module_functions = [f for f in vars(my_module).values() if inspect.isfunction(f)]
or的优点vars在于它按照函数定义的顺序返回函数，而不是按字母顺序排列。dir`inspect.getmembers`
此外，这将包括由导入的函数my_module，如果您想过滤掉这些函数以仅获取在中定义的函数my_module，请参阅我的问题获取 Python 模块中所有定义的函数。
解决方案 15：
import sys
from inspect import getmembers, isfunction
fcn_list = [o[0] for o in getmembers(sys.modules[__name__], isfunction)]
解决方案 16：
除了前面答案中提到的 dir(module) 或 help(module)，您还可以尝试：
打开 ipython
导入 module_name
输入 module_name，按 tab。它会打开一个小窗口，列出 python 模块中的所有函数。
它看起来非常整洁。
以下代码片段列出了 hashlib 模块的所有函数
(C:Program FilesAnaconda2) C:Userslenovo>ipython
Python 2.7.12 |Anaconda 4.2.0 (64-bit)| (default, Jun 29 2016, 11:07:13) [MSC v.1500 64 bit (AMD64)]
Type "copyright", "credits" or "license" for more information.
IPython 5.1.0 -- An enhanced Interactive Python.
? -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help -> Python's own help system.
object? -> Details about 'object', use 'object??' for extra details.
In [1]: import hashlib
In [2]: hashlib.
hashlib.algorithms hashlib.new hashlib.sha256
hashlib.algorithms_available hashlib.pbkdf2_hmac hashlib.sha384
hashlib.algorithms_guaranteed hashlib.sha1 hashlib.sha512
hashlib.md5 hashlib.sha224
解决方案 17：
r = globals()
sep = '
'+100*'*'+'
' # To make it clean to read.
for k in list(r.keys()):
try:
if str(type(r[k])).count('function'):
print(sep+k + ' :
' + 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
解决方案 18：
Python 文档为此提供了完美的解决方案，它使用内置函数dir。
您可以只使用dir(module_name)，然后它将返回该模块内的函数列表。
例如，dir(time)将返回
['_STRUCT_TM_ITEMS', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'altzone', 'asctime', 'ctime', 'daylight', 'get_clock_info', 'gmtime', 'localtime', 'mktime', 'monotonic', 'monotonic_ns', 'perf_counter', 'perf_counter_ns', 'process_time', 'process_time_ns', 'sleep', 'strftime', 'strptime', 'struct_time', 'time', 'time_ns', 'timezone', 'tzname', 'tzset']
这是“时间”模块包含的函数列表。
解决方案 19：
这会将 your_module 中定义的所有函数附加到列表中。
result=[]
for i in dir(your_module):
if type(getattr(your_module, i)).__name__ == "function":
result.append(getattr(your_module, i))
解决方案 20：
如果你想获取当前文件中定义的所有函数的列表，你可以这样做：
# 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在另一个问题上的回答改编的代码的组合。
解决方案 21：
help() 函数效果更好
import somemodule
help(somemodule)
