理解して覚えるpython ~import編~

はじめに

私は毎回「あれ，この import の仕方っていけるんだっけ」となっては調べて，を繰り返しています．そのような方，実は結構多いのではないのでしょうか．そんな自分とおさらばするための記事です．
明らかな嘘がありましたら，ご教授いただければ幸いです．

python 2系と3系とでルールが大きく異なり，3系であっても3.3以降とそれ以前とではルールが異なるようです．本記事では，2系と3.3以前の違いにも触れつつ，3.3以降で適用されるルールを確認していきます．

本記事では，python の import 方法である「絶対 import」と「相対 import」のルールを確認し，そのルールが決められた理由を理解して覚えることを目的としています．色々と調べた上，独自の観点でまとめています．

絶対 import

「ドット（.）」をつけない import 方法です．
この import が可能なファイルは，

import sys   # これが絶対 import
print(sys.path)

で確認できます．私の環境では次のように出力されました．

['C:\\Users\\ユーザ名\\OneDrive\\デスクトップ\\実行ファイルがあるディレクトリ', 
'C:\\Users\\ユーザ名\\AppData\\Local\\Programs\\Python\\Python310\\python310.zip', 
'C:\\Users\\ユーザ名\\AppData\\Local\\Programs\\Python\\Python310\\DLLs', 
'C:\\Users\\ユーザ名\\AppData\\Local\\Programs\\Python\\Python310\\lib',
'C:\\Users\\ユーザ名\\AppData\\Local\\Programs\\Python\\Python310',
'C:\\Users\\ユーザ名\\AppData\\Local\\Programs\\Python\\Python310\\lib\\site-packages']

この中に含まれるのは，PYTHONPATH とインストール時に指定したデフォルトパス('C:\\Users\\ユーザ名\\AppData\\Local\\Programs\\Python\\Python310')です．謎の文字列がいくつか見られますが，重要なものは以下の通りです．

1. 実行ファイルが存在するディレクトリ
2. 標準ライブラリ関連(python310.zip, lib)
3. 外部ライブラリ(site-packages)

つまり，もともと入っている 「標準ライブラリ（random や math など）」，後から（pip などで）インストールした 「外部ライブラリ（numpy や matplotlib など）」 や 「実行ファイルがあるディレクトリ直下のファイル」 は何も考えずにそのまま import できるわけですね．

インタプリタから起動すると，sys.path[0]には，カレントディレクトリが入るようです．
また，site-packages 直下に.pthファイルを作成し，そこに site-packages の孫ファイルをおいておくと，sys.path の最後に追加され，絶対 import 可能になります．

相対 import

「ドット（.）」を使った import 方法です．
注意点はいくつかありますが，まずその前に相対 import とは何かを確認しておきます．「ファイルを相対位置で import する方法でしょ？」と思った方は，「同じパッケージ内で他のモジュールを import する方法」 と覚えなおすことをお勧めします．というのも，前者の理解では，どのファイルからでも相対位置を指し示せば import できると勘違いしてしまうからです．
しかし，実際は次のようなルールがあります．

1. 実行ファイルから相対 import できない^[1]
2. 実行ファイル以外（モジュール同士）は相対 import 可能だが，実行ファイル以上の階層の通るパッケージやモジュールは相対 import できない

これらのルールを頭の片隅において，前述した 「同じパッケージ内で他のモジュールを import する」 を理解していきましょう．
以下のディレクトリ構成を考えます．

mypackage:
├─main.py
├─subpack1
│  └─ mod1.py
└─subpack2
    ├─subsubpack
    │  └─ mod3.py
    └─ mod2.py

まず，１（実行ファイルから相対 import できない）についてですが，実行ファイルから相対的に import したいのであれば絶対 import で事足ります．なぜなら，実行ファイルは自然と sys.path に追加されるからです．具体的には，以下のように相対的に import 可能です．（補足ですが，相対 import はパッケージ間の import を簡単にするためにやむなく生み出された歴史的背景を知っていればこのことを意識する必要はありません．）

main.py

import subpack1.mod1 as mod1
import subpack2.mod2 as mod2
import subpack2.subsubpack.mod3 as mod3
# from .subpack1 import mod1 は不可

上記の import 方法では，階層を重ねるごとに記述が長くなり面倒です．そこで，import に関するルールを記載した__init__.pyを置いておくことで，もう少し楽に import できるようになります．

python3.3 以前では，パッケージを認識するのに__init__.pyが必要であったため上記の方法では error となります．3.3以降では，__init__.pyを置いていなければ "Namespace Package"，__init__.pyがあれば "Regular package" と区別されるため，置かなくても一応パッケージとして扱われるようです．

続いて，ルール２（実行ファイル以外（モジュール同士）は相対 import 可能だが，実行ファイル以上の階層の通るパッケージやモジュールは相対 import できない）です．先ほどのディレクトリ構成を再掲しておきます．

mypackage:
├─main.py
├─subpack1
│  └─ mod1.py
└─subpack2
    ├─subsubpack
    │  └─ mod3.py
    └─ mod2.py

