Pythonで他のディレクトリからプログラムをimportするやり方

Question

Pythonで親ディレクトリの親ディレクトリのファイルをimportしたいのですが
以下のようなコードでは, 読み込める時と読み込めない時があります。

読み込めない時と読み込めない時の例ですが
今日読み込めたのにもかかわらず、次の日に読み込めなくなるということが以下のコードでは起こります。

import sys,os
sys.path.append('../../') # 親ディレクトリの親ディレクトリを読み込む

from ... import *  # ... : 親ディレクトリの親ディレクトリのフォルダ名, * : そのフォルダ内のimportしたいプログラム名

他におすすめのファイルの読み込み方法はあるでしょうか。

よろしくお願いいたします。

Comments

[shimizukawa]

「読み込み」とはファイルをopen()で開くことではなく 「import したい」という意味ですよね？であれば、そのように質問を書いた方がよいです。あと、「読み込めるときと読み込めないときがある」というのは具体的に、「どうしたら、どうなった」のでしょうか？操作手順と結果を提示してください。

[jimmypage0311]

タイトル、質問を編集いたしましたのでよろしくお願いいたします。

Answer 1

sys.path をスクリプト内で調整することはあまり推奨されません。
色々なところで使いたいライブラリを置いているディレクトリが固定で、そのライブラリをimportしたいのであれば、環境変数 PYTHONPATH を設定する方法があります。

ライブラリが /path/to/pythonfiles にあるとして、今編集しているスクリプトが /path/to/pythonfiles/sub/sub/current.py だとします。

環境変数を以下のように設定します。
(Mac, Linuxの場合)

export PYTHONPATH=/path/to/pythonfiles

(Windowsの場合)

set PYTHONPATH=/path/to/pythonfiles

この状態でプログラムcurrent.pyを実行すれば、current.pyがどこにっても、/path/to/pythonfiles以下にあるモジュールをimportできます。このときcurrent.pyのコード上でsys.path.appendは不要です。

なお、この方法でPYTHONPATHを設定しすぎると、環境がぐちゃぐちゃになっていくので、よく分からない内は複数のパスを設定するのはやめたほうがよいと思います。

ところで、先ほど説明した方法で環境変数を設定しても、シェルを閉じるとその設定は失われてしまいます。
OS起動時に自動的にこれを設定する方法については、各OSの話になるので省略します。

---

蛇足ですが、以下を実行するとPythonのライブラリパス(PYTHONPATH)が確認できます。

python -c "import sys;print(sys.path)"

普段使っている import os なども、上記で表示されるディレクトリのどこかに os.py があってそれが読み込まれているのが分かると思います。

Answer 2

'../../'は、実行時のカレントディレクトリの親の親なので、実行時のカレントディレクトリがどこであるかによって成功したり失敗したりするんだと思います。

すでに回答がついていますが、スクリプトファイルの存在するディレクトリを基準にするように書き直す必要があります。

Answer 3

os.pathモジュールを使うのがおすすめです。
OSごとのパスの扱いの違いを吸収してくれます。

参考（具体的な使い方）：[Python]ファイル/ディレクトリ操作

Answer 4

相対importという手段もあります。

• Python 言語リファレンス: 7.11 import文

インポートするモジュールを指定するとき、そのモジュールの絶対名 (absolute name) を指定する必要はありません。モジュールやパッケージが他のパッケージに含まれている場合、共通のトップパッケージからそのパッケージ名を記述することなく相対インポートすることができます。 from の後に指定されるモジュールやパッケージの先頭に複数個のドットを付けることで、正確な名前を指定することなしに現在のパッケージ階層からいくつ上の階層へ行くかを指定することができます。先頭のドットが 1 つの場合、 import をおこなっているモジュールが存在する現在のパッケージを示します。 3 つのドットは 2 つ上のレベルを示します。なので、 pkg パッケージの中のモジュールで from . import mod を実行すると、 pkg.mod をインポートすることになります。 pkg.subpkg1 の中から from ..subpkg2 import mod を実行すると、 pkg.subpkg2.mod をインポートします。相対インポートの仕様は PEP 328 に含まれています。

