使用unittest模块进行修补时,是否可以在python中将side_effect分配给类成员变量?

时间:2019-02-19 17:57:08

标签: python pytest python-unittest monkeypatching

是否可以修补类实例变量,并在每次引用该变量时强制其返回不同的值?具体来说,我对使用 side_effect 参数

进行操作很感兴趣
  • 我知道在修补方法时,可以为模拟方法分配 side_effect 。如果将 side_effect 设置为列表,它将在列表中进行迭代,并在每次调用时返回不同的值。
  • 我想对一个类实例变量做同样的事情,但是无法使其正常工作,而且我看不到任何文档来建议这是否可行

示例

from unittest.mock import patch

def run_test():
    myClass = MyClass()
    for i in range(2):
        print(myClass.member_variable)

class MyClass():
    def __init__(self):
        self.member_variable = None

@patch('test_me.MyClass.member_variable',side_effect=[1,2], create=True)
def test_stuff(my_mock):
    run_test()
    assert False

输出

-------------- Captured stdout call ---------------------------------------------------------------------------------------------------------------------
None
None

所需的输出

-------------- Captured stdout call ---------------------------------------------------------------------------------------------------------------------
1
2
  • 要清楚-我知道我可以将 member_variable 包装在 get_member_variable method()中。那不是我的问题。我只想知道您是否可以使用side_effect修补成员变量。

2 个答案:

答案 0 :(得分:0)

side_effect可以是函数,可迭代或异常(https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.side_effect)。我认为这就是它不起作用的原因。

另一种测试方法是:

>>> class Class:
...     member_variable = None
...
>>> with patch('__main__.Class') as MockClass:
...     instance = MockClass.return_value
...     instance.member_variable = 'foo'
...     assert Class() is instance
...     assert Class().member_variable == 'foo'
...

以下是文档:https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch

答案 1 :(得分:0)

在您设置的示例中,我无法按照我的想法进行更改,您可能在此类中有更多内容,有了这个主意可以为您提供帮助。

不是对属性产生副作用的最佳选择,但它可以根据需要工作。

PS:我最终以使我想到您的问题的代码为例。

示例:

# -*- coding: utf-8 -*-
# !/usr/bin/env python3

import requests

from src.metaclasses.singleton import Singleton
from src.services.logger import new_logger
from src.exceptions.too_many_retries import TooManyRetries
from src.exceptions.unavailable_url import UnavailableURL

LOG = new_logger(__name__)


class PostbackService(metaclass=Singleton):
    def __init__(self):
        self.session = requests.session()

    def make_request(self, method, url, headers, data=None, retry=0):
        r = self.session.request(method, url, data=data, headers=headers)

        if r.status_code != 200:
            if retry < 3:
                return self.make_request(method, url, headers, data, retry + 1)
            message = f"Error performing request for url: {url}"
            LOG.error(message)
            raise TooManyRetries(message)

        return r.json()

测试:

# -*- coding: utf-8 -*-
# !/usr/bin/env python3
from unittest import TestCase
from unittest.mock import patch, MagicMock

from src.services.postback import PostbackService
from src.exceptions.too_many_retries import TooManyRetries
from src.exceptions.unavailable_url import UnavailableURL


class TestPostbackService(TestCase):
    @patch("src.services.postback.requests")
    def setUp(self, mock_requests) -> None:
        mock_requests.return_value = MagicMock()
        self.pb = PostbackService()

    def test_make_request(self):
        self.pb.session.request.return_value = MagicMock()

        url = "http://mock.io"
        header = {"mock-header": "mock"}
        data = {"mock-data": "mock"}
        mock_json = {"mock-json": "mock"}

        def _def_mock(value):
            """
            Returns a MagicMock with the status code changed for each request, so you can test the retry behavior of the application.
            """
            mock = MagicMock()
            mock.status_code = value
            mock.json.return_value = mock_json
            return mock

        self.pb.session.request.side_effect = [
            _def_mock(403),
            _def_mock(404),
            _def_mock(200),
        ]
        self.assertEqual(self.pb.make_request("GET", url, header, data), mock_json)

        self.pb.session.request.side_effect = [
            _def_mock(403),
            _def_mock(404),
            _def_mock(404),
            _def_mock(404),
        ]
        with self.assertRaises(TooManyRetries):
            self.pb.make_request("GET", url, header, data)

如您所见,我通过将每个人的副作用更改为我想做的事情来重新创建了Magicmock。它不是漂亮的代码和超级pythonic,但可以按预期工作。 我以此为基础来创建此magicmock对象,该链接是@rsarai从unittest文档发送的链接。