pytestで呼び出すモジュールが別のモジュールを参照してる場合ModuleNotFoundErrorが出る

Question

前提

pytestを使用してpythonソースファイルのテストを行いたいです。
今回テストをしたいモジュールはもともと他のモジュールから定数をimportをして使っているのですが、そのモジュールを呼び出すところでModuleNotFoundErrorが出てしまいます。

発生している問題・エラーメッセージ

ディレクトリ構成と各ファイル内容は以下の通りです。

C:.
├─src
│      const.py
│      plus.py
│
└─tests
        test_plus.py
        __init__.py

NUM = 100

import const

def plusplus(i1,i2):
    print(i1+i2+const.NUM)
    return i1+i2+const.NUM

from src.plus import plusplus

def test_plus():
    assert plusplus(1,2) == 100

init.pyは何も記述していません。

試したこと

try_pytestディレクトリでpytestコマンドを実行したところ、
const.pyのモジュール読み込みの部分でModuleNotFoundErrorが発生してしまいました。

'C:\Users\xxxxx\Documents\try_pytest\tests\test_plus.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
..\..\appdata\local\programs\python\python36\lib\importlib\__init__.py:126: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
tests\test_plus.py:1: in <module>
    from src.plus import plusplus
src\plus.py:2: in <module>
    import const
E   ModuleNotFoundError: No module named 'const'
======================================================== short test summary info ========================================================= 
ERROR tests/test_plus.py
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 
============================================================ 1 error in 0.07s ============================================================ 

パスがうまく認識されていないことが問題だと思うのですが、
python -m pytestなどをつかっても結果は変わりませんでした。

解決方法をご教示いただけますと幸いです。

Answer 1

python では親ディレクトリをまたいだモジュールのインポートは sys.path に追加されたパスを介することで可能となります。

まず、実行する test_plus.py で src.plus にアクセスする前に、 インポートしたい src の親ディレクトリを sys.path へ追加し、
さらに、インポートされた plus.py でインポートしている const.py に対しても同じようにしなければならず、
この場合は、以下のソースのように import src.const ~ とするか、src ディレクトリを sys.path に追加して import src ~ としなければ、plus.py でもモジュールエラーとなってしまいます。
私の環境で、以下のソースが動作しましたのでそちらでもご確認いただければと思います。
以下のソースでの sys.path への設定は pathlib.Path のオブジェクトから指定していますが、'C:\src~' のような直接パスから指定することも可能です。

test_plus.py

import pathlib,sys
# インポートさせたいディレクトリパスを取得する
parent_dir = str(pathlib.Path(__file__).parent.parent.parent)
# sys.pathにインポートさせたいディレクトリを追加する
sys.path.append(parent_dir)
#インポートパスを確認
print('sys.path.append : {}'.format(parent_dir)) 

from src.plus import plusplus

def test_plus():
    assert plusplus(1,2) == 100

if __name__ == '__main__':
    test_plus()

plus.py

import src.const as const

def plusplus(i1,i2):
    print(i1+i2+const.NUM)
    return i1+i2+const.NUM

※変更するのは上記2つのファイルのみで、ほかのファイルの変更は必要ありません。

Comments

[wa20ta_mzn]

とても分かりやすいご解説ありがとうございます。
勉強になりました。