如何在Python单元测试中Mock readlines()以测试文件读取逻辑

看起来你已经找对了测试方向，但踩了一个mock_open的常见小坑——默认的mock_open实现并不会自动把传入的read_data转换成readlines()需要的行列表。我来帮你搞定这个问题：

问题根源 #

unittest.mock.mock_open的默认逻辑里，readlines()方法并不会根据你传入的read_data生成对应的行列表，它默认返回空列表。这就导致你的Foo实例的self.data会和预期结果不符。

解决方案 #

根据你的Python版本，有两种简单的修复方式：

方法1：适配旧Python版本（3.7及以下） #

手动给mock_open实例的readlines方法指定返回值，把测试数据按行分割成符合readlines()行为的列表：

import unittest
from unittest.mock import patch, mock_open
from my.data.class import Foo  # 替换为你的Foo类实际所在模块

TEST_DATA = "foo\nbar\nxyzzy\n"

class TestFoo(unittest.TestCase):
    def test_init_reads_lines_correctly(self):
        # 按readlines()的行为分割测试数据：保留每行末尾的换行符
        expected_lines = TEST_DATA.splitlines(keepends=True)
        
        # 创建mock_open实例并手动设置readlines的返回值
        mock_file = mock_open(read_data=TEST_DATA)
        mock_file.return_value.readlines.return_value = expected_lines
        
        with patch("my.data.class.open", mock_file, create=True):
            f = Foo("somefilename")
            self.assertEqual(f.data, expected_lines)

方法2：利用Python 3.8+的原生支持 #

如果你使用的是Python 3.8及以上版本，mock_open已经更新了readlines()的实现，会自动将read_data分割成对应的行列表。你只需要稍微调整预期值的生成方式，原代码就可以正常工作：

import unittest
from unittest.mock import patch, mock_open
from my.data.class import Foo

TEST_DATA = "foo\nbar\nxyzzy\n"

class TestFoo(unittest.TestCase):
    def test_init_reads_lines_correctly(self):
        expected_lines = TEST_DATA.splitlines(keepends=True)
        
        with patch("my.data.class.open", mock_open(read_data=TEST_DATA), create=True):
            f = Foo("somefilename")
            self.assertEqual(f.data, expected_lines)

额外注意事项 #

• 确保patch的路径正确：你需要patch的是**Foo类所在模块中使用的open函数**，而不是测试模块里的open，你原来写的"my.data.class.open"是正确的。
• 可以扩展测试用例，覆盖空文件、单行内容、末尾无换行符等边界场景，让测试更全面。

内容的提问来源于stack exchange，提问作者Hannu