datetime.datetime.now()をモックしたい.pdf

datetime.datetime.now()を
モックしたい
ねもっち
はんなりPython #52 ゆるいLT会

おまえだれよ
根本優太（ねもっち）
株式会社マイクロアドでデータエンジニアしてます
バッチプログラムの実装でPythonを使っています
@nemotche
https://www.linkedin.com/in/yutanemoto/
https://github.com/suzanagi

テストしてる？

単体テスト
(Unit Test)
結合テスト
(Integration Test)
システム
テスト
テストピラミッド

単体テスト
(Unit Test)
結合テスト
(Integration Test)
システム
テスト
テストピラミッド
実装コスト低
実装量大

ユニットテスト
def is_prime(num: int) -> bool:
"""
素数かどうか判定する
"""
if num < 2:
return False
i = 2
while i * i < num:
if num % i == 0:
return False
i = i + 1
return True

ユニットテスト
class TestSomeFunction(unittest.TestCase):
def test_is_prime_01(self):
# 1は素数じゃない
result: bool = is_prime(1)
self.assertFalse(result)
# 2は素数
self.assertTrue(result)
# 57は素数
"""
"""
if num < 2:
return False
i = 2
while i * i < num:
if num % i == 0:
return False
i = i + 1
return True

コードが間違ってたら
コードが正しかったら
$ python3 -m unittest discover test
..F
======================================================================
FAIL: test_is_prime_53 (test_some_function.TestSomeFunction)
----------------------------------------------------------------------
Traceback (most recent call last):
File "**********/test/test_some_function.py", line 26, in test_is_prime_53
AssertionError: False is not true
----------------------------------------------------------------------
Ran 3 tests in 0.004s
FAILED (failures=1)
...
----------------------------------------------------------------------
OK
$

モックテスト
"""
"""
if num < 2:
return False
i = 2
while i * i < num:
if num % i == 0:
return False
i = i + 1
return True
"""
"""
if is_less_than_2(num):
# 2未満なら素数じゃない
return False
if is_divisible(num):
# 割り切れたら素数じゃない
return False
return True
別関数に切り出してみた

モックテスト
"""
"""
if is_less_than_2(num):
# 2未満なら素数じゃない
return False
if is_divisible(num):
# 割り切れたら素数じゃない
return False
return True
# 57は素数
with patch('some_function.is_less_than_2', return_value=False),
patch('some_function.is_divisible', return_value=False):

しかし、モックできない関数が…

datetime.datetime.now()

def print_datetime() -> None:
# システム日時を取得
dt_now = datetime.datetime.now()
print(dt_now)
>>> print_datetime()
2022-10-20 01:54:07.109558
>>>
関数
実装例

python3 -m unittest discover test
....E
======================================================================
ERROR: test_print_datetime (test_some_function.TestSomeFunction)
Traceback (most recent call last):
File "********************/test/test_some_function.py", line 33, in test_print_datetime
with patch('datetime.datetime.now', return_value='2022-01-01 00:00:00.100001'):
…
TypeError: can't set attributes of built-in/extension type 'datetime.datetime'
FAILED (errors=1)
def test_print_datetime(self):
with patch('datetime.datetime.now', return_value='2022-01-01 00:00:00.100001'):
some_function.print_datetime()

方法1. pytestのmonkeypatchを使う
def test_print_datetime(monkeypatch):
datetime_mock = MagicMock(wraps=datetime.datetime)
datetime_mock.now.return_value = datetime.datetime(2022, 1, 1, 12, 59, 59, 100001)
monkeypatch.setattr(datetime, "datetime", datetime_mock)
$ pytest -s test_some_function.py
===================================== test session starts =
platform darwin -- Python 3.8.0, pytest-7.1.3, pluggy-1.0.0
rootdir: /Users/shiranui/Development/TestUnitTest
collected 1 item
test_some_function.py 2022-01-01 12:59:59.100001
.
====================================== 1 passed in 0.09s ==

方法2. time-machine を使う
import time_machine
with time_machine.travel(datetime.datetime(2022, 1, 1, 23, 59, 59, 100001, tzinfo='')):
2022-01-02 08:59:59.100001
.
----------------------------------------------------------------------
Ran 1 test in 0.000s
OK
$

方法3. ラッパー関数をつくる
dt_now = get_current_datetime()
print(dt_now)
def get_current_datetime() -> datetime.datetime:
return datetime.datetime.now()
dt_now = datetime.datetime.now()
print(dt_now)
datetime.datetime.now()だけ返す
関数を定義

方法3. ラッパー関数をつくる
print(dt_now)
def get_current_datetime() -> datetime.datetime:
return datetime.datetime.now()
with patch('some_function.get_current_datetime',
return_value=datetime.datetime(2022, 1, 1, 23, 59, 59, 100001)):
テストコード

方法4. 依存性を注入できる設計にする
def print_datetime(get_current_datetime = datetime.datetime.now) -> None:
print(dt_now)
some_function.print_datetime(lambda: datetime.datetime(2022, 1, 1, 23, 59,
59))
テストコード

まとめ

datetime.datetime.now()をモックする方法
1. pytestでテストを記述する
○ monkeypatchでモック化が容易
○ テストツールを移行する必要あり
2. time-machineライブラリを使う
○ Python標準のユニットテストでも利用可
能
○ 追加でライブラリをインストールする必要
あり
3. ラッパー関数を作って間接的に
モックする
○ 責務を明示的に分離できる
○ 関数呼び出しを行うコストがかかる
4. 関数を依存性注入できる設計で
作る
○ 実装への変更が小さい
○ インターフェースが複雑化

datetime.datetime.now()をモックする方法
変更標準のテストツー
ルでの実行
別ライブラリ
のインストール
実装の変更
1 pytestでテストを記述する不可あり (pytest) なし
2 time-machineライブラリを使う可能あり
(time-machine)
なし
3 ラッパー関数を作って間接的に
モックする
可能なし大きい（？）
4 関数を依存性注入できる設計で作
る
可能なし小さい（？）

ありがとうございました

datetime.datetime.now()をモックしたい.pdf

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Ähnlich wie datetime.datetime.now()をモックしたい.pdf

Ähnlich wie datetime.datetime.now()をモックしたい.pdf (20)

Kürzlich hochgeladen

Kürzlich hochgeladen (12)

datetime.datetime.now()をモックしたい.pdf