パッケージの利用

モジュールを使ってファイルを分割できるようになりましたが、プロジェクトが成長するにつれてモジュールの数も増えていきます。たとえば、人物に関するモジュール、チームに関するモジュール、データベースに関するモジュールなど、さまざまなファイルが1つのフォルダに並ぶことになります。ファイルが10個、20個と増えてくると、目的のモジュールを探すだけでも手間がかかり、プロジェクト全体の見通しが悪くなります。

この問題を解決するために、Pythonでは関連するモジュールをディレクトリ(フォルダ)でまとめて管理できます。このように複数のモジュールをディレクトリでまとめたものをパッケージと呼びます。パッケージを使えば、機能ごとにモジュールを整理でき、大規模なプロジェクトでもコードの管理がしやすくなります。

1. パッケージの作成

パッケージを作成するには、ディレクトリの中に __init__.py ファイルを配置します。先ほどのプロジェクトをパッケージ構成に変更してみましょう。

Visual Studio Codeのエクスプローラーで右クリックし、「新しいフォルダー」を選択してmodelsフォルダを作成します。

my_project/
├── person.py
├── main.py
└── models/  ← このフォルダを作成

パッケージの初期化ファイルを作成します。modelsフォルダを右クリックし、「新しいファイル」を選択して__init__.pyという名前で作成してください。内容は空のままで保存します。

my_project/
├── person.py
├── main.py
└── models/
    └── __init__.py  ← このファイルを作成(空ファイル)
📝 init.py について
__init__.py は、そのディレクトリがPythonパッケージであることを示すファイルです。空ファイルでも構いませんが、パッケージの初期化コードやインポート設定を記述することもできます。Python 3.3以降では __init__.py がなくてもパッケージとして認識されますが、明示的に配置することが推奨されます。

先ほど作成したperson.pyをmodelsフォルダ内に移動します。Visual Studio Codeのエクスプローラーでperson.pyをドラッグし、modelsフォルダにドロップしてください。

my_project/
├── main.py
└── models/
    ├── __init__.py
    └── person.py  ← ここに移動

チームクラスを定義するファイルを作成します。modelsフォルダ内にteam.pyという名前でファイルを作成します。

my_project/
├── main.py
└── models/
    ├── __init__.py
    ├── person.py
    └── team.py  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

class Team:
    def __init__(self, team_name, leader, member_count):
        self.team_name = team_name
        self.leader = leader
        self.member_count = member_count

    def show_detail(self):
        return f"チーム「{self.team_name}」 リーダー: {self.leader.name}({self.leader.age}歳) メンバー: {self.member_count}人"

2. パッケージの読み込み

パッケージ内のモジュールを読み込むには、パッケージ名.モジュール名 の形式で指定します。main.pyの内容を以下に書き換えます。

from models.person import Person
from models.team import Team

person = Person("田中太郎", 25)
team = Team("開発チーム", person, 5)
print(team.show_detail())

from models.person import Person は、models パッケージの中にある person モジュールから Person クラスを読み込むという意味です。パッケージを使わない場合は from person import Person でしたが、パッケージ内のモジュールを指定するときは models.person のようにドット(.)でつなげて書きます。

実行すると以下のように出力されます。

チーム「開発チーム」 リーダー: 田中太郎(25歳) メンバー: 5人

from models.person import Person と from models.team import Team でパッケージ内の各モジュールからクラスを読み込み、Team のコンストラクタに Person オブジェクトを渡した結果、チーム情報が正しく表示されています。