PythonのMockについて

Question

import unittest
from unittest import mock

from expires import get_expires_at


class TestExpiresAt(unittest.TestCase):
    @mock.patch('expires.time')
    def test_get_default(self,m):
        m.return_value = 1470620400
        actual = get_expires_at()
        self.assertEqual(actual,1470624000)
    
    @mock.patch('expires.time')
    def test_get(self,m):
        m.return_value = 1470620400
        actual = get_expires_at(7200)
        self.assertEqual(actual,1470627600)
# expires.py
from time import time


def get_expires_at(expires_in=3600):
    """ 有効期限 expires_in (秒) を受け取り、無効になる時刻をエポックタイムで返す
    """
    return time() + expires_in

mockの使い所がよく理解できず困っています
またどうしてmock.patchはこのようにデコレータにする必要があるんでしょうか？

Comments

[quickquip]

mockをimportしている部分が書いてあるといいですね。もしくは"なんのパッケージの"mockなのか明に書いてください。

"PyQで只今勉強中なのですが、"はまったく不要です。混乱しか生みません。

[silk_]

import文の明記と、mock_pathを当てた部分のコードを追加しました

Answer 1

ありがとうございました！
参考になりました！

Answer 2

mockは必ずしもデコレータする必要はありません。
mockをデコレータすることで、デコレータされたメソッド内でコールする際にmockが呼び出されることになります。
サンプルコードですと、test_get_default()内の処理で呼び出すexpires.timeをmock化する、ということになります。

以下のようにpatch()を使用してmockの開始（start）・終了（stop）を行うことも可能です。※setUpとtearDownはtestメソッドの最初と最後に呼び出されるメソッドです。

    def setUp(self):

        # mockを定義
        self.patch_sample = patch(
            'expires.time', new=MagicMock()
        # mockを開始
        self.patch_sample.start()

    def tearDown(self):

        # mockを終了
        self.patch_sample.stop()

    def test_get_default(self,m):
        # テストコードを実装
        # test_get_default()実行前に`setUp`が行われ、実行後に`tearDwon`が行われる。

また、withを使用して範囲的にmockを使用することも可能です。

    def test_get_default(self,m):

        with patch('expires.time'):
            # テストコードを実装

pythonのmockについては以下のサイトが参考になると思います。

• [python] まだmockで消耗してるの？mockを理解するための3つのポイント