[Python exe化]実行ファイル化したPythonプログラムでは__file__を使わない方が良い。[path バグる原因]

# はじめに

Pythonでプログラムを作っていく中で、**他ファイル/フォルダを参照する**という場面は一般的なものです。例えば

* エクセルファイルを参照してユーザーの入力を反映する
* 画像ファイルを参照して描画する
* データ出力先のディレクトリを探す

といったような場面です。このような場合、参照先のディレクトリやファイルのパスを皆さんはどのように管理するでしょうか？

* カレントディレクトリからの相対パス
* `main.py`からの相対パス
* 絶対パスに変換して管理する

のような方法がまず思いつきます。

# \_\_file__

翻って、pythonでパスの管理をする際、よくお目にかかるであろう変数があります。`__file__`です。
`__file__`は、そのコード自身のパスを保持しています。python3.8まではカレントディレクトリからの相対パスでしたが、python3.9以降は絶対パスを保持しています。以下のように使ったりします。便利です。

```python

# main.pyからの相対パスを絶対パスで管理
PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'file.txt') # python3.8以前
PATH = os.path.join(os.path.dirname(__file__), 'file.txt') # python3.9以降
PATH = Path(__file__).parent // 'file.txt' # pathlibを使用した場合
```

さて、この`__file__`。通常はエラーの原因になりにくい変数です。
しかし、**pythonファイルのexe化**では、`__file__`には注意しなければなりません。
exe化したファイルの`__file__`変数に格納されているのは何でしょうか。

1. exe化したファイル自身のパス
1. もととなった.pyファイルのパス
1. 存在しないファイルのパス
1. 空文字列
1. exe化の手法によってバラバラ

1.だったらうれしいですよね。
実は5.が正解となります。
これが結構厄介で、**exe化したら動かなくなった！**、の原因となることもあります。

