如何测试 function 呼叫范围是否在 python 内？

Question

我是 Python 讲师，我想给我的学生一个任务：编写一个 function，使用 for 循环计算列表的平均值，范围为 object。

我想对他们的 function 进行测试，看看它是否实际使用范围 object。我该怎么做？

它应该是这样的：

def avg(L):
    Pass

def test_range(avg):
    ...

如果avg包含range ，那么test_range应该返回True 。

我尝试了利用func_code的解决方案，但显然range没有。

Answer 1

您可以使用 Python 的unittest.mock模块从builtins模块环绕range function，然后让您的测试断言环绕的range确实被调用了。

例如，使用 Python 的unittest框架编写测试：

import builtins
import unittest
from unittest.mock import patch

# I don't know what L is supposed to be, and I know that there 
# are better ways to compute average of a list, but the code
# for calculating the average is not important for this question.
def avg(L):
    total = 0
    for index in range(len(L)):
        total += L[index]
    return total / len(L)

class TestAverage(unittest.TestCase):
    def test_avg(self):
        with patch("builtins.range", wraps=builtins.range) as wrapped_patch:
            expected = 47
            actual = avg([1,49,91])
            self.assertEqual(expected, actual)
        wrapped_patch.assert_called()

if __name__ == '__main__':
    unittest.main()

$ python -m unittest -v main.py
test_avg (main.TestAverage) ... ok

----------------------------------------------------------------------
Ran 1 test in 0.001s

OK

它使用unittest.mock的针对 builtins.range builtins.range的patch 。通常， patch用于测试以替换目标的行为和/或返回值，但在这种情况下，您可以传递wraps=builtins.range （这被传递给底层的Mock对象），这意味着“我只想监视调用，但不想修改它的行为”：

wraps ：用于模拟 object 包装的项目。 如果wraps不是None那么调用 Mock 会将调用传递给包装的 object（返回真实结果）。

通过将其包装在Mock object 中，您可以使用Mock的任何断言函数来检查对range的调用，例如assert_called检查目标是否至少被调用一次。 您可以通过断言调用range的次数来更具体：

self.assertTrue(wrapped_patch.call_count == 1)

如果根本不调用断言，断言就会失败：

# Here, `range` wasn't used at all.
def avg(L):
    return sum(L) / len(L)

class TestAverage(unittest.TestCase):
    # same as the code above

$ python -m unittest -v main.py
test_avg (main.TestAverage) ... FAIL

======================================================================
FAIL: test_avg (main.TestAverage)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/path/to/main.py", line 15, in test_avg
    wrapped_patch.assert_called()
  File "/usr/local/Cellar/python@3.10/3.10.8/Frameworks/Python.framework/Versions/3.10/lib/python3.10/unittest/mock.py", line 888, in assert_called
    raise AssertionError(msg)
AssertionError: Expected 'range' to have been called.

使用patch时要注意的最重要的事情是要确切地知道在哪里打补丁。 在这种情况下，您可以查看文档或使用__module__来了解range的模块：

>>> range
<class 'range'>
>>> range.__module__
'builtins'

但是测试有点幼稚，因为即使avg没有真正使用range ，它仍然可以通过：

def avg(L):
    range(len(L))  # Called but really unused. Sneaky!
    return sum(L) / len(L)

class TestAverage(unittest.TestCase):
    # same as the code above

$ python -m unittest -v main.py
test_avg (main.TestAverage) ... ok

----------------------------------------------------------------------
Ran 1 test in 0.001s

OK

一个稍微令人困惑的解决方法是“打破” range的测试，如果 function真的使用range ，那么它将不再起作用：

def avg(L):
    range(len(L))  # Called but really unused. Sneaky!
    return sum(L) / len(L)

class TestAverage(unittest.TestCase):
    def test_avg(self):
        # same as above

    def test_avg_is_really_using_range(self):
        L = [10,20,90]
        # Is it returning the correct result?
        self.assertEqual(avg(L), 40)

        # OK, but did it really use `range`?
        # Let's try breaking `range` so it always yields 0,
        # so we expect the return value to be *different*
        with patch("builtins.range", return_value=[0,0,0]):
            self.assertNotEqual(avg(L), 40)

因此，如果avg偷偷调用但没有真正使用range ，那么test_avg_is_really_using_range现在会失败，因为即使range被破坏， avg仍然会产生正确的值：

$ python -m unittest -v main.py
test_avg (main.TestAverage) ... ok
test_avg_really_using_range (main.TestAverage) ... FAIL

======================================================================
FAIL: test_avg_really_using_range (main.TestAverage)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/path/to/main.py", line 19, in test_avg_really_using_range
    self.assertNotEqual(avg(L), 40)
AssertionError: 40.0 == 40

最后，作为旁注，我在所有示例中都使用了assertEqual ，因为返回值的测试不是重点，但请务必阅读断言可能的浮点值的正确方法，例如。 如何对浮点输出执行单元测试？ - python