例えば、

$ find . -name '*.py'
./pkg/subpkg1/piyo.py
./pkg/subpkg1/hoge.py
./pkg/subpkg2/fuga.py
./pkg/foo.py

というようなディレクトリ構成で、各スクリプトは

# coding: utf-8
# pkg/subpkg1/hoge.py

from .piyo import *
from ..subpkg2.fuga import *
from ..foo import *

# coding: utf-8
# pkg/subpkg1/piyo.py

print('Hello, piyo.')

# coding: utf-8
# pkg/subpkg2/fuga.py

print('Hello, fuga.')

# coding: utf-8
# pkg/foo.py

print('Hello, foo.')

というような内容であった場合、

import pkg.subpkg1.hoge

というスクリプトを実行すると、

Hello, piyo.
Hello, fuga.
Hello, foo.

と、ちゃんとimportが実行されます。

ただし、注意が必要です。

まず、相対importが使えるのはモジュールの中のみです。
importされたスクリプトでないと、使えません。

例えば、上記のhoge.pyを、

python3 pkg/subpkg1/hoge.py

と直接してしてして実行すると、

Traceback (most recent call last):
  File "pkg/subpkg1/hoge.py", line 3, in <module>
    from .piyo import *
SystemError: Parent module '' not loaded, cannot perform relative import

と怒られます。

あと、使えるのは「from - import」文のみで

import .piyo

というようには使えません。

あと、うちのlinuxではpython2では動きません。
上記のリファレンスの説明は、Python2.7のリファレンスにも書かれているので、使えると思うんですけどねぇ…。

このようにめんどくさい点はあるのだけど、こういう記述もできる、というぐらいには知っておいてもいいかと思います。

---

追記:
あれ、質問文を読み直したら、既に知ってるのかな?
だとしたら余計な回答かもしれませんが、どっちとも取れるので、一応書いておきますね。

Comments

[jijijiji]

python3で実行してみました。
一度目はうまく動くのですが、2回目以降は動作しません。
各ディレクトリに__pycache＿＿という新規のディレクトリが作成されそのなかに__pycache＿＿が作成されたディレクトリにある.pyファイル名の.py拡張子部分が.cpython-36.pycに変換されたものが入っています。
一旦pythonを終了してから再度pythonを立ち上げ実行するともう一度作動しますが、やはり2回目以降は何も表示されません。対策がわかればお教え下さい

Answer 5

スクリプトファイルを基準にするならば、このような方法で親ディレクトリを取得できます。

from os import path, pardir

current_dir = path.abspath(path.dirname(__file__))  # スクリプトのディレクトリ
parent_dir = path.abspath(path.join(current_dir, pardir))  # スクリプトの親ディレクトリ
parent_parent_dir = path.abspath(path.join(parent_dir, pardir))  # 上記の親ディレクトリ

print(current_dir)
print(parent_dir)
print(parent_parent_dir)

ターミナルやJupyter notebook上では上記の方法はつかえないためご注意ください。

Answer 6

sys.path.appendを呼ぶのは良い手とはいえません。
sys.pathは全てのモジュールが参照するリストですので、他のモジュールに影響を及ぼす可能性があります。
例えば、あるモジュールを外すと今まで動いていたモジュールが、途端にimport Errorが発生する、挙動が変わってしまうなどです。

私は相対インポートで解決が良いと思います。

コードを拝見すると既に相対インポートされていますが、さらにsys.path.appendしているという事は相対インポートで上手く動作していないのだと推察します。
おそらくトップレベルスクリプト（起動スクリプト）よりも上の階層のモジュールをインポートしているのではないでしょうか？
相対インポートは、トップレベルスクリプトよりも上の階層はインポートできません。

対策としては起動のためだけのスクリプトを階層の一番上に置き、今までトップスクリプトとして扱ってきたものをモジュールとしてimportしてはどうでしょうか？
これならば相対インポートで上の階層のモジュールをインポートすることができます。