python中单元测试的局部变量以验证测试函数的功能

Question

我是单元测试和 python 的新手。我开始在 python 中对不同的模块（用 c 开发）进行单元测试。在某些情况下，我发现该函数不会返回任何值并且不会修改任何全局变量的值。在这种情况下，我将如何根据一些局部变量值验证函数的功能。由于 local 在函数外部不可用，我无法验证局部变量的值。单元测试这些功能的正确方法应该是什么？我已经浏览了下面的链接来询问这个问题，它说我们不应该对局部变量执行单元测试。

Answer 1

在 python 中没有“开箱即用”的解决方案，尽管我坚信在开发更高级的测试时能够模拟和检查局部变量发生的情况非常重要。我已经用一个新类来模拟一个函数并获取本地值，我希望它对你有所帮助。

import inspect

from textwrap import dedent

import re

class MockFunction:

    """ Defines a Mock for functions to explore the details on their execution.

    """

    def __init__(self, func):

        self.func = func

    def __call__(mock_instance, *args, **kwargs):

        # Add locals() to function's return

        code = re.sub('[\\s]return\\b', ' return locals(), ', dedent(

            inspect.getsource(mock_instance.func)))

        code = code + f'\nloc, ret = {mock_instance.func.__name__}(*args, **kwargs)'

        loc = {'args': args, 'kwargs': kwargs}

        exec(code, mock_instance.func.__globals__, loc)

        # Put execution locals into mock instance

        for l,v in loc['loc'].items():

            setattr(mock_instance, l, v)

        return loc['ret']

要使用它：

import unittest

from unittest import mock

# This is the function you would like to test. It can be defined somewhere else

def foo(param_a, param_b=10):

    param_a = f'Hey {param_a}'  # Local only

    param_b += 20  # Local only 

    return 'bar'

# Define a test to validate what happens to local variables when you call that function

class SimpleTest(unittest.TestCase):

    @mock.patch(f'{__name__}.foo', autospec=True, side_effect=MockFunction(foo))

    def test_foo_return_and_local_params_values(self, mocked):

        ret = foo('A')

        self.assertEqual('Hey A', mocked.side_effect.param_a)

        self.assertEqual(30, mocked.side_effect.param_b)

        self.assertEqual('bar', ret)

正如我们所见，您可以使用模拟函数中的 side_effect 检查局部变量发生了什么。