如何使用模拟测试以下代码(使用模拟,Michael Foord的Mock框架提供的补丁装饰器和哨兵):
def testme(filepath):
with open(filepath, 'r') as f:
return f.read()
如何使用模拟测试以下代码(使用模拟,Michael Foord的Mock框架提供的补丁装饰器和哨兵):
def testme(filepath):
with open(filepath, 'r') as f:
return f.read()
Answers:
模拟0.7.0中的更改方式已更改,该模拟最终支持模拟python协议方法(魔术方法),尤其是使用MagicMock:
http://www.voidspace.org.uk/python/mock/magicmock.html
作为上下文管理器打开模拟的示例(来自模拟文档中的示例页面):
>>> open_name = '%s.open' % __name__
>>> with patch(open_name, create=True) as mock_open:
... mock_open.return_value = MagicMock(spec=file)
...
... with open('/some/path', 'w') as f:
... f.write('something')
...
<mock.Mock object at 0x...>
>>> file_handle = mock_open.return_value.__enter__.return_value
>>> file_handle.write.assert_called_with('something')
__enter__
并__exit__
模拟对象-后一种方法过时了还是仍然有用?
file
函数已消失!
mock_open
是mock
框架的一部分,使用非常简单。patch
用作上下文返回用于替换已修补对象的对象:您可以使用它使测试更简单。
使用builtins
代替__builtin__
。
from unittest.mock import patch, mock_open
with patch("builtins.open", mock_open(read_data="data")) as mock_file:
assert open("path/to/open").read() == "data"
mock_file.assert_called_with("path/to/open")
mock
不属于unittest
您,您应该修补__builtin__
from mock import patch, mock_open
with patch("__builtin__.open", mock_open(read_data="data")) as mock_file:
assert open("path/to/open").read() == "data"
mock_file.assert_called_with("path/to/open")
如果将的结果用作的patch
修饰符用作装饰器mock_open()
,则new
patch
可能会有些奇怪。
在这种情况下,最好使用new_callable
patch
的参数并要记住,每个patch
不使用的额外参数都会按照文档中的new_callable
描述传递给函数。patch
patch()使用任意关键字参数。这些将在构造时传递给Mock(或new_callable)。
例如,Python 3.x的修饰版本为:
@patch("builtins.open", new_callable=mock_open, read_data="data")
def test_patch(mock_file):
assert open("path/to/open").read() == "data"
mock_file.assert_called_with("path/to/open")
请记住,在这种情况下,patch
会将模拟对象添加为测试函数的参数。
with patch("builtins.open", mock_open(read_data="data")) as mock_file:
其转换为装饰器语法吗?我已经尝试过,但是我不确定@patch("builtins.open", ...)
第二个论点需要传递什么。
return_value
的mock_open
到另一个模拟对象,并断言第二模拟的return_value
),但它的工作,加入mock_open
作为new_callable
。
six
模块是否具有一致的mock
模块。但是我不知道它是否也映射builtins
在一个通用模块中。
使用最新版本的模拟,您可以使用真正有用的模拟_打开帮助器:
mock_open(模拟=无,读取数据=无)
一个辅助函数创建一个模拟来代替open的使用。它适用于直接调用或用作上下文管理器的open。
模拟参数是要配置的模拟对象。如果没有(默认),则将为您创建一个MagicMock,其API限于标准文件句柄上可用的方法或属性。
read_data是用于返回文件句柄的read方法的字符串。默认情况下,这是一个空字符串。
>>> from mock import mock_open, patch
>>> m = mock_open()
>>> with patch('{}.open'.format(__name__), m, create=True):
... with open('foo', 'w') as h:
... h.write('some stuff')
>>> m.assert_called_once_with('foo', 'w')
>>> handle = m()
>>> handle.write.assert_called_once_with('some stuff')
.write
通话?
handle.write.assert_any_call()
。handle.write.call_args_list
如果顺序很重要,您还可以使用来获取每个呼叫。
m.return_value.write.assert_called_once_with('some stuff')
更好的imo。避免注册电话。
Mock.call_args_list
比调用任何Mock.assert_xxx
方法更安全。如果您拼写的后者(作为Mock的属性)的拼写错误,它们将始终默默地通过。
要对一个简单文件使用嘲笑read()
(打开)(此页面上已经给出的原始嘲笑的片段更适合写入):
my_text = "some text to return when read() is called on the file object"
mocked_open_function = mock.mock_open(read_data=my_text)
with mock.patch("__builtin__.open", mocked_open_function):
with open("any_string") as f:
print f.read()
请注意,根据嘲笑文档的doc,这是专门针对的read()
,因此不适for line in f
用于像这样的常见模式。
使用python 2.6.6 /模拟1.0.1
for line in opened_file:
代码类型一起使用。我尝试__iter__
使用实现的可迭代StringIO进行实验,并使用它代替my_text
,但是没有运气。
read()
您的for line in opened_file
情况;我已编辑帖子以澄清
with open("any_string") as f: print f.read()
最佳答案很有用,但我对此进行了扩展。
如果要基于传递给此处的参数设置文件对象(f
in as f
)的值,open()
这是一种实现方法:
def save_arg_return_data(*args, **kwargs):
mm = MagicMock(spec=file)
mm.__enter__.return_value = do_something_with_data(*args, **kwargs)
return mm
m = MagicMock()
m.side_effect = save_arg_return_array_of_data
# if your open() call is in the file mymodule.animals
# use mymodule.animals as name_of_called_file
open_name = '%s.open' % name_of_called_file
with patch(open_name, m, create=True):
#do testing here
基本上,open()
将返回一个对象并with
调用__enter__()
该对象。
为了正确模拟,我们必须模拟open()
返回一个模拟对象。然后,该模拟对象应该模拟对其的__enter__()
调用(MagicMock
将为我们执行此操作),以返回我们想要的模拟数据/文件对象(因此mm.__enter__.return_value
)。通过上面的方法使用2个模拟进行此操作,我们可以捕获传递给参数的参数open()
并将其传递给我们的do_something_with_data
方法。
我将整个模拟文件作为字符串传递给了open()
我,do_something_with_data
如下所示:
def do_something_with_data(*args, **kwargs):
return args[0].split("\n")
这会将字符串转换为列表,因此您可以像处理普通文件一样执行以下操作:
for line in file:
#do action
__enter__
吗?绝对看起来像是骇客,而不是推荐的方式。
我可能对游戏有些迟了,但是当我调用open
另一个模块而不必创建新文件时,这对我有用。
test.py
import unittest
from mock import Mock, patch, mock_open
from MyObj import MyObj
class TestObj(unittest.TestCase):
open_ = mock_open()
with patch.object(__builtin__, "open", open_):
ref = MyObj()
ref.save("myfile.txt")
assert open_.call_args_list == [call("myfile.txt", "wb")]
MyObj.py
class MyObj(object):
def save(self, filename):
with open(filename, "wb") as f:
f.write("sample text")
通过open
将__builtin__
模块内部的功能修补到my mock_open()
,可以模拟写入文件而无需创建文件。
注意:如果您正在使用使用cython的模块,或者您的程序以任何方式依赖cython,则需要通过在文件顶部包含来导入cython的__builtin__
模块import __builtin__
。__builtin__
如果您使用cython,则将无法模拟通用。
import __builtin__
到我的测试模块中。本文有助于阐明该技术为何能发挥出色的作用:ichimonji10.name/blog/6
这适用于读取json配置的补丁。
class ObjectUnderTest:
def __init__(self, filename: str):
with open(filename, 'r') as f:
dict_content = json.load(f)
模拟对象是open()函数返回的io.TextIOWrapper对象。
@patch("<src.where.object.is.used>.open",
return_value=io.TextIOWrapper(io.BufferedReader(io.BytesIO(b'{"test_key": "test_value"}'))))
def test_object_function_under_test(self, mocker):