Python unittestでのモジュールインポートエラーの解決法

Pythonのunittestを使用する際に、モジュールのインポートエラーが発生することがあります。この記事では、そのようなエラーの一般的な原因と解決策について説明します。

ファイル名・メソッド名はtestから始まらないといけない

Pythonのunittestでは、テストを行うファイル名やメソッド名はtestから始まる必要があります。例えば、以下のようになります。

# ファイル名
# 良い例
test_hoge.py
# 悪い例
hoge_test.py

# メソッド定義
# 良い例
def test_hoge_method(self):
    pass
# 悪い例
def hoge_method_test(self):
    pass

Pythonがモジュールをインポートする際には、モジュール探索パスが重要な役割を果たします。モジュール探索パスとは、Pythonがモジュールを探すためのパスのことを指します。このパスが正しく設定されていないと、モジュールが見つからずにエラーが発生します。

テストコードの実行に問題がある場合、ディレクトリ構成や実行場所が問題である可能性があります。例えば、以下のようなディレクトリ構成があるとします。

projectroot
┣classes
┃   ┣__init__.py
┃   ┗hoge.py
┗tests
    ┣__init__.py
    ┗test_hoge.py

この場合、test_hoge.pyを実行するためには、projectrootディレクトリで以下のコマンドを実行する必要があります。

$ python -m unittest tests.test_hoge

また、特定のクラスやメソッドだけをテストする場合は、以下のように実行します。

$ python -m unittest tests.test_hoge.TestHogeClass.hoge_method_test

これらのポイントを押さえておくことで、Pythonのunittestでのモジュールインポートエラーを解決することができます。