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

Question

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

我知道例如os.makedirs(path[, mode])可以提出PermissionError(也许是其他人),但文档只提到OSError.(这只是一个例子 - 可能甚至是一个坏的;我对这个功能并不特别感兴趣 - 一般来说问题更多).

有没有一种编程方法可以在没有/文档记录不足时找到所有可能的异常？这可能在第三方库和未附带Python源代码的库中特别有用.

" Python:如何知道可能从方法调用中抛出哪些异常 "中提供的解决方案在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或其子类之一).这是类层次结构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模块的功能和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编写的函数.