14.2 在单元测试中给对象打补丁

    函数可被用来解决这个问题。patch() 还可被用作一个装饰器、上下文管理器或单独使用,尽管并不常见。例如,下面是一个将它当做装饰器使用的例子:

    它还可以被当做一个上下文管理器:

    1. with patch('example.func') as mock_func:
    2. example.func(x) # Uses patched example.func
    3. mock_func.assert_called_with(x)

    最后,你还可以手动的使用它打补丁:

    1. p = patch('example.func')
    2. mock_func = p.start()
    3. example.func(x)
    4. mock_func.assert_called_with(x)
    5. p.stop()

    如果可能的话,你能够叠加装饰器和上下文管理器来给多个对象打补丁。例如:

    patch() 接受一个已存在对象的全路径名,将其替换为一个新的值。原来的值会在装饰器函数或上下文管理器完成后自动恢复回来。默认情况下,所有值会被 MagicMock 实例替代。例如:

    1. >>> x = 42
    2. >>> with patch('__main__.x'):
    3. ... print(x)
    4. ...
    5. <MagicMock name='x' id='4314230032'>
    6. >>> x
    7. 42
    8. >>>

    不过,你可以通过给 patch() 提供第二个参数来将值替换成任何你想要的:

    1. >>> x
    2. >>> with patch('__main__.x', 'patched_value'):
    3. ... print(x)
    4. ...
    5. patched_value
    6. >>> x
    7. 42
    8. >>>

    被用来作为替换值的 实例能够模拟可调用对象和实例。他们记录对象的使用信息并允许你执行断言检查,例如:

    1. # example.py
    2. from urllib.request import urlopen
    3. import csv
    4.  
    5. def dowprices():
    6. u = urlopen('http://finance.yahoo.com/d/quotes.csv?s=@^DJI&f=sl1')
    7. lines = (line.decode('utf-8') for line in u)
    8. rows = (row for row in csv.reader(lines) if len(row) == 2)
    9. prices = { name:float(price) for name, price in rows }
    10. return prices

    正常来讲,这个函数会使用 urlopen() 从Web上面获取数据并解析它。在单元测试中,你可以给它一个预先定义好的数据集。下面是使用补丁操作的例子:

    1. import unittest
    2. from unittest.mock import patch
    3. import io
    4.  
    5. sample_data = io.BytesIO(b'''\
    6. "IBM",91.1\r
    7. "AA",13.25\r
    8. "MSFT",27.72\r
    9. \r
    10. ''')
    11.  
    12. class Tests(unittest.TestCase):
    13. @patch('example.urlopen', return_value=sample_data)
    14. def test_dowprices(self, mock_urlopen):
    15. p = example.dowprices()
    16. self.assertTrue(mock_urlopen.called)
    17. self.assertEqual(p,
    18. {'IBM': 91.1,
    19. 'AA': 13.25,
    20. 'MSFT' : 27.72})
    21.  
    22. if __name__ == '__main__':
    23. unittest.main()

    本例中,位于 example 模块中的 urlopen() 函数被一个模拟对象替代,该对象会返回一个包含测试数据的 ByteIO().

    还有一点,在打补丁时我们使用了 来代替 urllib.request.urlopen 。当你创建补丁的时候,你必须使用它们在测试代码中的名称。由于测试代码使用了 from urllib.request import urlopen ,那么 dowprices() 函数中使用的 urlopen() 函数实际上就位于 模块了。

    本节实际上只是对 unittest.mock 模块的一次浅尝辄止。更多更高级的特性,请参考