Python - モジュールとパッケージ
初めに
本記事では、モジュールとパッケージについて、解説します。モジュールとパッケージの違いやインポートの仕方、パッケージの作り方、__init__.py
について説明しています。
モジュールとパッケージ
モジュール
モジュールとは関数やクラスなどを別ファイルで利用できる状態で整理したPythonのソースコードです。
外部ファイルのソースコードを使用するには、import
を使います。
# math モジュールをインポート import math # math.pi を使って円周率を出力 print(math.pi) # math.sin 関数を使って三角関数の値を出力 print(math.sin(math.pi / 2))
上記のコードではmath
という外部ファイルをインポートしています。インポートした外部ファイルに記述してある変数や関数を使用することができます。
また、from モジュール名 import 関数名
を使い、外部ファイルの特定の関数だけインポートすることができます。
パッケージ
1つのモジュールにたくさんの定義を含めてしまうと分かりづらくなってしまうため、ファイルを分割し、複数の無ジュールを作成し、1つのディレクトリに集約します。このように複数のモジュールをまとめたディレクトリをパッケージといいます。
パッケージの作り方
ディレクトリ内にPythonファイルをまとめただけではパッケージにはなりません。ディレクトリをパッケージとして扱うには、__init__.py
というファイルをディレクトリ内に用意する必要があります。
__init__.py
は空ファイルとするときは、パッケージ内のモジュールを次のようにインポートします。
import パッケージ名.モジュール名
モジュール・パッケージ命名時の注意点
モジュール名、パッケージ名に-
を使わないようにしましょう。xx-yy
のようなモジュールを作った、インポートするにはimport xx-yy
と記述することになりますが、-
が引き算だと解釈されてしまいます。
__init__.py
先ほど、パッケージには__init__.py
というファイルを作成する必要があることを確認しました。このファイルの役割を確認します。
__init__.py
はモジュール、パッケージの初期化を行います。すなわち、パッケージを参照する場合、最初に呼び出されるものが__init__.py
です。
先ほど、パッケージ内のモジュールを参照する場合はimport パッケージ名.モジュール名
と記述すると述べましが、パッケージを参照する方法は述べませんでした。これは、__init__.py
が空のファイルの状態だとパッケージを参照しても何もインポートできないためです。
例えば、次のようなパッケージを参照したい場合について考えます。
パッケージ名 | example |
---|---|
モジュール | sample.py |
このexample
パッケージ自体を参照し、__init__.py
に次のように記述します。
# __init__.py # 自分と同じディレクトリから sample.py をインポート from . import sample
from . import sample
は相対インポートを行っており、自分と同じディレクトリ内にあるモジュールからsample
をインポートしています。同様にパッケージ内にあるモジュールをすべて同様に記述すれば、あとはパッケージをインポートするだけで使用できるようになります。