【Python】pytestで同じディレクトリのモジュールをimportして、"ModuleNotFoundError: No module named"を出さなくする

アーカイブ 287

Code 122 Software 65 Movie 31 Game 25 Book 15 Misc 14 Hardware 10 Mackerel 5

367 語

2 分

【Python】pytestで同じディレクトリのモジュールをimportして、"ModuleNotFoundError: No module named"を出さなくする

2022-04-16

Code

python

はじまり#

リサちゃん

あー、`ModuleNotFoundError: No module named`だぁぁー！！

135ml

importするときによく出るやつか。これがめんどいよな。

今回のディレクトリ構成#

今回、紹介するimport方法におけるディレクトリ構成は、以下になっています。

1
├── src
2
│   └── landmasterlibrarylocal
3
│       ├── file_list_getter.py
4
│       ├── input_controller.py
5
├── test
6
│   ├── __init__.py
7
│   ├── test_file_list_getter.py
8
│   ├── test_input_controller.py

失敗するパターン#

上記のディレクトリ構成の場合に、__init__.pyとfile_list_getter.pyのコードがこんな状態だったとします。__init__.pyには何も記述しません。

__init__.py:

1
# Nothing

file_list_getter.py:

1
# Library by default
2
import os, sys, platform
3
import time
4
# Library by third party
5
import glob2
6
# Library by landmasterlibrary
7
from input_controller import repeat_input_with_multi_choices
8

9
# ・・・以下略・・・

この状態では、普通に.pyファイルを実行する分には問題ないのですが、pytestを実行すると以下のエラーが出ます。

実行:

1
pytest

出力:

1
====================================================================================================== ERRORS =======================================================================================================
2
__________________________________________________________________________________ ERROR collecting test/test_file_list_getter.py ___________________________________________________________________________________
3
ImportError while importing test module '/Users/landmaster/Downloads/landmasterlibrarylocal/test/test_file_list_getter.py'.
4
Hint: make sure your test modules/packages have valid Python names.
5
Traceback:
6
../../opt/anaconda3/lib/python3.9/importlib/__init__.py:127: in import_module
7
    return _bootstrap._gcd_import(name[level:], package, level)
8
test/test_file_list_getter.py:5: in <module>
9
    from src.landmasterlibrarylocal.file_list_getter import *
10
src/landmasterlibrarylocal/file_list_getter.py:10: in <module>
11
    from input_controller import repeat_input_with_multi_choices
12
E   ModuleNotFoundError: No module named 'input_controller'

成功するパターン#

この"ModuleNotFoundError: No module named"が起きないようにするために、以下のように__init__.pyで記述します。

こうすることで、'../src/landmasterlibrarylocal'がモジュールの参照先に追加されます。

__init__.py:

1
import os
2
import sys
3
sys.path.append((os.path.join(os.path.dirname(__file__), '../src/landmasterlibrarylocal')))

そうすると、以下のように、”ModuleNotFoundError: No module named”が起きなくなりました。

出力:

1
================================================================================================ test session starts ================================================================================================
2
platform darwin -- Python 3.9.7, pytest-7.1.1, pluggy-0.13.1
3
rootdir: /Users/landmaster/Downloads/landmasterlibrarylocal
4
plugins: freezegun-0.4.2, anyio-2.2.0, mock-3.7.0, cov-3.0.0
5
collected 1 item
6

7
test/test_input_controller.py .                                                                                                                                                                               [100%]
8

9
================================================================================================= 1 passed in 1.73s =================================================================================================