如何在Python 2.x和3.x中使用doctest测试异常？

Question

我SpamException在模块中定义了一个异常类spam.现在我想测试一个spam_function引发此异常的函数.所以我写了下面的doctest.

>>> spam_function()
Traceback (most recent call last):
    ....
SpamException

测试在Python 2.x上成功,但在Python 3.x上测试失败.以下测试适用于Python 3.x.

>>> spam_function()
Traceback (most recent call last):
    ....
spam.SpamException

这里的显着区别是在异常名称中包含模块名称.那么如何编写适用于Python 2.x和3.x的doctest？

Answer 1

>>> spam_function() # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last)
    ...
SpamException: 'lovely spam'

但请注意,IGNORE_EXCEPTION_DETAIL这对普通的异常对象(没有关联的参数)不起作用.特别是,以下示例不能移植到Python 3,因为在异常名称后面没有任何内容:

>>> spam_function() # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last)
    ...
SpamException

只要相关异常类具有返回非空字符串的“__str__”方法，“IGNORE_EXCEPTION_DETAIL”就会起作用。然后，只有这样，最后的异常行才会有一个冒号，这是指令正常工作所必需的。 (2认同)
似乎IGNORE_EXCEPTION_DETAIL也忽略了异常消息，这消除了对这些行为进行文档测试的很大一部分目的。但是仍然检查异常类型。!！ (2认同)