Python 標準出力(print()した結果)をunittestするためのテストコードの書き方をご教授ください

Question

前提・実現したいこと

Pythonで単純に「hello world」とprintで標準出力する
ソースコードをunittestしたいのですが、
書き方がわかりません。

書き方がわかる方がいらっしゃいましたら、
ご教授頂けると幸いです。

該当のソースコード

テストしたいコードは、ただ「hello world」をprint出力するだけです。
hoge.py

print('hello world')

このコードに対し、「hello world」が出力されたことを
確認するテストコードを書きたいです。

次のサイトの内容を参考にして
テストコードを書いてみました。

参考にしたソースのURL
[Dd]enzow(ill)? with DB and Python
Pythonのunittestで標準出力のテストを作る

うまくいかなかったテストコード

test_hoge.py

import unittest
import sys
from io import StringIO
import hoge

class MogeTest(unittest.TestCase):
    def setUp(self):
        self.org_stdout, sys.stdout = sys.stdout, StringIO()

    def tearDown(self):
        sys.stdout = self.org_stdout
        
    def test_hello(self):
        hoge #ここで「hello world」が呼び出される
        expected = 'hello world\n'
        self.assertEqual(expected, sys.stdout.getvalue())

上記のテストコードを実行すると、失敗します。
python -m unittest -v tests.test_hoge

hello world ←ここに標準出力がでてしまう
test_hello (tests.test_hoge.MogeTest) ... FAIL

======================================================================
FAIL: test_hello (tests.test_hoge.MogeTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "C:XXX\tests\test_hoge.py", line 16, in test_hello
    self.assertEqual(expected, sys.stdout.getvalue())
AssertionError: 'hello world\n' != ''　←hogeの結果がセットされず空白になっている
- hello world


----------------------------------------------------------------------
Ran 1 test in 0.001s

FAILED (failures=1)

試したこと

呼び出された関数内でprintが使われている場合は、
うまくテストできました。

テストしたいソース
moge.py

def hello():
    print('hello world')

対応するunittest

test_moge.py

import unittest
import sys
from io import StringIO
import moge

class MogeTest(unittest.TestCase):
    def setUp(self):
        self.org_stdout, sys.stdout = sys.stdout, StringIO()

    def tearDown(self):
        sys.stdout = self.org_stdout
        
    def test_hello(self):
        moge.hello()
        expected = 'hello world\n'
        self.assertEqual(expected, sys.stdout.getvalue())

テスト結果

python -m unittest -v tests.test_moge
test_hello (tests.test_moge.MogeTest) ... ok

----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

ご教授のほど、よろしくお願いいたします。

Answer 1

同じような質問を見つけました

こちらに類似の質問と回答がありました。

「1つのファイル」へのテストはどんなモジュール、方法を使えばよいでしょうか
https://teratail.com/questions/53736?link=qa_related_pc_sidebar

Answer 2

早速のご回答ありがとうございました。

ご教授頂いた内容から、
次のようにテストコードを書くことができました。

テストコードはOKになりましたが、
なぜこの書き方で良いのか、
今ひとつ理解できていないです。

今後の課題とします。

修正したテストコード

import unittest
import sys
from io import StringIO
from contextlib import redirect_stdout

class MogeTest(unittest.TestCase):      
    def test_hello(self):
        f = StringIO()
        with redirect_stdout(f):
            import hoge
        expected = 'hello world\n'
        self.assertEqual(expected, f.getvalue())

参考情報

次のサイトの情報を参考にしました。
【Python3】unittest使い方まとめ
６．標準入力・標準出力の試験

以上です。

Answer 3

早速のご回答ありがとうございました。

ご教授頂いた内容から、
次のようにテストコードを書くことができました。

テストコードはOKになりましたが、
なぜこの書き方で良いのか、
今ひとつ理解できていないです。

今後の課題とします。

修正したテストコード

import unittest
import sys
from io import StringIO
from contextlib import redirect_stdout

class MogeTest(unittest.TestCase):      
    def test_hello(self):
        f = StringIO()
        with redirect_stdout(f):
            import hoge
        expected = 'hello world\n'
        self.assertEqual(expected, f.getvalue())

以上です。

Answer 4

https://docs.python.org/ja/3/library/contextlib.html#utilities

の

contextlib.redirect_stdout(new_target)

を使うと実現したいことが可能になりますよ。

Comments

[Taste_Bitter]

早速のご回答、誠にありがとうございました。
自信はありませんが、修正したテストコードを回答欄に追記しました。