如何为未捕获的异常处理程序编写单元测试

Question

我有一个捕捉未捕获异常的函数，如下所示。有没有办法写一个单元测试，执行uncaught_exception_handler()函数，但正常退出测试？

import logging

def config_logger():
    # logger setup here

def init_uncaught_exception_logger(logger):
    '''Setup an exception handler to log uncaught exceptions.

    This is typically called once per main executable.
    This function only exists to provide a logger context to the nested function.

    Args:
        logger (Logger): The logger object to log uncaught exceptions with.
    '''
    def uncaught_exception_handler(*exc_args):
        '''Log uncaught exceptions with logger.

        Args:
            exc_args: exception type, value, and traceback
        '''
        print("Triggered uncaught_exception_handler")
        logger.error("uncaught: {}: {}\n{}".format(*exc_args))

    sys.excepthook = uncaught_exception_handler

if __name__ == '__main__':
    LOGGER = config_logger()
    init_uncaught_exception_logger(LOGGER)
    raise Exception("This is an intentional uncaught exception")

Answer 1

与其测试您的函数是否因未捕获的异常而被调用，不如测试excepthook 是否已安装，并且当您手动调用该函数时该函数是否正确。这为您提供了很好的证据，证明excepthook 在实际使用中会正常运行。您需要将 uncaught_exception_handler 移到 init_uncaught_exception_logger 之外，以便您的测试可以更轻松地访问它。

assert sys.excepthook is uncaught_exception_handler
with your_preferred_output_capture_mechanism:
    try:
        1/0
    except ZeroDivisionError:
        uncaught_exception_handler(*sys.exc_info())
assert_something_about_captured_output()

如果您想通过未捕获的异常实际调用excepthook，那么您需要启动一个子进程并检查其输出。 subprocess module 是实现这一目标的方法。

Answer 2

为了编写有关引发异常的断言，您可以使用pytest.raises 作为上下文管理器，如下所示：

with raises(expected_exception: Exception[, match][, message])

import pytest

def test_which_will_raise_exception():
    with pytest.raises(Exception):
        # Your function to test.

现在，只有在 pytest.raises 上下文管理器下的任何代码将引发作为参数提供的异常时，此单元测试才会通过。在这种情况下，它是Exception。