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

StackOverflow https://stackoverflow.com/questions/1289894

  •  18-09-2019
  •  | 
  •  

题

如何使用模拟测试以下代码（使用模拟、补丁装饰器和哨兵提供） Michael Food 的 Mock 框架):

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

其他提示

这些答案中有很多噪音；几乎所有内容都是正确的，但已经过时且不整洁。 mock_open 是其一部分 mock 框架，使用起来非常简单。 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 不使用将传递给 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 将添加模拟对象作为测试函数的参数。

通过模拟的最新版本，你可以使用真正有用的 mock_open 助手：

  

<强> mock_open（模拟=无，的read_data =无）

     

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

     

在模拟参数是模拟对象进行配置。如果无（   默认情况下），那么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')

要使用 mock_open 以一个简单的文件read()（原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

我可能会有点晚了比赛，但这个调用另一个模块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模块，您将需要导入的用Cython的__builtin__模块由包括import __builtin__在你的文件的顶部的。您将无法如果您使用用Cython嘲笑通用__builtin__。

顶部的答案是有用的，但我扩大一下就可以了。

如果您想设置基于传递给这里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()返回一个模拟对象。那么mock对象应该嘲笑它的__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
许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top