main.py
でMODULE.py
内の関数FUNC()
や変数VAR
を使いたい時,以下のように宣言する.
from PATH_OF_PACKAGE import MODULE
RES1 = MODULE.FUNC()
RES2 = MODULE.VAR
もしくは,
from PATH_OF_MODULE import FUNC, VAR
RES1 = FUNC()
RES2 = VAR
PATH_OF_PACKAGE
は,MODULE.py
があるディレクトリの「パス」であり,PATH_OF_MODULE
は,MODULE.py
のパスである.
一般的に「パス」の表し方は,
- 絶対パス
- 相対パス
- システムパス の 3 つがあります.
C:\Users\kotaro\Documents\psp2\foo\bar\pee.py
のパスを上記 3 つのそれぞれで表現してみましょう.
絶対パスは,
C:\Users\kotaro\Documents\psp2\foo\bar\pee.py
です.
最も根源となっているディレクトリ(root,ルート)からどうディレクトリを移動して辿りつくかが書かれている完全な表現です.
相対パスは,呼び出し元の絶対パスとの相対関係で表現するものです.
-
例えば,
C:\Users\kotaro\Documents\psp2\foo\bar\main.py
から呼び出すのであれば,同じ階層に pee.pyを呼び出すので,相対パスは
.\pee.py
となります.
.\
は現在地(pwd
)を表します. -
例えば,
C:\Users\kotaro\Documents\psp2\foo\main.py
から呼び出すのであれば,同じ階層の bar の下の pee.pyを呼び出すので,現在地
.\
を使って,.\bar\pee.py
となります.
-
例えば,
C:\Users\kotaro\Documents\psp2\foo\bar\don\main.py
から呼び出すのであれば,1 つ上の階層にある pee.pyを呼び出すので,
..\pee.py
となります.
..\
は 1 つ上の階層を表します.
システムパスは,環境変数が設定されていたときに表現できます.例えば環境変数PATH
にC:\Users\kotaro\Documents\psp2
が含まれていれば,それを絶対パスから削った
foo\bar
がシステムパスです.
ちなみに現在地.\
も環境変数に含まれることが多いので,先の「相対パス」に記した例にある.\
が含まれているものは.\
を省略して構わないことが多いです.(常にそうではないので注意)
- Windows では,
\
をつけてディレクトリの中のファイルを表します.つけてないものは,ディレクトリかファイルそのものです. - Mac,*NIX では,
\
ではなく/
です.
基本的に,
from PATH import FOO
と書きますが,FOO
の部分には階層を書かず,PATH
に階層を書きます.
python では階層を\
や/
ではなく,.
と表現します.
- 現在地や 1 つ上の階層を表す表現はありません.つまり
.\
や../
などはなく,「相対パス表現」はありません
また,「絶対パス表現」も使えません.したがって,PATH
部分には,.
を必要に応じて使った「システムパス」のみでパスを表現します.
python のシステムパスの環境変数には,次が定義されている.
- 「実行場所」
import
が書かれた呼び出し元の.py ファイルの階層
- 「サイトパッケージ」
.venv/lib/pythonX.YY/site-packages/
..venv
が無ければ,システムの site-packages
- 「PYTHONPATH」
- Windows の環境変数や,mac/linux の.bashrc などで設定
- 「サイトパッケージ/.pth」
- 追加したい環境変数を書く
最終的に上記のすべてをまとめた python のシステムパス(環境変数)は,次の 2 行を書いた python コードを動かすことで知ることができる.
import sys
print(sys.path)
ちなみに,このリストの順にモジュールを探索するため,このリストにあるパスの下に同じ名前のファイルがある場合,先に見つけられたファイルやディレクトリが import や from の対象になる.
たとえば
psp2
├── extention
│ └── ext1.py
├── myapp
│ └── main.py
という状況で,psp2/myapp/main.py から psp2/extention/ext1.py をインポートしたいとする.
そのためには,main.py において sys.path の直下に extention や ext1.py がなければならない.
import ext2
としたいなら,sys.path に〜/psp2/extention
が必要
from extention import ext2
としたいなら,sys.path に〜/psp2
が必要
では,実際に調べてみよう.
myapp/main.py
import sys
print(sys.path)
これを動かしてみよう.
vscode のコード編集タブの実行ボタンから実行した場合,表示されるパスにextention
の 1 つ上までの絶対パスは入っているだろうか??おそらく入っておらず,myapp/main.py
からはどうやってもext1.py
はインポートできない.
また,仮想環境の外,つまり,vscode の編集タブの実行ボタンからではなく,コマンドプロンプトでpy myapp/main.py
としてみよう.この場合でもsys.path
に,今必要なパスは入っていない.
よって「無理」である.どうしてもextention/ext1.py
をインポートしたいなら,sys.path
で示されたパスの直下にextention/ext1.py
を置く(つまりextention
フォルダを移動する)しか方法がない.手っ取り早いのは,
psp2
├── Readme.md
├── myapp
│ ├── main.py
│ └── extention
│ └── ext1.py
├── poetry.lock
└── pyproject.toml
のようにmain.py
と同じ階層にextention
を移動すれば,from extention import ext1
とできる.
sys.path
に手動で module のパスを追加する.
import sys # <- 追加
sys.path.append('..') # <- main.pyに対するextentionの1つ上の階層の相対パス
from extention import ext1
それは「サイトパッケージ」に,ext1.py
のあるディレクトリextension
の 1 つ上の階層を加えることである.
(別の言い方をすれば,「extention
をインストールした形に見せかける」といってもよい)
通常の環境では,サイトパッケージは変えられないので無理だが,仮想環境なら好きなように変えられる.
poetry の作る仮想環境のサイトパッケージを変えるには,
pyproject.toml
のtool.poetry
に設定を加える.
psp2
├── .venv
├── extention
│ └── ext1.py
├── myapp
│ └── main.py
├── poetry.lock
└── pyproject.toml
という状況のとき,pyproject.toml
のtool.poetry
に
packages = [{include = "extention" }]
という行を追加し,psp2 の直下にReadme.md
があることを確認してから,poetry install
してください.
そうすると,vscode のコード編集タブの実行ボタンから実行した場合(仮想環境の中),表示されるパスにextention
の 1 つ上までの絶対パスである〜\psp2
が追加されていることが確認される.
ちなみに,仮想環境の外ではsys.path
に所望のパスは追加されていない.
from X.Y import a as b
したあとにこのb
のインポートをやめたいときは,
del b
すればよい.