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

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

当前回答

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

其他回答

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

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

我可能对这个游戏有点晚了,但当我在另一个模块中调用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__。

要将mock_open用于一个简单的文件read()(本页上已经给出的原始mock_open片段更适合于write):

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

来自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

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

如果你想根据传递给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