Python中的模拟嵌套方法答案

【问题标题】：Mock nested method in PythonPython中的模拟嵌套方法
【发布时间】：2019-08-06 00:53:59
【问题描述】：

为此绞尽脑汁。我想在下面模拟生成器方法self.api.redditor(username).comments.new(limit=num)和self.api.redditor(username).submissions.new(limit=num)，其中self.api被分配给一个类实例，如self.api = PrawReddit()

我正在尝试测试结果的大小：self.assertEqual(len(result), 5)

到目前为止，我尝试了MockPraw.return_value.redditor.return_value.comments.return_value.new.return_value.__iter__.return_value = iter(['c' * 10])，但测试失败，AssertionError: 0 != 5

非常感谢任何提示。

def get_comments_submissions(self, username, num=5):
    """Return max `num` of comments and submissions by `username`."""
    coms = [
        dict(
            title=comment.link_title,
            text=comment.body_html,
            subreddit=comment.subreddit_name_prefixed,
            url=comment.link_url,
            created=datetime.fromtimestamp(comment.created_utc, pytz.utc),
        )
        for comment in self.api.redditor(username).comments.new(limit=num)
    ]
    subs = [
        dict(
            title=submission.title,
            text=submission.selftext_html,
            subreddit=submission.subreddit_name_prefixed,
            url=submission.url,
            created=datetime.fromtimestamp(submission.created_utc, pytz.utc),
        )
        for submission in self.api.redditor(username).submissions.new(limit=num)
    ]
    return coms + subs if len(coms + subs) < num else (coms + subs)[:num]

【问题讨论】：

你用 mock 试过什么？
类似这样的东西：MockPraw.return_value.redditor.return_value.cmets.return_value.new.return_value.__iter__.return_value = iter(['c' * 10])

标签： python unit-testing mocking generator python-unittest

【解决方案1】：

要模拟生成器（除非您使用特定的生成器功能），您可以使用迭代器作为替代品，例如

import unittest.mock as mock

generator_mock = Mock(return_value=iter(("foo", "bar")))

当您有像示例中这样的嵌套结构时，这会变得有点复杂，属性访问会自动处理，但必须定义来自函数的return_value。从你的例子：

# API mock
mock_api = Mock()
mock_api.redditor.return_value = mock_subs = Mock()

# Submissions mock
mock_subs.new.return_value = iter(("foo", "bar"))

这可以被调用和断言

for item in mock_api.api.redditor("user").submissions.new(limit=5):
    print(item)

mock_api.redditor.assert_called_with("user")
mock_subs.new.assert_called_with(limit=5)

由于 API 是同一类的成员，因此必须进行猴子修补，例如：

target = Praw()
target.api = mock_api()
target.get_comments_submissions("user")

mock_api.redditor.assert_called_with("user")
mock_subs.new.assert_called_with(limit=5)

请注意，返回值中的iterator 是单个实例，第二次调用获取迭代器将返回相同的实例。

【讨论】：

这有帮助。谢谢，蒂姆！

【解决方案2】：

就像你使用pytest-mock 一样写作，一切都发生在mymodule 中（你在模块顶部导入了类，如from xy import PrawReddit）：

mocker.patch("datetime.fromtimestamp")
mocked_comment = mocker.MagicMock()
mocked_submission = mocker.MagicMock()
mocked = mocker.patch("mymodule.PrawReddit")
mocked.return_value.redditor.return_value.comments.new.return_value = [mocker.MagicMock(), mocked_comment]
mocked.return_value.redditor.return_value.submisions.new.return_value = [mocker.MagicMock(), mocked_submission]

returned = instance.get_comments_submissions("foo", num=2)
assert mocked.return_value.redditor.call_count = 2
mocked.return_value.assert_called_with("foo")
assert returned[-1]["link_title"] == mocked_comment.link_title

另一个具有相同介绍的测试调用：

# ...
returned = instance.get_comments_submissions("foo")
assert mocked.return_value.redditor.call_count = 2
mocked.return_value.assert_called_with("foo")
assert returned[1]["link_title"] == mocked_comment.link_title
assert returned[-1]["title"] == mocked_submission.title

【讨论】：