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

我想在每个函数上调用 help 函数。在 Ruby 中，我可以做类似 ClassName.methods 的操作来获取该类上所有可用方法的列表。Python中有类似的东西吗？

例如：

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

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

使用 inspect 模块：

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

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

import编辑模块后，您可以执行以下操作：

help(modulename)

。以交互方式一次获取所有函数的文档。或者您可以使用：

dir(modulename)

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

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

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

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

例如，我让用户为使用 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 .

对于您不想评估的代码，我推荐基于 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>), ...] 。

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

这将解决问题：

dir(module)

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

for i in dir(module): print i

dir(module)是使用脚本或标准解释器时的标准方法，如大多数答案所述。

但是，使用像IPython这样的交互式python shell，您可以使用tab-complete来获取模块中定义的所有对象的概述。这比使用脚本和print来查看模块中定义的内容要方便得多。

module.<tab>将显示模块中定义的所有对象（函数、类等）
module.ClassX.<tab>将向您展示类的方法和属性
module.function_xy?或module.ClassX.method_xy?将显示该函数/方法的文档字符串
module.function_x??或module.SomeClass.method_xy??将显示函数/方法的源代码。

对于全局函数，dir()是要使用的命令（如大多数答案中所述），但是这将公共函数和非公共函数一起列出。

例如运行：

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

返回如下函数/类：

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

其中一些通常不是用于一般编程用途的（而是模块本身，除了像 __doc__ 等 DunderAliases 的情况__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__'
>>>

如果您无法导入所述 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 提供的最小自制版本。

博士

如果您正在运行独立脚本，则希望在 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 任务名称，而不必重复自己。

`./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

你明白了。随着我的项目越来越多地参与其中，使脚本保持最新比使自述文件保持最新更容易，我可以将其抽象为：

./tasks.py install
./tasks.py dev
./tasks.py test
./tasks.py publish
./tasks.py logs

使用 vars(module) 然后使用 inspect.isfunction 过滤掉任何不是函数的内容：

import inspect
import my_module
my_module_functions = [f for f in vars(my_module).values() if inspect.isfunction(f)]

与dir或inspect.getmembers相比，vars 的优势在于它按定义的顺序返回函数，而不是按字母顺序排序。

此外，这将包括由my_module导入的函数，如果您想过滤掉这些函数以仅获取my_module中定义的函数，请参阅我的问题在 Python 模块中获取所有定义的函数。

import sys
from inspect import getmembers, isfunction
fcn_list = [o[0] for o in getmembers(sys.modules[__name__], isfunction)]

您可以使用以下方法从 shell 获取模块中所有函数的列表：

import module

module.*?

除了前面答案中提到的 dir（module）或 help（module），您还可以尝试：
- 打开ipython
- 进口module_name
- 键入module_name，按 Tab。它将打开一个小窗口，列出 python 模块中的所有函数。
它看起来非常整洁。

这是列出哈希库模块所有功能的片段

(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

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（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']

这是"时间"模块包含的函数列表。

这会将

your_module中定义的所有函数附加到列表中。

result=[]
for i in dir(your_module):
    if type(getattr(your_module, i)).__name__ == "function":
        result.append(getattr(your_module, 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）对不同问题的回答改编的代码组合。

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

在当前脚本中查找名称（和可调用对象）`main`

博士

加长版本

`./tasks.py`

相关内容

最新更新

热门标签：

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

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

博士

加长版本

./tasks.py

相关内容

最新更新

热门标签：

在当前脚本中查找名称（和可调用对象）`main`

`./tasks.py`