我的系统上安装了一个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
当前回答
您可以使用dir(module)查看所有可用的方法/属性。也可以看看PyDocs。
其他回答
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
一旦你导入了模块,你可以这样做:
help(modulename)
... 以交互方式一次性获得所有函数的文档。或者你可以用:
dir(modulename)
... 简单地列出模块中定义的所有函数和变量的名称。
在当前脚本__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
对于全局函数,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__'
>>>
使用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模块中所有已定义的函数。