note.nkmk.me

Pythonで実行ファイルの場所(パス)を取得する__file__

Date: 2018-07-22 / tags: Python, ファイル操作

Pythonで実行スクリプトファイルxxx.pyの場所(パス)を取得するには__file__を使う。実行ファイルの場所を基準にほかのファイルを読み込んする場合に便利。

__file__で得られるのはカレントディレクトリ(作業ディレクトリ)からの相対パス。標準ライブラリのosモジュールを使うと絶対パスを取得することもできる。

以下の内容について説明する。

  • os.getcwd()__file__
  • 実行ファイルのファイル名、ディレクトリ名を取得
  • 実行ファイルの絶対パスを取得
  • 実行ファイルの場所を基準にほかのファイルを読み込み
  • カレントディレクトリを実行ファイルのディレクトリに移動
  • 実行時のカレントディレクトリに依存せず同じ処理が可能

カレントディレクトリ(作業ディレクトリ)の取得、変更については以下の記事を参照。

なお、Jupyter Notebook(xxx.ipynb)では__file__は使えないので注意。

スポンサーリンク

os.getcwd()と__file__

以下のディレクトリで作業するものとする。Windowsではpwdではなくdirコマンドでカレントディレクトリを確認可能。

pwd
# /Users/mbp/Documents/my-project/python-snippets/notebook

下の階層(data/src)に以下の内容のPythonのスクリプトファイル(file_path.py)を作成。

import os

print('getcwd:      ', os.getcwd())
print('__file__:    ', __file__)
source: file_path.py

pythonコマンドで指定して実行する。

python3 data/src/file_path.py
# getcwd:       /Users/mbp/Documents/my-project/python-snippets/notebook
# __file__:     data/src/file_path.py

os.getcwd()でカレントディレクトリが、__file__で実行したスクリプトファイルのカレントディレクトリからの相対パスが取得できている。

以降の例では同じスクリプトファイル(file_path.py)に追記して、上記のディレクトリから実行するものとする。

実行ファイルのファイル名、ディレクトリ名を取得

実行ファイルのファイル名、ディレクトリ名を取得するには標準ライブラリのosモジュールの関数os.basename(), os.dirname()を使う。

print('basename:    ', os.path.basename(__file__))
print('dirname:     ', os.path.dirname(__file__))
source: file_path.py

実行結果。

# basename:     file_path.py
# dirname:      data/src

osモジュールの関数os.basename(), os.dirname()などについての詳細は以下の記事を参照。

実行ファイルの絶対パスを取得

__file__で取得できるのはカレントディレクトリからの相対パスだが、os.abspath()で絶対パスに変換できる。ディレクトリも絶対パスで取得可能。

print('abspath:     ', os.path.abspath(__file__))
print('abs dirname: ', os.path.dirname(os.path.abspath(__file__)))
source: file_path.py

実行結果。

# abspath:      /Users/mbp/Documents/my-project/python-snippets/notebook/data/src/file_path.py
# abs dirname:  /Users/mbp/Documents/my-project/python-snippets/notebook/data/src

実行ファイルの場所を基準にほかのファイルを読み込み

実行ファイルの場所(パス)を基準にほかのファイルを読み込みたい場合は、実行ファイルのディレクトリと読み込みたいファイルの実行ファイルからの相対パスをos.path.join()で連結する。

実行ファイルと同じディレクトリのファイルを読み込む場合はファイル名のみを指定すればOK。

print('[set target path 1]')
target_path_1 = os.path.join(os.path.dirname(__file__), 'test.txt')

print('target_path_1: ', target_path_1)

print('read target file:')
with open(target_path_1) as f:
    print(f.read())
source: file_path.py

実行結果。

# [set target path 1]
# target_path_1:  data/src/test.txt
# read target file:
# line 1
# line 2
# line 3

上の階層は../で表す。

print('[set target path 2]')
target_path_2 = os.path.join(os.path.dirname(__file__), '../dst/test_new.json')

print('target_path_2: ', target_path_2)

print('read target file:')
with open(target_path_2) as f:
    print(f.read())
source: file_path.py

実行結果。

# [set target path 2]
# target_path_2:  data/src/../dst/test_new.json
# read target file:
# {
#   "A": 100,
#   "B": "abc",
#   "C": "あいうえお"
# }

ファイルの読み込みについては以下の記事を参照。

カレントディレクトリを実行ファイルのディレクトリに移動