ということで、いろいろな手法でexe化して、`__file__`の挙動を詳しく調べてみました。
結果と対策方法を見たい方 => [結果まとめ&対策方法](#まとめ)


# 検証

実行ファイルにおける`__file__`, `os.getcwd()`, `sys.executable`の挙動を確認しました。

## 検証内容

以下の内容を検証します。

* `__file__`: `main.py`の相対パス(python < 3.9)、絶対パス(python >= 3.9)
* `os.getcwd()`: カレントディレクトリの絶対パス
* `os.path.abspath(__file__)`: `main.py`の絶対パス
* `Path(__file__).parent`: `main.py`があるディレクトリ
* `sys.executable`: Python インタプリタの実行ファイル(`python.exe`)の絶対パスを示す


## 検証環境

* Windows10
* Python 3.9.4
* Poetry version 1.1.6

```toml:pyproject.toml
python = "^3.9,<3.10" 
pyinstaller = "^4.3"
cx-Freeze = "^6.6"
py2exe = "^0.10.4"
```

pythonのバージョンは、デフォルト指定で"^3.9"で、これは3.8<=pythonのバージョン<4.0を示しています。しかしpy2exeが"^3.9,<3.10"という指定のため上限も指定しています。

### その他

デフォルトのカレントディレクトリ`C:\test`
ターゲットファイル`C:\test\test.py`
実行ファイル名: `test.exe`
としています。

## 検証結果

pyinstaller, cx_Freeze, py2txtそれぞれでexe作成を行い、実行ファイルを実行します。
実行の仕方として、

1. `C:\test`からコンソール実行
1. `test.exe`のあるディレクトリに移動してコンソール実行
1. エクスプローラーから本体をダブルクリックで実行
1. デスクトップ作成したショートカットをダブルクリックで実行

の3種類試しています。

ソースコードは

```python:test.py
import os
import sys
from pathlib import Path

print(f"1. __file__ =>                  {__file__}")
print(f"2. os.getcwd() =>               {os.getcwd()}")
print(f"3. os.path.abspath(__file__) => {os.path.abspath(__file__)}")
print(f"4. Path(__file__).parent =>     {Path(__file__).parent}")
print(f"5. sys.executable =>            {sys.executable}")
```


### 0. pythonでそのまま実行

コントロールとして、exe化せずにそのまま実行しました。

```
# poetry run pytnon test.py で実行

1. __file__ =>                  C:\test\test.py
2. os.getcwd() =>               C:\test
3. os.path.abspath(__file__) => C:\test\test.py
4. Path(__file__).parent =>     C:\test
5. sys.executable =>            C:\test\.venv\Scripts\python.exe
```
1~5で不審な点は見当たりません。poetryの仮想環境で検証しているため5.のパスは仮想環境内のpythonのパスを示しています。


### 1. pyinstallerの場合

以下のコマンドでexeの作成を行いました。

```powershell
poetry run pyinstaller test.py
```
`C:\test\dist\test\test.exe`が実行ファイルのパスです。

#### 結果

```
# dist\test\test.exe での実行
1. __file__ =>                  C:\test\dist\test\test.py
2. os.getcwd() =>               C:\test
3. os.path.abspath(__file__) => C:\test\dist\test\test.py
4. Path(__file__).parent =>     C:\test\dist\test
5. sys.executable =>            C:\test\dist\test\test.exe

# cd dist\test && test.exe での実行
1. __file__ =>                  C:\test\dist\test\test.py
2. os.getcwd() =>               C:\test\dist\test
3. os.path.abspath(__file__) => C:\test\dist\test\test.py
4. Path(__file__).parent =>     C:\test\dist\test
5. sys.executable =>            C:\test\dist\test\test.exe

# 本体をダブルクリックで実行
1. __file__ =>                  C:\test\dist\test\test.py
2. os.getcwd() =>               C:\test\dist\test
3. os.path.abspath(__file__) => C:\test\dist\test\test.py
4. Path(__file__).parent =>     C:\test\dist\test
5. sys.executable =>            C:\test\dist\test\test.exe

# ショートカットをダブルクリックで実行
__file__ =>                  C:\test\dist\test\test.py
os.getcwd() =>               C:\test\dist\test
os.path.abspath(__file__) => C:\test\dist\test\test.py
Path(__file__).parent =>     C:\test\dist\test
sys.executable =>            C:\test\dist\test\test.exe
```

1. の結果は変です。4通りとも`C:\test\dist\test\test.py`というパスを表示しましたが、`C:\test\dist\test`にあるのは`test.exe`であり`test.py`は存在しません。
1. の結果で不審な点はありません。ダブルクリックの際は本体があるディレクトリを示しています。
1. の結果で不審な点はありません（python3.9で実行しているので当たり前です）。
1. の結果で不審な点はありません（1.のファイル名はおかしいですが親ディレクトリまでのパスは`test.exe`のパスと等しいので使えるっちゃあ使える？）
1. これはびっくり。`python.exe`でも`None`でもなく、作成した実行ファイルのパスが格納されています。このパスをもとに相対パスなどを指定してやるのが安全で便利そうです。


### 2. cx_Freezeの場合
cx_Freezeでexeを作成する場合、`setup.py`という設定ファイルを記述する必要があります。今回はpy2txtの`setup.py`と差別化するため、`setup_cx_freeze.py`という名前にしました。
ソースコードは以下のようになります。

```python:setup_cx_freeze.py
import sys
from cx_Freeze import setup, Executable

build_exe_options = {"packages": ["os", "sys", "pathlib"], "excludes": ["tkinter"]}

setup(
    name = "test",
    version = "0.1",
    description = "My GUI application!",
    options = {"build_exe": build_exe_options},
    executables = [Executable("test.py")]
)
```
見よう見まねで作成しました。

exeの作成は以下のコマンドにより行いました。

```powershell
poetry run python setup_cx_freeze.py build
```

`C:\test\build\exe.win-amd64-3.9\test.exe`が実行ファイルのパスです。

#### 結果

```
# build\exe.win-amd64-3.9\test.exe での実行
1. __file__ =>                  test.py
2. os.getcwd() =>               C:\test
3. os.path.abspath(__file__) => C:\test\test.py
4. Path(__file__).parent =>     .
5. sys.executable =>            C:\test\build\exe.win-amd64-3.9\test.exe

# cd build\exe.win-amd64-3.9 && test.exe での実行
1. __file__ =>                  test.py
2. os.getcwd() =>               C:\test\build\exe.win-amd64-3.9
3. os.path.abspath(__file__) => C:\test\build\exe.win-amd64-3.9\test.py
4. Path(__file__).parent =>     .
5. sys.executable =>            C:\test\build\exe.win-amd64-3.9\test.exe

# 本体をダブルクリックで実行
1. __file__ =>                  test.py
2. os.getcwd() =>               C:\test\build\exe.win-amd64-3.9
3. os.path.abspath(__file__) => C:\test\build\exe.win-amd64-3.9\test.py
4. Path(__file__).parent =>     .
5. sys.executable =>            C:\test\build\exe.win-amd64-3.9\test.exe

# ショートカットをダブルクリックで実行
1. __file__ =>                  test.py
2. os.getcwd() =>               C:\test\build\exe.win-amd64-3.9
3. os.path.abspath(__file__) => C:\test\build\exe.win-amd64-3.9\test.py
4. Path(__file__).parent =>     .
5. sys.executable =>            C:\test\build\exe.win-amd64-3.9\test.exe
```

1. の結果は変です。ファイル名でなく相対パスとして考えると、カレントディレクトリ中の`test.py`を指していますが、実際にそのようなファイルはありません。
1. の結果で不審な点はありません。ダブルクリックの際は本体があるディレクトリを示しています。
1. の結果は変です。`os.path.join(os.getcwd(), __file__)`という雰囲気です。
1. 1.の結果の親を表すため、カレントディレクトリの相対パス`.`が表示されています。`python.exe`からの相対パスを知りたい場合にこのように書くのは危ないかな。
1. pyinstallerと同様に、作成した実行ファイルのパスが格納されています。便利。

### 3. py2exeの場合
py2exeでexeを作成する場合、`setup.py`という設定ファイルを記述する必要があります。今回はcx_Freezeの`setup.py`と差別化するため、`setup_py2exe.py`という名前にしました。
ソースコードは以下のようになります。

```python:setup_py2exe.py
from distutils.core import setup
import setuptools
import py2exe

setup(
    console = [{'script': 'test.py'}] # exe化するファイル
)
```
見よう見まねで作成しました。

exeの作成は以下のコマンドにより行いました。

```powershell
poetry run python setup_py2txt.py py2txt
```

`C:\test\dist\test.exe`が実行ファイルのパスです。

#### 結果

```
# dist\test.exe での実行
1. __file__ =>                  #
2. os.getcwd() =>               C:\test
3. os.path.abspath(__file__) => #
4. Path(__file__).parent =>     #
5. sys.executable =>            C:\test\dist\test.exe

# cd dist && test.exe での実行
1. __file__ =>                  #
2. os.getcwd() =>               C:\test\dist
3. os.path.abspath(__file__) => #
4. Path(__file__).parent =>     #
5. sys.executable =>            C:\test\dist\test.exe

# 本体をダブルクリックで実行
1. __file__ =>                  #
2. os.getcwd() =>               C:\test\dist
3. os.path.abspath(__file__) => #
4. Path(__file__).parent =>     #
5. sys.executable =>            C:\test\dist\test.exe  

# ショートカットをダブルクリックで実行
1. __file__ =>                  #
2. os.getcwd() =>               C:\test\dist
3. os.path.abspath(__file__) => #
4. Path(__file__).parent =>     #
5. sys.executable =>            C:\test\dist\test.exe                             
```

`__file__`は未定義でエラーとなりました。そのため`__file__`を用いる1. 3. 4. をコメントアウトしました。

1. #
1. の結果で不審な点はありません。ダブルクリックの際は本体があるディレクトリを示しています。
1. #
1. #
1. pyinstaller, cx_Freezeと同様に、作成した実行ファイルのパスが格納されています。便利。

# まとめ

今回はpyinstaller, cx_Freeze, py2exe3種類の実行ファイル生成方法における、`__file__`, `os.getcwd()`, `sys.executable`の挙動を確認しました。
分かったこと

1. `__file__`は実行ファイルの生成方法によって指し示す先が異なったり、相対・絶対パスが変わったりするので使わない方が良い。
1. os.getcwd()は実行ファイルの生成方法に依らず、正しい挙動を示した。
1. ダブルクリックの際の挙動はショートカット、本体で全く同じ挙動だった。
1. sys.executableは、実行ファイルの場合は自分自身の絶対パスを返すという挙動だった。

ということで、カレントディレクトリからの相対パスでパスを表現したい場合は今まで通りで問題なさそうだが、自分自身の場所からの相対パスで表したい場合はsys.executableを使う必要がある。しかし、.pyのままだとsys.executableはpython.exeの場所を示してしまう。どうしよう。

# 実は
cx_freezeの公式ドキュメントに書いてありました。

https://cx-freeze.readthedocs.io/en/latest/faq.html?highlight=sys.executable#using-data-files

> Applications often need data files besides the code, such as icons. Using a setup script, you can list data files or directories in the include_files option to build_exe. They’ll be copied to the build directory alongside the executable. Then to find them, use code like this:

> ```python
> def find_data_file(filename):
>    if getattr(sys, "frozen", False):
>        # The application is frozen
>        datadir = os.path.dirname(sys.executable)
>    else:
>        # The application is not frozen
>        # Change this bit to match where you store your data files:
>        datadir = os.path.dirname(__file__)
>    return os.path.join(datadir, filename)
> ```

> An alternative is to embed data in code, for example by using Qt’s resource system.

サンプルコードでは、任意のファイルにアクセスしたい場合に、実行ファイルからの相対パスを引数として、絶対パスを返してくれる関数です。
実行ファイル化された場合はif文のコードが実行され、Pythonのまま実行した場合はelse以降が実行されます。

cx_freezeの公式ドキュメントの内容ですが、pyinstaller, py2exeを用いた場合も同様の対処で解決可能だと考えられます。