Pythonのディレクトリ構成によるimportできない問題

Question

以下で実行したときにexecute.pyでimport しているはずのconfigができていません。
(以下のファイルのfrom .execute import functionの箇所)
これは、ディレクトリ構成を変える必要がありそうな気がしていますが、どう変えるのがベストか迷っています。
何か、アイデアありましたら教えてくれた頂けませんでしょうか？

EXPORT FLASK=run.py
flask run

エラー

ModuleNotFoundError: No module named 'config'

.
├── Dockerfile
├── Makefile
├── README.md
├── __init__.py
├── config
│   ├── __init__.py
│   └── base.py
├── config.py
├── execute.py
├── requirements.txt
├── run.py
└── test.sh

init.py

from flask import Flask
from .config import config

from .execute import function


app = Flask(__name__)

def create_app():
    app = Flask(__name__)
    app.config.from_object(config['base'])
    @app.route('/v1/get_texts/<key_name>/<file_name>', methods=['GET'])
    def get_texts(key_name, file_name):
        ...
        ...
    
        return function(line)
    return app
   
...

run.py

from . import create_app


app = create_app()
if __name__ == '__main__':
    app.run(host='127.0.0.1', port=8080, debug=True)

execute.py

...
from config.base import Config
...
...

config.py/init.py

from . import base


config = {
    'base': base.Config
}

config/base.py

class Config:
     ...
     ...

Answer 1

プロジェクトディレクトリーがparent/projectにあると仮定し、そこへ__init__.pyを置いてPythonのレギュラーパッケージとなるようにしたうえで、起動の仕方によってモジュール検索パス(sys.path)がどうなるかを調べてみますと

(1) python3 run.py
sys.path == ['parent/project', ...]

(2) export FLASK=run.py; flask run
sys.path == ['parent', ... ]

のように違いが出てくるようです。質問者さんは(1)のようないわゆるpythonスクリプトの起動をイメージして
from config.base ...
と記述しておられると思いますが、(2)の結果からflaskによる起動では
from .config.base ...
と書かねばならないようです。

自分はflaskについて暗いので本当のところはわかりませんが、少なくとも(2)の起動のしかたをする場合はプロジェクトのトップレベルを「一つのレギュラーパッケージとして記述する」スタイルを取るべきなのだと思います。

Comments

[sequelanonymous]

なるほど、気づきませんでした。ありがとうございます。
ちょっと、(1)と(2)の違いがわからなくなってきました。from .config.base の . の意味は、configディレクトリのある階層のことを言っていると理解していますが、同じ認識でしょうか？
つまり、これは、from project.config.base import ...と同義でprojectの部分を省略している、という理解でいました。しかし、省略しない書き方だとエラーがでてしまい、なんか違いがあるのかなと思ったり。

もう一点、ご意見お伺いさせてください。
本当は、省略せずにどのモジュールも全て絶対フルパスで統一して書きたいと考えています。
そういう場合は、(1)と(2)どちらが適していると思いますか？どこの階層にいても絶対フルパスでimportできるようなディレクトリ構成を日々模索していますが、たどり着けずにいます。。。

ご意見頂きますと助かります。

[KSwordOfHaste]

pythonのモジュールとパッケージの仕様については自分も充分理解しているとは言えないため下手にコメントすると間違いを言いそうです。
自分はPythonのリファレンスのimportシステムのところと
https://www.lifewithpython.com/2018/05/python-difference-between-package-and-module.html
この記事を両方熟読すると理解が深まるような気がしてます。

> どこの階層にいても絶対フルパスでimportできる

個人的にはその方法論よりレギュラーパッケージ、つまり__init__.pyを持つパッケージディレクトリーを用いて相対パスでプロジェクトを構成した方がよい気がします。

絶対パスでimportしたいというのが「今書いているプロジェクトとは独立したモジュール」ということなら、PYTHONPATHに自分用のモジュールのトップディレクトリー(例えば~/mypymodulesとか)を設定しておき、そのディレクトリー配下に自前のモジュール群を整理して入れておくと実質上望むことが可能ではないかとも思います。