【python3】packageの使い方について

Question

実現したいこと

このサイトを読んだのですが良く分からずです。

以下のようなツリー構造でプログラムを組んでいますが、
正しくmain.pyを実行するにはinit.pyにそれぞれどう記述するべきでしょうか。
また、ツリー構造は変更できないので、プログラム自体に間違いがあればそれも教えて頂きたいです。

# main.py
from dirC import C

main()

# dirA/A.py
import math

class keisan(object):
    def __init__(self, hankei):
        self.hankei = hankei
    def menseki(self):
        return self.hankei * self.hankei * math.pi

# dirA/dirB/B.py
from .. import A

class more_keisan(keisan):
    def __init__(self, hankei):
        super().__init__(hankei)
    def ensyu(self):
        return self.hankei * 2 * math.pi

# dirC/C.py
from ..dirA.dirB import B

def main():
    inst = more_keisan(5)

    print(inst.ensyu())
    print(inst.menseki())

Answer 1

__init__.py は関係ありません。
重要なのは、起動するスクリプトがいずれか、です。
仮に、「python3 main.py」と起動するならば、以下のようになります。

# main.py
from dirC.C import main

main()

# dirA/dirB/B.py
from ..A import keisan

class more_keisan(keisan):
	pass

# dirC/C.py
from dirA.dirB.B import more_keisan

def main():
	inst = more_keisan(5)

「dirA/A.py」は、そのままです。

---

まず、三つの事を把握しなければなりません。

絶対importは、sys.pathに指定されたディレクトリ以下にあるモジュール/パッケージから指定しなければならない。

「絶対import」という言葉はマニュアルには出てこないのですが、説明しづらいので、ここでは「相対import」に対する対義語として使う事にします。

相対importは、同じルートパッケージのモジュール同士でしか指定できない。

「ルートパッケージ」という言葉もマニュアルに出てきませんが、これもないと説明がしづらいので、ここでは「sys.pathのディレクトリ直下にあるパッケージ(ディレクトリ)」という事にします。

起動時に、起動スクリプトのディレクトリがsys.pathの先頭に追加される。

マニュアルの以下のページに書かれています。

• Python標準ライブラリ - sys.path

この事を踏まえて、先のスクリプトを見てみましょう。

# dirC/C.py
from dirA.dirB.B import more_keisan

「main.py」から起動されたのであれば、sys.pathにmain.pyのあるディレクトリが追加されているはずなので、「dirA」「dirC」がルートパッケージになります。
「dirA」と「dirC」とでは、ルートパッケージが違うので、「C.py」から「dirA」以下のモジュールを相対importすることはできないので、絶対importでインポートする必要があります。

# dirA/dirB/B.py
from ..A import keisan

「dirA/A.py」と「dirA/dirB/B.py」は、同じ「dirA」をルートパッケージとするモジュールですので、相対importが使用できます。(絶対importも使用可能)

---

そもそも「ディレクトリ構成を変えない」というのが今回の条件でしたが、本当であれば、

main.py
app/
  dirA/
    A.py
    DirB/
      B.py
  dirC/C.py

というように、起動スクリプトの下にパッケージ(ディレクトリ)を作り、それ以外のスクリプトはそのパッケージ以下に配置し、お互いを相対importでインポートするのが好ましいと思います。

Comments

[shirai]

とてもよく理解できました。
sys.pathについても検索してどのようなものか理解ができました。
困っていたのでとても助かりました。ありがとうございます。
ツリーの変更を上長に相談してみます。