如何模拟 with 语句中使用的 open（使用 Python 中的 Mock 框架）？

Question

如何使用 unittest.mock< 测试以下代码/a>：

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

Answer 1

Python 3

补丁 builtins.open 并使用 mock_open，它是模拟框架。 补丁用作上下文管理器 返回用于替换修补后的对象：

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

如果您想使用 patch 作为装饰器，请使用 mock_open() 的结果作为 patch<的 new= 参数/code> 可能有点奇怪。相反，请使用 patch 的 new_callable= 参数，并记住 patch 不使用的每个额外参数都将传递给 new_callable 函数，如 patch文档：

patch() 接受任意关键字参数。这些将在构造时传递给Mock（或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")

请记住，在这种情况下，patch 会将模拟对象作为参数传递给您的测试函数。

Python 2

您需要修补 __builtin__.open 而不是 builtins.open 并且 mock 不是 unittest 的一部分，您需要 pip install 并单独导入它：

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

Answer 2

做到这一点的方法在mock 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')

Answer 3

使用最新版本的mock，您可以使用真正有用的mock_open 帮助器：

mock_open(mock=None, read_data=None)

用于创建的辅助函数
使用mock来代替open。它适用于直接开放呼叫或
用作上下文管理器。

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

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

Answer 4

要使用 mock_open 来创建简单文件读取() （原始的mock_open代码段已在此页面上给出更适合写入）：

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 / 模拟 1.0.1

Answer 5

如果您不再需要任何文件，您可以装饰测试方法：

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

Answer 6

最上面的答案很有用，但我对其进行了一些扩展。

如果您想根据传递给 open() 的参数设置文件对象的值（as f 中的 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__()。

为了正确模拟，我们必须模拟 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

Answer 7

我可能有点晚了，但是当我在另一个模块中调用 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")

通过将 __builtin__ 模块内的 open 函数修补到我的 mock_open()，我可以模拟写入文件，而无需创建一个。

注意：如果您使用的模块使用 cython，或者您的程序以任何方式依赖于 cython，则需要导入 cython 的 __builtin__ 模块，方法是在文件顶部包含 import __builtin__ 。如果您使用 cython，您将无法模拟通用 __builtin__。

Answer 8

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

Answer 9

在我的例子中，我使用的是 pytest，好消息是在 Python 3 中，unittest 库也可以毫无问题地导入和使用。

这是我的方法。首先，我创建一个包含可重用 pytest 固定装置的 conftest.py 文件：

from functools import cache
from unittest.mock import MagicMock, mock_open

import pytest
from pytest_mock import MockerFixture


class FileMock(MagicMock):

    def __init__(self, mocker: MagicMock = None, **kwargs):
        super().__init__(**kwargs)

        if mocker:
            self.__dict__ = mocker.__dict__
            # configure mock object to replace the use of open(...)
            # note: this is useful in scenarios where data is written out
            _ = mock_open(mock=self)

    @property
    def read_data(self):
        return self.side_effect

    @read_data.setter
    def read_data(self, mock_data: str):
        """set mock data to be returned when `open(...).read()` is called."""
        self.side_effect = mock_open(read_data=mock_data)

    @property
    @cache
    def write_calls(self):
        """a list of calls made to `open().write(...)`"""
        handle = self.return_value
        write: MagicMock = handle.write
        return write.call_args_list

    @property
    def write_lines(self) -> str:
        """a list of written lines (as a string)"""
        return ''.join([c[0][0] for c in self.write_calls])


@pytest.fixture
def mock_file_open(mocker: MockerFixture) -> FileMock:
    return FileMock(mocker.patch('builtins.open'))

我决定将 read_data 作为属性，以便更加 Pythonic。它可以在测试函数中与 open() 需要返回的任何数据一起分配。

在我的测试文件中，名称类似于 test_it_works.py，我有一个以下测试用例来确认预期的功能：

from unittest.mock import call


def test_mock_file_open_and_read(mock_file_open):
    mock_file_open.read_data = 'hello\nworld!'

    with open('/my/file/here', 'r') as in_file:
        assert in_file.readlines() == ['hello\n', 'world!']

    mock_file_open.assert_called_with('/my/file/here', 'r')


def test_mock_file_open_and_write(mock_file_open):
    with open('/out/file/here', 'w') as f:
        f.write('hello\n')
        f.write('world!\n')
        f.write('--> testing 123 :-)')

    mock_file_open.assert_called_with('/out/file/here', 'w')

    assert call('world!\n') in mock_file_open.write_calls

    assert mock_file_open.write_lines == """\
hello
world!
--> testing 123 :-)
""".rstrip()

查看要点 此处。

Answer 10

源自 github 代码片段，用于修补 python 中的读写功能。

源链接位于此处

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

Answer 11

带有断言的简单@patch

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

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