【簡単Python】exe化するスクリプトは相対パスのコーディング方法に注意｜'file' と os.getcwd()の違い

2024年4月11日 2024年7月28日

運営者・ポテ

アフィリエイト広告を利用しています。

いつもありがとうございます。

Python で作成したプログラムを、Python がインストールされていないPCで実行するにはプログラムを "exe化"する必要があります。

Python で効率化ツールなどを作成しても、普通の会社では自分以外のオフィスワーカー全員に Python がインストールされていることは稀だと思いますので、必然的に exe化して配る必要が生じます。

Pythonスクリプト（.py）を直接実行する場合と異なり、exe化した実行ファイルを実行すると、実行ファイルが一時ディレクトリ（Temp）に展開され、これが問題となる場合があります。

以下に例を示します。

ディレクトリ構造

your_program
├ data ─ data.csv
├ src ─ module.py
├ main.py
└ main.exe

コード

module.py (module.exe):

import os

# カレントディレクトリを取得
cur_dir = os.path.dirname(__file__)

print(cur_dir)

実行結果

これを想定せずにコードの中に何らかの相対パスの記述をしているとエラーが発生します。

実行ファイルが一時ディレクトリ（Tempディレクトリ）に展開されると想定していないため、相対パスの起点となるディレクトリを間違えているためです。

例えば以下のようなコードで、"main.exe" を実行すると "data" ディレクトリにアクセスできないためエラーが発生し、処理が中断されます。（"main.py" は正常に動作します）

main.py(main.exe) :

# 自作モジュールをインポート
from src import module

# 自作モジュールを実行
module.show_file()

input('>>> press any key to shut down')

module.py :

def show_file():

    # 標準ライブラリのインポート
    import os
    import glob

    # カレントディレクトリの取得
    cur_dir = os.path.dirname(__file__)
    os.chdir(cur_dir)

    # dataディレクトリにあるファイルを取得
    file = glob.glob('../data/*')

    # ファイル名を出力
    print(os.path.basename(file[0]))


if __name__ == '__main__':
    show_file()

本稿では、これの解決方法を解説します。

当サイトのプログラミング解説は「わかりやすさ」を追求しています

筆者の記事関連経験／資格

Python 3 エンジニア認定基礎試験合格
一般社団法人Pythonエンジニア育成推進協会によって運営・認定されている民間資格で、経済産業省が定めたガイドライン「ITスキル標準（ITSS）」において、職種：ソフトウェアディベロップメント、専門分野：応用ソフトのレベル1に掲載されています。
Python 使用経験約5年

Contents

【結論】os.getcwd()を使う
os.getcwd() を使用した解決方法の解説
os.getcwd() を使用したコードの具体例
おわりに
Python プログラミングスキルアップのための参考情報

【結論】os.getcwd()を使う

exe実行ファイルが一時ディレクトリ（Temp）に展開されてしまうことによる問題を解決するには "os.getcwd()" を使う。

解説していきます。

os.getcwd() を使用した解決方法の解説

exe化した実行ファイルを実行した時に、'__file__' だと exe が展開された一時ディレクトリのパスを取得します。

一方で、os.getcwd()は exe が置いてあるディレクトリのパスを取得します。

これは '__file__' が一時ディレクトリに展開されたファイルのパスを取得するのに対して、os.getcwd() はexe実行時のカレントディレクトリを取得するためです。

os.getcwd() を使用したコードの具体例

以下のディレクトリ構造において、main.exe から module.py を呼び出して実行した場合でも、module.pyを単独で実行した場合でも、相対パス指定で data.csv にアクセスできるようにするには、以下のようにコードを記述します。

ただし、この方法はディレクトリのパスに”src”という文字列が1回しか出てこないことが前提です。

ディレクトリ構造

your_program
├ data ─ data.csv
├ src ─ module.py
├ main.py
└ main.exe

コード

main.exe (main.py) :

 # 自作モジュールのインポート
from src import module

 # 自作モジュールの実行
module.show_file()

input('>>>press any key to shut down')    # 黒い画面（コンソール画面）を消さないための処理

module.py :

def show_file():
    
    # 標準ライブラリのインポート
    import os
    import glob

    # カレントディレクトリの取得
    cur_dir = os.getcwd()

    # カレントディレクトリが親ディレクトリなのか子ディレクトリなのかによって data への相対パスを変える
    if 'src' in cur_dir:
        path_str = r'../data/*'

    else:
        path_str = r'data/*'

    # dataディレクトリにあるファイルを取得
    file = glob.glob(path_str)

    # ファイル名を出力
    print(os.path.basename(file[0]))


if __name__ == '__main__':
    show_file()