スクリプト内でカレントディレクトリを実行ファイルのディレクトリに移動する場合はos.chdir()を使う。

os.getcwd()で移動していることが確認できる。

print('[change directory]')
os.chdir(os.path.dirname(os.path.abspath(__file__)))
print('getcwd:      ', os.getcwd())
source: file_path.py

実行結果。

# [change directory]
# getcwd:       /Users/mbp/Documents/my-project/python-snippets/notebook/data/src

カレントディレクトリを移動すれば、ファイルを読み込む場合に実行ファイルのディレクトリと連結する必要はない。実行ファイルからの相対パスを指定すればOK。

print('[set target path 1 (after chdir)]')
target_path_1 = 'test.txt'

print('target_path_1: ', target_path_1)

print('read target file:')
with open(target_path_1) as f:
    print(f.read())

print()
print('[set target path 2 (after chdir)]')
target_path_2 = '../dst/test_new.json'

print('target_path_2: ', target_path_2)

print('read target file:')
with open(target_path_2) as f:
    print(f.read())
source: file_path.py

実行結果。

# [set target path 1 (after chdir)]
# target_path_1:  test.txt
# read target file:
# line 1
# line 2
# line 3
# 
# [set target path 2 (after chdir)]
# target_path_2:  ../dst/test_new.json
# read target file:
# {
#   "A": 100,
#   "B": "abc",
#   "C": "あいうえお"
# }

実行時のカレントディレクトリに依存せず同じ処理が可能

__file__を使って実行ファイルパスを取得すると、実行時のカレントディレクトリに依存せず同じ処理を行うことが可能。

これまでの例の結果をまとめて示す。

pwd
# /Users/mbp/Documents/my-project/python-snippets/notebook

python3 data/src/file_path.py
# getcwd:       /Users/mbp/Documents/my-project/python-snippets/notebook
# __file__:     data/src/file_path.py
# basename:     file_path.py
# dirname:      data/src
# abspath:      /Users/mbp/Documents/my-project/python-snippets/notebook/data/src/file_path.py
# abs dirname:  /Users/mbp/Documents/my-project/python-snippets/notebook/data/src
# 
# [set target path 1]
# target_path_1:  data/src/test.txt
# read target file:
# line 1
# line 2
# line 3
# 
# [set target path 2]
# target_path_2:  data/src/../dst/test_new.json
# read target file:
# {
#   "A": 100,
#   "B": "abc",
#   "C": "あいうえお"
# }
# 
# [change directory]
# getcwd:       /Users/mbp/Documents/my-project/python-snippets/notebook/data/src
# 
# [set target path 1 (after chdir)]
# target_path_1:  test.txt
# read target file:
# line 1
# line 2
# line 3
# 
# [set target path 2 (after chdir)]
# target_path_2:  ../dst/test_new.json
# read target file:
# {
#   "A": 100,
#   "B": "abc",
#   "C": "あいうえお"
# }

ターミナルでカレントディレクトリを移動して同じスクリプトファイルを実行。異なる場所から実行しても同じファイルを読み出せているのが確認できる。

cd data/src

python3 file_path.py
# getcwd:       /Users/mbp/Documents/my-project/python-snippets/notebook/data/src
# __file__:     file_path.py
# basename:     file_path.py
# dirname:      
# abspath:      /Users/mbp/Documents/my-project/python-snippets/notebook/data/src/file_path.py
# abs dirname:  /Users/mbp/Documents/my-project/python-snippets/notebook/data/src
# 
# [set target path 1]
# target_path_1:  test.txt
# read target file:
# line 1
# line 2
# line 3
# 
# [set target path 2]
# target_path_2:  ../dst/test_new.json
# read target file:
# {
#   "A": 100,
#   "B": "abc",
#   "C": "あいうえお"
# }
# 
# [change directory]
# getcwd:       /Users/mbp/Documents/my-project/python-snippets/notebook/data/src
# 
# [set target path 1 (after chdir)]
# target_path_1:  test.txt
# read target file:
# line 1
# line 2
# line 3
# 
# [set target path 2 (after chdir)]
# target_path_2:  ../dst/test_new.json
# read target file:
# {
#   "A": 100,
#   "B": "abc",
#   "C": "あいうえお"
# }
スポンサーリンク
シェア
このエントリーをはてなブックマークに追加

関連カテゴリー

関連記事