如何列出函数在 Python 3 中可能引发的所有异常？

Question

是否有一种编程方式来获取函数可能引发的所有异常的列表？

例如，我知道os.makedirs(path[, mode]) 可以提高PermissionError（可能还有其他人），但文档只提到OSError。 （这只是一个例子——甚至可能是一个糟糕的例子；我对这个功能不是特别感兴趣——更多的是一般的问题）。

是否有一种编程方式可以在没有/记录不充分的情况下找到所有可能的异常？这在 3rd 方库和不附带 Python 源代码的库中可能特别有用。

“Python: How can I know which exceptions might be thrown from a method call”中提出的解决方案在 Python 3 中不起作用；没有compiler 包。

Answer 1

对于某些（如果不是大多数）功能，您无法获得可靠的结果。一些例子：

• 执行任意代码的函数（例如exec(')(rorrEeulaV esiar'[::-1])引发ValueError）

• 不是用 Python 编写的函数

• 调用其他函数的函数可以将错误传播给调用者

• 函数在except: 块中重新引发活动异常

很遗憾，此列表不完整。

例如os.makedirs 是用 Python 编写的，你可以看到它的源代码：

...
try:
    mkdir(name, mode)
except OSError as e:
    if not exist_ok or e.errno != errno.EEXIST or not path.isdir(name):
        raise

Bare raise 重新引发最后一个活动异常（OSError 或其子类之一）。这是class hierarchy for OSError：

+-- OSError
|    +-- BlockingIOError
|    +-- ChildProcessError
|    +-- ConnectionError
|    |    +-- BrokenPipeError
|    |    +-- ConnectionAbortedError
|    |    +-- ConnectionRefusedError
|    |    +-- ConnectionResetError
|    +-- FileExistsError
|    +-- FileNotFoundError
|    +-- InterruptedError
|    +-- IsADirectoryError
|    +-- NotADirectoryError
|    +-- PermissionError
|    +-- ProcessLookupError
|    +-- TimeoutError

要获得确切的异常类型，您需要查看 mkdir、它调用的函数、这些函数调用的函数等。

因此，在不运行函数的情况下获得可能的异常是非常困难，你真的不应该这样做。

---

但是对于像这样的简单情况

raise Exception # without arguments
raise Exception('abc') # with arguments

ast module 功能和inspect.getclosurevars（用于获取异常类，在 Python 3.3 中引入）的组合可以产生相当准确的结果：

from inspect import getclosurevars, getsource
from collections import ChainMap
from textwrap import dedent
import ast, os

class MyException(Exception):
    pass

def g():
    raise Exception

class A():
    def method():
        raise OSError

def f(x):
    int()
    A.method()
    os.makedirs()
    g()
    raise MyException
    raise ValueError('argument')


def get_exceptions(func, ids=set()):
    try:
        vars = ChainMap(*getclosurevars(func)[:3])
        source = dedent(getsource(func))
    except TypeError:
        return

    class _visitor(ast.NodeTransformer):
        def __init__(self):
            self.nodes = []
            self.other = []

        def visit_Raise(self, n):
            self.nodes.append(n.exc)

        def visit_Expr(self, n):
            if not isinstance(n.value, ast.Call):
                return
            c, ob = n.value.func, None
            if isinstance(c, ast.Attribute):
                parts = []
                while getattr(c, 'value', None):
                    parts.append(c.attr)
                    c = c.value
                if c.id in vars:
                    ob = vars[c.id]
                    for name in reversed(parts):
                        ob = getattr(ob, name)

            elif isinstance(c, ast.Name):
                if c.id in vars:
                    ob = vars[c.id]

            if ob is not None and id(ob) not in ids:
                self.other.append(ob)
                ids.add(id(ob))

    v = _visitor()
    v.visit(ast.parse(source))
    for n in v.nodes:
        if isinstance(n, (ast.Call, ast.Name)):
            name = n.id if isinstance(n, ast.Name) else n.func.id
            if name in vars:
                yield vars[name]

    for o in v.other:
        yield from get_exceptions(o)


for e in get_exceptions(f):
    print(e)

打印

<class '__main__.MyException'>
<class 'ValueError'>
<class 'OSError'>
<class 'Exception'>

请记住，此代码仅适用于用 Python 编写的函数。

Answer 2

在非内置源代码中发现异常：

正如主题Python: How can I know which exceptions might be thrown from a method call 中所说，您可以获取抽象语法树并搜索引发的异常。

import ast

def find_raise(body):
    raises = []
    for ast_ in body:
        if isinstance(ast_, ast.Raise):
            raises.append(ast_)
        if hasattr(ast_, 'body'):
            raises += find_raise(ast_.body)
    return list(set(raises))


test = '''
def f(arg):
    raise OSError(arg)
'''

raises = find_raise(ast.parse(test).body)
print [i.type.func.id for i in raises] # print ['OSError']

此方法适用于您编写的每一段代码。

---

在内置方法中查找异常

你不能解析像os.makedirs这样的内置函数。

两种选择：

• 您可以查看包含在您的 Python 发行版中的测试 (ex with cpython)
• 如果你的目标方法提供了python源代码，你可以像以前一样解析它（代码在/usr/lib/python3/*.py）

对于所有本机 C 方法，您都受困于文档并且应该信任它。当os.makedirs 说它只返回OSError 时，这是真的，因为PermissionError 和FileExistError 异常是OSError 的子类。

要以编程方式查找内置错误，您可以使用以下示例：

>>> import re
>>> re.findall(r'\w+Error', open.__doc__)
['IOError', 'FileExistsError', 'ValueError']
>>> re.findall(r'\w+Error', os.makedirs.__doc__)
['OSError']

它捕获所有名称以“Error”结尾的异常，它当然可以扩展以查找所有标准异常。