この図でいうと，実行ファイル（main.py）以外のファイルは，mod1.py, mod2.py, mod3.py です．これらはモジュール同士であるため，互いに相対 import 可能です．
しかし，ここで注意すべき点が１つあります．それは，実行ファイル以上の階層を通った import ができないという点です．ここでの実行ファイルは，main.py なので，これと同階層であるsubpack1, subpack2は互いに相対 import できません．

具体例でみてみます．

mod1.py

from ..subpack2 import mod2
print(mod2.a)

mod2.py

a = 3

これを先ほどのmain.pyから実行すると，

ImportError: attempted relative import beyond top-level package

「トップレベルパッケージ（ここではmain.py）を越えた相対 import はできない」と怒られました．
一方で，subsubpack 内のmod3.pyからmod2.pyにアクセスすることは可能です．実行ファイルであるmain.pyを経由しないためです．

ここで，相対ディレクトリの記法について補足しておきます．
「.」でカレントディレクトリ，「..」で１つ上のディレクトリ，「...」で２つ上のディレクトリを示します．
また，python from *** import ***のように必ず「from」から書く必要があります．（JavaScript になじみがある人は順序が逆で混乱しますよね（笑））

相対 import を「from」から始める理由は python3 の仕様であり，その理由として「import .XXX.YYY.ZZZとした場合，.XXX.YYY.ZZZ が式として表現できないため」との説明があります．

具体的なイメージができたところで２の理由を考えてみましょう．２は「モジュール間で相対 import 可能」と「実行ファイル以上を遡って相対 import は不可能」の２点でした．
　まず，１つ目ですが，相対 import の利点を考えます．それは特定のファイルを起点に考えられる点です．絶対 import にすると，互いのモジュールを読み込む際に，「長いパスを書く」or/and「ディレクトリ構成を変更した場合，パスをほとんど全て書き直す」ことが必要になります．つまり，（パッケージ内の）モジュール間の読み込みができるだけに楽にやれるように許されている という認識でよさそうです．
　続いて，２つ目の実行ファイル以上を遡れない理由は，セキュリティの観点での説明がなされており，個人的にもしっくりきます．例えば，外部から入手したパッケージがどこまでも遡ってファイルを操作できてしまったらどうでしょう．考えただけでやばそうです．つまり，信頼できないものの影響範囲を限定しているということですね．

上記の説明には補足があります．python2系では，パッケージ内のモジュール同士は絶対 import 可能でした． つまり，「簡単な記述で import する」 を実現できていたのです．しかし，これでは，既存のライブラリにあるものと名前がかぶった場合に困ります．どちらを意図して呼び出したのかわからないからです．（例えば，自分で作ったモジュールに random.py があり，標準ライブラリの random も同時に使いたい場合に，ともにimport randomという記述になり，困るということです．）「名前をかぶらないように工夫すればいい！」という声が聞こえてきそうですが，後々インストールしたライブラリ内部に同じ名前のものがあるかもしれませんし，膨大なシステムを構築すればするほど「名前被り」の調査が面倒になることが想像できると思います．これを避ける目的で相対 import が導入されたようです．

PEP8 による規約

python のコーディング規約である PEP8 では以下のことが推奨されているため，意識すると良いと思います．特に重要だと思われる 3 つをピックアップしてお伝えします．

import はえらいやつ順！

「標準ライブラリ $\Rightarrow$ サードパーティライブラリ $\Rightarrow$ ローカルで作成したモジュール」の順に一行ずつあけて書く．この理由としては，この方が意図した挙動になりやすいからだと考えられます．より具体的に言うと，あとから import したものが上書きされるため，ローカルで作成したライブラリで作った関数，変数名に重複がある場合，ローカルの方が適用されるといった具合です．

複雑な構成でなければ絶対 import を使用する

可読性の観点ときれいなエラーを吐いてくれるかららしいですね．しかし，絶対 import では冗長になってしまうケースでは許容されるようです．

ワイルドカード(*)を使用するのは避ける

from os import *のように書くと，何が読み込まれているかわかりづらいです．ワイルドカードでは変数名等に重複があった場合，知らないところで上書きされてバグの温床になり得ます．

おわりに

色々と調べた結果かなり時間を要してしまいましたが，私自身も非常に勉強になりました．ルールとともにその理由まで調べていくことで単なる暗記ではなく，ある程度納得感をもって覚えられ，言語を扱う上での汎用的な考え方も身につくのではないかと考えています．
今後も，このような思考で記事を書いていければと思っています．

参考

• Pythonでは何故、上位ディレクトリ内の別ディレクトリにあるファイルをimportできないのでしょうか？ （sys.path.append() でできるのは解ったけど、仕組みがいまいちわからん）
• import 文ってなに？
• Python: 明示的な相対インポートの使い方
• Python: 標準ライブラリの格納場所
• Pythonのimportがよくわからなかったので、調べてみる
• Pythonの相対インポートで上位ディレクトリ・サブディレクトリを指定
• 【Python3基礎】同じモジュール内のファイルを呼ぶときはfrom <相対パス> import <ファイル名>じゃないとダメ
• PEP 328 - 複数行の import
  そして 絶対 import と相対 import
• pep8-ja

脚注

1. -mオプションをつければ可能