python の module errorについて

Question

python3 で開発しているのですが、自作モジュールをインポートしているファイルに関して、pycharmでソースコードから実行すると問題なく実行できるのですが

ターミナルから実行しようとすると、ModuleNotFoundErrorが出てきてしまいます。

フォルダの構成は以下のようになっています。

projectname/
　├ aaa/
　│　└ bbb/
　│　　　└ somefile.py
　├ test/
　│　└ aaa/
　│　　　└ bbb/
　│　　　　　└ test_somfile.py

今回はtest_somfile.pyでpytestを行おうと思い、ターミナルから実行しようとしました。
ターミナルでtest/aaa/bbbに移動し、

pytest test_somfile.py

```をやったところ、上のようなモジュールインポートエラーが発生してしまいます。
test_somfile.pyの中身では以下のようにインポートしています。
```python
from projectname.aaa.bbb.somefile import test_method

エラー内容は下記です↓

ModuleNotFoundError: No module named 'projectname'

プロジェクト内部では全てこのような形でインポートしており、特にエラーもなく実行できているのですが、なぜターミナルから実行するとこのようなエラーが発生してしまうのでしょうか？実行している場所が変わることにより参照場所が変わってしまうのでしょうか？

Answer 1

提示されたような、「実行するファイルのあるフォルダーより上位のフォルダー」にあるファイルをimportするには、Pythonのモジュール検索パス(PYTHONPATH)に対象フォルダーを(sys.path.appendなどを利用して)追加する必要があります。

いっぽう、PyCharmでは、「プロジェクトのコンテンツルートやソースルートをモジュール検索パス(PYTHONPATH)に自動的に追加する」設定がデフォルトで有効になっています。

コンソール: Python コンソール — PyCharm

おそらく、あなたのprojectnameフォルダーがコンテンツルートの直下にあるため、モジュール検索パスを自分で追加しなくても、projectnameフォルダー以下のモジュールをimportできる状態になっているのでしょう。

ターミナルから実行する場合には、当然その恩恵は受けられないため、提示されたような状況になります。

test_somfile.pyが置かれたフォルダーから見て、projectnameフォルダーの親フォルダーは4つ上にあるので、以下のようなコードをfrom projectname.aaa.bbb.somefile import test_methodより前に書けば、どのフォルダーでtest_somefile.pyを実行しても動作するようになります。

import os
import sys

sys.path.append(os.path.join(os.path.dirname(__file__), '../../../..'))

Comments

[babbleman]

わかりやすく回答していただき誠にありがとうございます。
こちらのパスを追加する部分に関してですが、プロジェクト直下の全てのpythonファイルを追加したいとなった場合はアスタリスクなどで書くのでしょうか？
設定ファイルに書いておき、設定ファイルが読み込まれた段階で全てを読み込まれるようにしたいです。
(でもそうすると、設定ファイルを読み込むためのsysを追加しないといけないので同じことなのでしょうか。。)

[Daregada]

> こちらのパスを追加する部分に関してですが、プロジェクト直下の全てのpythonファイルを追加したいとなった場合はアスタリスクなどで書くのでしょうか？

テスト用コードだからこんな面倒なフォルダー構成になっている(のを無理やりsys.path.appendして動かしている)のではないですか?

普通は、実行するコードと同じフォルダーに各自作モジュールのフォルダーを作成して、ターミナルなどから実行してもsys.path.appendすることなくimportできるようにします。

[babbleman]

＞実行するコードと同じフォルダーに各自作モジュールのフォルダーを作成して
試しにテスト用ではない"somefile.py"を実行してみたのですが、やはり同様のエラーが出てしまいました。
基本的にプロジェクト全体として、自作モジュールを読み込む設定になっているので、全体として読み込めるようにする設定が必要そうです。

[Daregada]

> 試しにテスト用ではない"somefile.py"を実行してみたのですが、やはり同様のエラーが出てしまいました。
somefile.pyをどこに置いて、どうやってimportしたのかわからないのでなんとも。

さて、「質問文に書かれた疑問」が解決したのであれば、「解決済」にしてください。

[babbleman]

わかりました。
教えて頂きどうもありがとうございます。