如何用unittest.mock测试下面的代码:

def testme(filepath):
    with open(filepath) as f:
        return f.read()

当前回答

如果你不需要进一步的文件,你可以装饰测试方法:

@patch('builtins.open', mock_open(read_data="data"))
def test_testme():
    result = testeme()
    assert result == "data"

其他回答

使用assert简单的@patch

如果你想使用@patch。open()在处理程序内部被调用并被读取。

    @patch("builtins.open", new_callable=mock_open, read_data="data")
    def test_lambda_handler(self, mock_open_file):
        
        lambda_handler(event, {})

使用unittest修补内置的open()函数:

这适用于补丁读取json配置。

class ObjectUnderTest:
    def __init__(self, filename: str):
        with open(filename, 'r') as f:
            dict_content = json.load(f)

被模拟的对象是io。由open()函数返回的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):

上面的答案很有用,但我对它进行了一些扩展。

如果你想根据传递给open()的参数来设置文件对象的值(f in as f),这里有一种方法:

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__()。

为了正确地模拟,必须mock open()返回一个模拟对象。然后,该模拟对象应该模拟对其进行的__enter__()调用(MagicMock将为我们完成此操作),以返回我们想要的模拟数据/文件对象(因此是mm.__enter__.return_value)。用上述方法对2个mock执行此操作允许我们捕获传递给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

这样做的方式在mock 0.7.0中已经改变,它最终支持模拟python协议方法(magic方法),特别是使用MagicMock:

http://www.voidspace.org.uk/python/mock/magicmock.html

一个作为上下文管理器打开的mock示例(来自mock文档中的示例页面):

>>> 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')

在mock的最新版本中,你可以使用真正有用的mock_open helper:

mock_open(模拟= None, read_data =没有) 对象的帮助函数 用Mock代替open。它适用于open call direct或 用作上下文管理器。 mock参数是要配置的模拟对象。若无( 默认),然后将为您创建一个MagicMock,使用API 仅限于标准文件句柄上可用的方法或属性。 Read_data是文件句柄的读取方法的字符串 回报。默认情况下,这是一个空字符串。

>>> 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')