Python如何在单元测试中给对象打补丁

2023-07-19 10:05:03 151

问题

你写的单元测试中需要给指定的对象打补丁，用来断言它们在测试中的期望行为（比如，断言被调用时的参数个数，访问指定的属性等）。

解决方案

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

fromunittest.mockimportpatch
importexample

@patch('example.func')
deftest1(x,mock_func):
example.func(x)#Usespatchedexample.func
mock_func.assert_called_with(x)

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

withpatch('example.func')asmock_func:
example.func(x)#Usespatchedexample.func
mock_func.assert_called_with(x)

最后，你还可以手动的使用它打补丁：

p=patch('example.func')
mock_func=p.start()
example.func(x)
mock_func.assert_called_with(x)
p.stop()

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

@patch('example.func1')
@patch('example.func2')
@patch('example.func3')
deftest1(mock1,mock2,mock3):
...

deftest2():
withpatch('example.patch1')asmock1,\
patch('example.patch2')asmock2,\
patch('example.patch3')asmock3:
...

讨论

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

>>>x=42
>>>withpatch('__main__.x'):
...print(x)
...

>>>x
42
>>>

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

>>>x
42
>>>withpatch('__main__.x','patched_value'):
...print(x)
...
patched_value
>>>x
42
>>>

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

>>>fromunittest.mockimportMagicMock
>>>m=MagicMock(return_value=10)
>>>m(1,2,debug=True)
10
>>>m.assert_called_with(1,2,debug=True)
>>>m.assert_called_with(1,2)
Traceback(mostrecentcalllast):
File"",line1,in
File".../unittest/mock.py",line726,inassert_called_with
raiseAssertionError(msg)
AssertionError:Expectedcall:mock(1,2)
Actualcall:mock(1,2,debug=True)
>>>

>>>m.upper.return_value='HELLO'
>>>m.upper('hello')
'HELLO'
>>>assertm.upper.called

>>>m.split.return_value=['hello','world']
>>>m.split('helloworld')
['hello','world']
>>>m.split.assert_called_with('helloworld')
>>>

>>>m['blah']

>>>m.__getitem__.called
True
>>>m.__getitem__.assert_called_with('blah')
>>>

一般来讲，这些操作会在一个单元测试中完成。例如，假设你已经有了像下面这样的函数：

#example.py
fromurllib.requestimporturlopen
importcsv

defdowprices():
u=urlopen('http://finance.yahoo.com/d/quotes.csv?s=@^DJI&f=sl1')
lines=(line.decode('utf-8')forlineinu)
rows=(rowforrowincsv.reader(lines)iflen(row)==2)
prices={name:float(price)forname,priceinrows}
returnprices

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

importunittest
fromunittest.mockimportpatch
importio
importexample

sample_data=io.BytesIO(b'''\
"IBM",91.1\r
"AA",13.25\r
"MSFT",27.72\r
\r
''')

classTests(unittest.TestCase):
@patch('example.urlopen',return_value=sample_data)
deftest_dowprices(self,mock_urlopen):
p=example.dowprices()
self.assertTrue(mock_urlopen.called)
self.assertEqual(p,
{'IBM':91.1,
'AA':13.25,
'MSFT':27.72})

if__name__=='__main__':
unittest.main()

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

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

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

以上就是Python如何在单元测试中给对象打补丁的详细内容，更多关于Python单元测试的资料请关注毛票票其它相关文章！

Python如何在单元测试中给对象打补丁

热门推荐

随机推荐