自定义unittest.mock.mock_open以进行迭代

Question

我应该如何自定义unittest.mock.mock_open来处理此代码？

file: impexpdemo.py
def import_register(register_fn):
    with open(register_fn) as f:
        return [line for line in f]

我第一次尝试read_data。

class TestByteOrderMark1(unittest.TestCase):
    REGISTER_FN = 'test_dummy_path'
    TEST_TEXT = ['test text 1\n', 'test text 2\n']

    def test_byte_order_mark_absent(self):
        m = unittest.mock.mock_open(read_data=self.TEST_TEXT)
        with unittest.mock.patch('builtins.open', m):
            result = impexpdemo.import_register(self.REGISTER_FN)
            self.assertEqual(result, self.TEST_TEXT)

这失败了，大概是因为代码不使用read，readline或readlines。unittest.mock.mock_open的文档说：“
read_data是一个字符串，供文件句柄的read（），readline（）和readlines（）方法返回。对这些方法的调用将从read_data中获取数据，直到耗尽为止这些方法的模拟非常简单。如果您需要更多控制要提供给测试代码的数据，则需要为您自己定制此模拟。read_data默认为空字符串。”

由于文件没有给出暗示什么样的定制将需要我试过return_value和side_effect。两者都不起作用。

class TestByteOrderMark2(unittest.TestCase):
    REGISTER_FN = 'test_dummy_path'
    TEST_TEXT = ['test text 1\n', 'test text 2\n']

    def test_byte_order_mark_absent(self):
        m = unittest.mock.mock_open()
        m().side_effect = self.TEST_TEXT
        with unittest.mock.patch('builtins.open', m):
            result = impexpdemo.import_register(self.REGISTER_FN)
            self.assertEqual(result, self.TEST_TEXT)

Answer 1

该mock_open()对象确实不实现迭代。

如果未将文件对象用作上下文管理器，则可以使用：

m = unittest.mock.MagicMock(name='open', spec=open)
m.return_value = iter(self.TEST_TEXT)

with unittest.mock.patch('builtins.open', m):

现在open()返回一个迭代器，可以像文件对象一样直接对其进行迭代，并且还可以使用next()。但是，它不能用作上下文管理器。

您可以将其与结合起来，mock_open()然后在返回值上提供__iter__and__next__方法，并获得额外的好处，这mock_open()也增加了用作上下文管理器的先决条件：

# Note: read_data must be a string!
m = unittest.mock.mock_open(read_data=''.join(self.TEST_TEXT))
m.return_value.__iter__ = lambda self: self
m.return_value.__next__ = lambda self: next(iter(self.readline, ''))

这里的返回值是MagicMock从file对象（Python
2）或内存文件对象（Python 3）中指定的对象，但是只有read，write和__enter__方法已存入。

上述方法不工作在Python 2，因为一个）的Python
2预计next存在，不__next__和b）next不被视为在模拟（这是正确的）的特殊方法，所以即使你重新命名__next__以next在上述示例中的
类型 的返回值将没有next方法。在 大多数 情况下，使文件对象产生 可迭代的， 而不是使用以下代码进行迭代就足够了：

# Python 2!
m = mock.mock_open(read_data=''.join(self.TEST_TEXT))
m.return_value.__iter__ = lambda self: iter(self.readline, '')

iter(fileobj)然后，任何使用的代码都将起作用（包括for循环）。

Python跟踪器中存在一个开放的问题，旨在弥补这一差距。