"モジュールのスクリプト動作"でも"パッケージ外からの利用"でもimportを動作させたい

Question

自作のpythonのパッケージにおいて、その内部のモジュール単位での実行と、外部のスクリプトからのパッケージの利用の両方でうまく動作するimportの書き方が知りたいです。

環境

• Windows10
• python3.7.0
• ファイル構成は以下の通り

main.py
my_package/
    __init__.py
    mod.py
    submod.py

以下でそれぞれのファイルについて説明します。

init.py

何も記載していません。

submod.py

submod.pyはsubfncの実装があります。

def subfnc():
   print("subfnc called")

mod.py

mod.pyはsubmod.pyを使って処理をします。

from submod import subfnc

def fnc():
    print("fnc called")
    subfnc()

# 単体テスト用
if __name__ == "__main__":
    print("do something to test fnc()")

ここでpython .\my_package\mod.pyを実行すると単体テストが実行できます。タイトルの"モジュールのスクリプト動作"とはここを指しています。ここまではOKです。

main.py

main.pyは以下のようにmy_package内のmodをimportして使います。

from my_package.mod import fnc

fnc()

これがmy_packageのパッケージとしての本来の使い方(ここがタイトルの"パッケージ外からの利用")かと思います。ただしpython .\main.pyを実行すると以下のようなエラーが発生します。

ModuleNotFoundError: No module named 'submod'

試したこと

ネットで調べると、python3.3以降では相対パスの明示化が必要とのことなので、mod.pyのimport部分に.を追加しました(下記)。

# "."を追加して".submod"とした
from .submod import subfnc

def fnc():
    print("fnc called")
    subfnc()

この場合はエラーが発生していたコマンドpython .\main.pyがうまくいきました。ただし今度は単体テストのpython .\my_package\mod.pyでエラーが発生するようになりました。

ModuleNotFoundError: No module named 'main.submod'; 'main' is not a package

調査するとモジュールをスクリプトとして実行するときは-mをつけろという情報もあったので、python -m .\my_package\mod.pyとしましたが、今度は違うエラーとなりました。

Relative module names not supported

そのほかにもsys.path.append()しろ、とか出てきますが、なんだかややこしすぎてもっと簡潔な方法がないものかと思い、この辺りのノウハウなどを教えていただきたいです。

Answer 1

python -mに指定するのは"ファイルの名前"ではなくて、"Python上のモジュールの名前"なので

python -m .\my_package\mod

で実行するのではなくて

python -m my_package.mod

が正解でした。
カレントディレクトリはmain.pyがあるディレクトリで実行してください。

（その部分以外には、間違った記述/誤解は見あたりません）

Comments

[barbaz]

なるほど、ありがとうございます。