build: PyInstallerをv6へ更新

.github/workflows/build-engine.yml

@@ -472,10 +472,10 @@ jobs:
             LIBONNXRUNTIME_PATH=download/onnxruntime/lib/libonnxruntime.so
           fi
 
-          CORE_MODEL_DIR_PATH="download/core/model" \
-          LIBCORE_PATH="$LIBCORE_PATH" \
-          LIBONNXRUNTIME_PATH="$LIBONNXRUNTIME_PATH" \
-          uv run pyinstaller --noconfirm run.spec
+          uv run pyinstaller --noconfirm run.spec -- \
+            --libcore_path="$LIBCORE_PATH" \
+            --libonnxruntime_path="$LIBONNXRUNTIME_PATH" \
+            --core_model_dir_path="download/core/model"
 
       # Because PyInstaller does not copy dynamic loaded libraries,
       # manually move DLL dependencies into `dist/run/` (cache already saved)

CONTRIBUTING.md

@@ -351,10 +351,10 @@ bash tools/create_venv_and_generate_licenses.bash
 uv run pyinstaller --noconfirm run.spec
 
 # 製品版でビルドする場合
-CORE_MODEL_DIR_PATH="/path/to/core_model" \
-LIBCORE_PATH="/path/to/libcore" \
-LIBONNXRUNTIME_PATH="/path/to/libonnxruntime" \
-uv run pyinstaller --noconfirm run.spec
+uv run pyinstaller --noconfirm run.spec -- \
+--libcore_path="/path/to/libcore" \
+--libonnxruntime_path="/path/to/libonnxruntime" \
+--core_model_dir_path="/path/to/core_model"
 ```
 
 TODO: Docker 版のビルド手順を GitHub Actions をベースに記述する

pyproject.toml

@@ -30,7 +30,7 @@ default-groups = []
 pyopenjtalk = { git = "https://github.com/VOICEVOX/pyopenjtalk", rev = "74703b034dd90a1f199f49bb70bf3b66b1728a86" }
 
 [dependency-groups]
-build = ["pyinstaller<6"] # NOTE: PyInstaller6ではmacOSのエディタにバンドルすると動作しなくなる (ref: https://github.com/VOICEVOX/voicevox_engine/issues/1022)
+build = ["pyinstaller>=6"]
 dev = [
   "coveralls>=4.0.1",
   "httpx>=0.28.1", # NOTE: required by fastapi.testclient.TestClient (fastapi-slim's unmanaged dependency)

requirements-build.txt

@@ -13,13 +13,13 @@ macholib==1.16.3 ; sys_platform == 'darwin'
 markupsafe==3.0.2
 numpy==2.2.4
 packaging==24.2
-pefile==2024.8.26 ; sys_platform == 'win32'
+pefile==2023.2.7 ; sys_platform == 'win32'
 platformdirs==4.3.7
 pycparser==2.22
 pydantic==2.11.3
 pydantic-core==2.33.1
-pyinstaller==5.13.2
-pyinstaller-hooks-contrib==2025.2
+pyinstaller==6.14.2
+pyinstaller-hooks-contrib==2025.5
 pyopenjtalk @ git+https://github.com/VOICEVOX/pyopenjtalk@74703b034dd90a1f199f49bb70bf3b66b1728a86
 python-multipart==0.0.20
 pywin32-ctypes==0.2.3 ; sys_platform == 'win32'

run.spec

@@ -1,67 +1,51 @@
 # -*- mode: python ; coding: utf-8 -*-
 # このファイルはPyInstallerによって自動生成されたもので、それをカスタマイズして使用しています。
-from PyInstaller.utils.hooks import collect_data_files
-import os
-
-datas = [
-    ('resources', 'resources'),
-    ('engine_manifest.json', '.'),
-    ('licenses.json', '.'),
-]
-datas += collect_data_files('pyopenjtalk')
+from argparse import ArgumentParser
+from pathlib import Path
+from shutil import copy2, copytree
 
-core_model_dir_path = os.environ.get('CORE_MODEL_DIR_PATH')
-if core_model_dir_path:
-    print('CORE_MODEL_DIR_PATH is found:', core_model_dir_path)
-    if not os.path.isdir(core_model_dir_path):
-        raise Exception("CORE_MODEL_DIR_PATH was found, but it is not directory!")
-    datas += [(core_model_dir_path, "model")]
+from PyInstaller.utils.hooks import collect_data_files
 
-# コアとONNX Runtimeはバイナリであるが、`binaries`に加えると
-# 依存関係のパスがPyInstallerに書き換えらるので、`datas`に加える
-# 参考: https://github.com/VOICEVOX/voicevox_engine/pull/446#issuecomment-1210052318
-libcore_path = os.environ.get('LIBCORE_PATH')
-if libcore_path:
-    print('LIBCORE_PATH is found:', libcore_path)
-    if not os.path.isfile(libcore_path):
-        raise Exception("LIBCORE_PATH was found, but it is not file!")
-    datas += [(libcore_path, ".")]
+parser = ArgumentParser()
+parser.add_argument("--libcore_path", type=Path)
+parser.add_argument("--libonnxruntime_path", type=Path)
+parser.add_argument("--core_model_dir_path", type=Path)
+options = parser.parse_args()
 
-libonnxruntime_path = os.environ.get('LIBONNXRUNTIME_PATH')
-if libonnxruntime_path:
-    print('LIBONNXRUNTIME_PATH is found:', libonnxruntime_path)
-    if not os.path.isfile(libonnxruntime_path):
-        raise Exception("LIBCORE_PATH was found, but it is not file!")
-    datas += [(libonnxruntime_path, ".")]
+libcore_path: Path | None = options.libcore_path
+if libcore_path is not None and not libcore_path.is_file():
+    raise Exception(f"libcore_path: {libcore_path} is not file")
 
+libonnxruntime_path: Path | None = options.libonnxruntime_path
+if libonnxruntime_path is not None and not libonnxruntime_path.is_file():
+    raise Exception(f"libonnxruntime_path: {libonnxruntime_path} is not file")
 
-block_cipher = None
+core_model_dir_path: Path | None = options.core_model_dir_path
+if core_model_dir_path is not None and not core_model_dir_path.is_dir():
+    raise Exception(f"core_model_dir_path: {core_model_dir_path} is not dir")
 
 
 a = Analysis(
-    ['run.py'],
+    ["run.py"],
     pathex=[],
     binaries=[],
-    datas=datas,
+    datas=collect_data_files("pyopenjtalk"),
     hiddenimports=[],
     hookspath=[],
     hooksconfig={},
     runtime_hooks=[],
     excludes=[],
-    win_no_prefer_redirects=False,
-    win_private_assemblies=False,
-    cipher=block_cipher,
     noarchive=False,
 )
 
-pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
+pyz = PYZ(a.pure)
 
 exe = EXE(
     pyz,
     a.scripts,
     [],
     exclude_binaries=True,
-    name='run',
+    name="run",
     debug=False,
     bootloader_ignore_signals=False,
     strip=False,
@@ -72,15 +56,37 @@ exe = EXE(
     target_arch=None,
     codesign_identity=None,
     entitlements_file=None,
+    contents_directory="engine_internal",  # 実行時に"sys._MEIPASS"が参照するディレクトリ名
 )
 
 coll = COLLECT(
     exe,
     a.binaries,
-    a.zipfiles,
     a.datas,
     strip=False,
     upx=True,
     upx_exclude=[],
-    name='run',
+    name="run",
 )
+
+# 実行ファイルのディレクトリに配置するファイルのコピー
+
+# 実行ファイルと同じrootディレクトリ
+target_dir = Path(DISTPATH) / "run"
+
+# リソースをコピー
+manifest_file_path = Path("engine_manifest.json")
+copy2(manifest_file_path, target_dir)
+copytree("resources", target_dir / "resources")
+
+license_file_path = Path("licenses.json")
+if license_file_path.is_file():
+    copy2("licenses.json", target_dir)
+
+# 動的ライブラリをコピー
+if libonnxruntime_path is not None:
+    copy2(libonnxruntime_path, target_dir)
+if core_model_dir_path is not None:
+    copytree(core_model_dir_path, target_dir / "model")
+if libcore_path is not None:
+    copy2(libcore_path, target_dir)