如何模拟with语句中使用的open(使用Python中的Mock框架)?

时间:2009-08-17 19:26:51

标签: python mocking with-statement

如何使用模拟测试以下代码(使用模拟,修补程序装饰器和Michael Foord's Mock framework提供的标记):

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

10 个答案:

答案 0 :(得分:157)

这些答案中有很多噪音;几乎所有都是正确但过时而不整洁。 mock_openmock框架的一部分,使用起来非常简单。用作上下文的patch返回用于替换已修补的对象的对象:您可以使用它来使您的测试更简单。

Python 3.x

使用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")

Python 2.7

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未使用的每个额外参数都将传递给{ {1}}功能,如patch documentation

中所述
  

patch()接受任意关键字参数。这些将在构造时传递给Mock(或new_callable)。

例如 Python 3.x 的装饰版本是:

new_callable

请记住,在这种情况下,@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") 会将模拟对象添加为测试函数的参数。

答案 1 :(得分:120)

这样做的方法在mock 0.7.0中发生了变化,最终支持模拟python协议方法(魔术方法),特别是使用MagicMock:

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

模拟open作为上下文管理器的示例(来自模拟文档中的示例页面):

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

答案 2 :(得分:66)

使用最新版本的mock,您可以使用真正有用的mock_open帮助程序:

  

mock_open(mock = None,read_data = None)

     

创建一个辅助函数   模拟替换使用open。它适用于直接调用或打开   用作上下文管理器。

     

mock参数是要配置的模拟对象。如果没有(   默认)然后将使用API​​为您创建MagicMock   仅限于标准文件句柄上可用的方法或属性。

     

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

答案 3 :(得分:11)

要将mock_open用于简单文件read()(原始的mock_open代码段already given on this page更适合写入):

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

请注意,根据mock_open的文档,这是专门针对read()的,因此不适用于for line in f等常见模式。

使用python 2.6.6 / mock 1.0.1

答案 4 :(得分:3)

我可能会稍微迟到一下,但是当我在另一个模块中调用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__函数修补到我的mock_open(),我可以模拟写入文件而无需创建文件。

注意:如果您使用的是使用cython的模块,或者您的程序以任何方式依赖于cython,则需要通过在文件顶部加import __builtin__来导入cython's __builtin__ module。如果您使用的是cython,则无法模拟通用__builtin__

答案 5 :(得分:3)

最重要的答案很有用,但我稍微扩展了一下。

如果要根据传递给f的参数设置文件对象的值(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

答案 6 :(得分:0)

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

这适用于读取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):

答案 7 :(得分:0)

如果您不再需要任何文件,则可以装饰测试方法:

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

答案 8 :(得分:0)

源自 github 代码段,用于修补 Python 中的读写功能。

源链接已结束here

import configparser
import pytest

simpleconfig = """[section]\nkey = value\n\n"""

def test_monkeypatch_open_read(mockopen):
    filename = 'somefile.txt'
    mockopen.write(filename, simpleconfig)
 
    parser = configparser.ConfigParser()
    parser.read(filename)
    assert parser.sections() == ['section']
 
def test_monkeypatch_open_write(mockopen):
    parser = configparser.ConfigParser()
    parser.add_section('section')
    parser.set('section', 'key', 'value')
 
    filename = 'somefile.txt'
    parser.write(open(filename, 'wb'))
    assert mockopen.read(filename) == simpleconfig

答案 9 :(得分:-2)

带有断言的简单@patch

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

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