如何列出一个模块中的所有函数?

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

我想对每一个都调用help函数。在Ruby中,我可以执行ClassName.methods之类的操作来获得该类中所有可用方法的列表。Python中有类似的东西吗?

例如:

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

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

使用inspect模块:

from inspect import getmembers, isfunction


from somemodule import foo
print(getmembers(foo, isfunction))

还可以查看交互式解释器中的pydoc模块、help()函数和用于生成所需文档的pydoc命令行工具。您可以只给他们您希望看到的类的文档。例如,它们还可以生成HTML输出并将其写入磁盘。

import types
import yourmodule


print([getattr(yourmodule, a) for a in dir(yourmodule)
if isinstance(getattr(yourmodule, a), types.FunctionType)])

一旦你imported了模块,你可以这样做:

help(modulename)

... 以交互方式一次性获得所有函数的文档。或者你可以用:

dir(modulename)

... 简单地列出模块中定义的所有函数和变量的名称。

这样就可以了:

dir(module)

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

for i in dir(module): print i

使用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替换为# EYZ2模块中的任何其他isXXX函数。

正如大多数回答中提到的,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??将显示函数/方法的源代码。

如果你不能在没有导入错误的情况下导入上述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])

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

例如,我让用户为使用zipapp创建的包选择入口点函数。使用importinspect有运行错误代码、导致崩溃、打印帮助消息、弹出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

你可以使用下面的方法从shell中获取模块中的所有函数:

# EYZ0

module.*?

除了前面的回答中提到的dir(module)或者help(module),也可以尝试:
—打开ipython
- import module_name
.使用实例 - type module_name,按tab键。它会打开一个小窗口,列出python模块中的所有函数。< br > 看起来很整洁。< br > < / p >

下面是hashlib模块的所有函数的代码片段

(C:\Program Files\Anaconda2) C:\Users\lenovo>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

对于您不愿评价的代码,我建议使用基于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>), ...]的二元组列表。

上面的简单答案在各种回应和评论中都有暗示,但没有明确地指出来。

对于全局函数,dir()是要使用的命令(正如大多数回答中提到的那样),但是它同时列出了公共函数和非公共函数。

例如:

>>> import re
>>> dir(re)

返回如下函数/类:

'__all__', '_MAXCACHE', '_alphanum_bytes', '_alphanum_str', '_pattern_type', '_pickle', '_subx'

其中一些通常不用于一般编程使用(而是由模块本身使用,除了像__doc____file__等DunderAliases的情况)。由于这个原因,将它们与公共对象一起列出可能没有用处(这就是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__'
>>>

这将把your_module中定义的所有函数添加到列表中。

result=[]
for i in dir(your_module):
if type(getattr(your_module, i)).__name__ == "function":
result.append(getattr(your_module, i))
import sys
from inspect import getmembers, isfunction
fcn_list = [o[0] for o in getmembers(sys.modules[__name__], isfunction)]
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

Python文档提供了完美的解决方案,它使用内置函数dir

您可以使用dir (module_name),然后它将返回该模块中的函数列表。

例如,将返回dir(时间)

# EYZ0

它是'time'模块包含的函数列表。

使用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相对于dirinspect.getmembers的优点是,它按函数定义的顺序返回函数,而不是按字母顺序排序。

此外,这将包括由my_module导入的函数,如果你想过滤掉它们,只得到在my_module中定义的函数,请参阅我的问题获取Python模块中所有已定义的函数

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

# 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)

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

这是一个代码组合,改编自这里的托马斯·伍特斯艾德里安的答案,以及另一个问题上的塞巴斯蒂安Rittau的答案。

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

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

博士TL;

如果你正在运行一个独立的脚本,你想在sys.modules['__main__']中定义的module上运行inspect.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任务名称,而不必重复。

# EYZ0

#!/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