モジュールとパッケージ

モジュール

Python においてモジュールとは Python のコードが記述されたファイルである。

こういった要求をサポートするために、Python では定義をファイルに書いておき、スクリプトの中やインタプリタの対話インスタンス上で使う方法があります。このファイルをモジュール (module) と呼びます。

以下はmodule.pyというモジュールをmain.pyから呼び出す例である。

.
├── module.py
└── main.py

module.pymain.py

def func() -> str:
    return "Hi"

import module

print(module.func())

$ python main.py
Hi

Python においてパッケージとは、複数のモジュールを持ち、かつ__init__.pyを含むディレクトリである。

パッケージ (package) は、Python のモジュール名前空間を "ドット付きモジュール名" を使って構造化する手段です。

以下はClassAクラスとClassBクラスを持つpackageというパッケージを__main__.pyから呼び出す例である。

例ではアプリケーション自体もappとしてパッケージ化している。パッケージはpython -m ${package_name}で実行できる。

.
└── app
    ├── __init__.py
    ├── __main__.py
    └── package
        ├── __init__.py
        ├── class_a.py
        └── class_b.py

app/package/class_a.pyapp/package/class_b.pyapp/package/__init__.pyapp/__init__.pyapp/__main__.py

from typing import Self


class ClassA:
    def say_hi(self: Self):
        print("Hi")

from typing import Self


class ClassB:
    def say_hello(self: Self):
        print("Hello")

from .class_a import ClassA
from .class_b import ClassB

from .package import ClassA, ClassB


def main() -> None:
    ClassA().say_hi()
    ClassB().say_hello()


if __name__ == "__main__":
    main()

$ python -m app
Hi
Hello

from .class_a import ClassAのような import を相対 import と呼ぶ。パッケージ内では相対 import を使うことが多い気がする。