Python 3.10を使用したKivyアプリでのPyInstaller起動クラッシュの修正

PyInstaller で構築された Kivy アプリの起動時のクラッシュについて

PyInstaller を使用して Kivy アプリを構築することは、Python アプリケーションをスタンドアロンの実行可能ファイルにパッケージ化するための一般的なアプローチです。ただし、ビルド プロセスが成功したにもかかわらず、開発者はパッケージ化されたアプリを起動するときに予期しないクラッシュに遭遇することがあります。この問題は、詳細なエラー メッセージが提供されない場合に特にイライラする可能性があります。

この場合、アプリは PyCharm などの開発環境では完全に実行されますが、PyInstaller を使用してパッケージ化すると失敗します。 Kivy 2.3.0、Python 3.10 などの依存関係や、numpy、scipy、pandas などのライブラリでは、問題を解決するためにクラッシュの原因を特定することが重要になります。

明確な痕跡のない「予期しないエラー」のようなエラーは、多くの場合、依存関係の欠落、不正な SPEC ファイル構成、または仮想環境の不整合を示しています。必要なファイルがすべて正しくバンドルされていることを確認することが重要であることを考えると、PyInstaller SPEC ファイルとランタイムの依存関係を確認することは重要なステップです。

この記事では、SPEC ファイルの改善、非表示のインポートの管理、ビルド プロセス中に必要な Kivy 依存関係が正しく処理されるようにすることに重点を置き、クラッシュの考えられる原因を調査します。

指示	使用例
Analysis()	このコマンドは、PyInstaller 分析プロセスを初期化し、バンドルする Python スクリプトと依存関係を探す場所を指定します。これは、非表示のインポートや、バイナリや JSON ファイルなどの外部データを含む、アプリのパッケージ化方法を構成するために不可欠です。
hiddenimports	Analysis() 内のパラメーターは、PyInstaller が自動的に検出できない可能性のある Python パッケージ (numpy、pandas など) を手動で指定するために使用され、ライブラリの欠落に関連するランタイム エラーを防ぎます。
Tree()	このコマンドは COLLECT ステップで使用され、sdl2.dep_bins や glew.dep_bins などのディレクトリ全体が最終ビルドに確実に含まれるようにします。これにより、アプリにグラフィックスとサウンドに必要な Kivy 依存関係が確実に含まれるようになります。
COLLECT()	すべてのコンパイルされたファイル、バイナリ、および依存関係を 1 つの出力ディレクトリに収集します。これにより、すべてのリソース、ライブラリ、ファイルが配布用に正しくバンドルされるようになります。
datas	バンドルされたアプリケーションに特定のファイル (生成された data.json など) を含めるために使用されます。これは、Kivy アプリの JsonStore によって作成された JSON ファイルなどの外部リソースを操作する場合に重要です。
JsonStore()	データを JSON 形式で保存および管理するために使用される特定の Kivy コマンド。パッケージ化後のファイル欠落の問題を回避するには、生成されたファイルを PyInstaller データ構成に明示的に含める必要があります。
upx=True	このオプションは、パッケージ化プロセス中にバイナリの UPX 圧縮を有効にします。生成される実行可能ファイルのサイズは小さくなりますが、互換性の問題が発生する場合があるため、有効化には注意が必要です。
strip=False	バイナリからのデバッグ シンボルの除去を無効にします。これは、特にアプリが最小限のエラー出力でクラッシュする場合に、起動時の問題を診断したり、実行時のエラーを追跡したりするのに役立ちます。
bootloader_ignore_signals	PyInstaller のブートローダーが SIGTERM などのオペレーティング システム信号を無視することを保証するフラグ。これにより、予期しないクラッシュの原因の 1 つとなる可能性がある、起動中のアプリの早期終了を防ぐことができます。

PyInstaller を使用した Kivy アプリ起動エラーのトラブルシューティング

上記で提供されたスクリプトは、非常に特殊な問題、つまり PyInstaller を使用して構築された Kivy アプリが起動時に「予期しないエラー」でクラッシュするという問題の解決に焦点を当てています。最初のスクリプトは、欠落している場合の潜在的な問題に対処します。 。これは、PyInstaller を使用する場合によくある問題です。PyInstaller はすべての依存関係、特に次のようなライブラリを自動的に検出しないためです。 、 、 または サイピー。これらの非表示のインポートを手動で指定することで、 SPEC ファイルのセクションでは、PyInstaller が必要なすべてのモジュールをバンドルしていることを確認し、コンポーネントの不足によるアプリのクラッシュを防ぎます。

スクリプトの 2 番目の重要なステップは、以下を含めることです。 で 段階。このコマンドは、SDL2 ライブラリや GLEW ライブラリなど、Kivy に関連するアプリの依存関係がビルドに正しく含まれていることを確認します。これらは、アプリのグラフィカル インターフェイスをレンダリングするために不可欠です。これらのファイルが含まれていない場合、ビルド プロセスがエラーなく完了しても、Kivy アプリは適切に実行できません。これらのバイナリが含まれていることを確認すると、グラフィックスまたはサウンド コンポーネントの欠落に関連する実行時の問題を回避できます。

このスクリプトは、外部ファイル (たとえば、 キビで。この JSON ファイルは実行時に生成されますが、パッケージ化プロセス中に適切に処理されることを確認することが重要です。の の引数 関数を使用すると、このファイルをバンドルされたアプリに明示的に含めることができます。そうすることで、初期化中に外部データ ファイルが見つからないためにアプリがクラッシュするエラーを回避します。

最後に、UPX 圧縮の使用も確認します。 オプション。 UPX 圧縮は、バンドルされたアプリケーションのサイズを削減し、配布を容易にするために使用されます。ただし、UPX を有効にすると互換性の問題が発生する場合があるため、UPX と組み合わせて使用​​します。 バイナリからデバッグ シンボルが削除されないようにします。デバッグ シンボルを保持することで、実行時のクラッシュやエラーの原因をより適切に追跡できます。ウィンドウ表示のトレースバックを無効にすることも、問題の診断に役立つ設定です。これにより、コンソールにエラー メッセージが表示され、起動時の潜在的な問題についての洞察が得られます。

# Step 1: Modify the SPEC file to include hidden imports manually
# Import necessary dependencies from Kivy, sdl2, and glew
from kivy_deps import sdl2, glew
# Add numpy, pandas, scipy to hidden imports manually
a = Analysis([r'path_to_your_app.py'],
             pathex=['.'],
             binaries=[],
             datas=[],
             hiddenimports=['numpy', 'pandas', 'scipy'],
             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             noarchive=False)
# Add Tree() for all Kivy dependencies to the collect step
coll = COLLECT(exe, Tree('C:\\path_to_project'),
               a.binaries, a.zipfiles, a.datas,
               *[Tree(p) for p in (sdl2.dep_bins + glew.dep_bins)],
               strip=False, upx=True, name='Prototype')

# Step 2: Ensure that the generated JSON file from kivy.storage.jsonstore is included
from kivy.storage.jsonstore import JsonStore
# If JSONStore is used, manually add the JSON file to the build
store = JsonStore('data.json')
# Create the SPEC file to explicitly include the JSON data
datas=[('data.json', '.')],
a = Analysis([r'path_to_your_app.py'],
             pathex=['.'],
             binaries=[],
             datas=[('data.json', '.')],
             hiddenimports=[],
             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             noarchive=False)
coll = COLLECT(exe, Tree('C:\\path_to_project'),
               a.binaries, a.zipfiles, a.datas,
               *[Tree(p) for p in (sdl2.dep_bins + glew.dep_bins)],
               strip=False, upx=True, name='Prototype')

起動エラーを防ぐために Kivy アプリ用に PyInstaller を最適化する

PyInstaller と Kivy を使用する場合、考慮すべき重要な側面の 1 つは、外部の依存関係とライブラリの管理です。 PyInstaller のデフォルトの動作では、特に仮想環境や科学ライブラリなどのより複雑なセットアップを操作する場合、特定のライブラリやファイルが見落とされることがあります。 そして 。すべての非表示のインポートが パラメータは重要です。さらに、PyInstaller には、次のようなグラフィカルおよびマルチメディアの依存関係が自動的に含まれない場合があります。 sdl2 または 、どちらも Kivy アプリには不可欠です。

開発者が見落としがちなもう 1 つの側面は、仮想環境に関連しています。仮想環境内で PyInstaller を使用して Kivy アプリを構築する場合、すべての依存関係が正しくバンドルされていることを確認することが重要です。これには、 ライブラリがインストールされている正しいディレクトリを指すように設定します。そうしないと、パッケージ化されたアプリが開発環境では正常に動作しても、運用環境では起動時にクラッシュする可能性があります。多くの場合、この問題は、ビルド構成を十分に調べて、すべてのパスと依存関係が正しいことを確認することで回避できます。

最後に、予期しない起動エラーを防ぐには、画像、フォント、データ ファイルなどのリソースを適切に処理することが重要です。 Kivy アプリでは外部リソースが頻繁に必要になりますが、これらが PyInstaller に明示的に含まれていない場合は、 セクションに記載されているように、不足しているファイルにアクセスしようとすると、初期化中にアプリがクラッシュする可能性があります。実行時にアプリに必要なすべてのファイルが最終ビルドに適切に含まれていることを確認することが重要です。

1. PyInstaller でビルドした後に Kivy アプリがクラッシュするのはなぜですか?
2. 最も一般的な理由は、依存関係が欠落していることです。必要なライブラリがすべて揃っていることを確認します。 、 、 そして 、PyInstaller SPEC ファイルに非表示のインポートとして含まれています。
3. sdl2 と glew の依存関係をビルドに含めるにはどうすればよいですか?
4. を使用します。 の機能 sdl2 および glew バイナリを含めるステップ。これらは Kivy のグラフィカル操作に必要です。
5. PyInstaller は仮想環境を正しく処理できますか?
6. はい、ただし正しい値を設定する必要があります 依存関係がインストールされている環境を指すように SPEC ファイル内で指定しないと、アプリが依存関係を見つけられない可能性があります。
7. アプリが PyCharm で動作するが、パッケージ化するとクラッシュする場合はどうすればよいですか?
8. すべての実行時の依存関係が含まれていることを確認し、 SPEC ファイルの セクションには、フォント、画像、JSON データなど、アプリで使用される必要なファイルがすべて含まれています。
9. トレースバックを使用せずに「予期しないエラー」メッセージをトラブルシューティングするにはどうすればよいですか?
10. を設定します。 パラメータを で ステップ。これによりターミナルにエラーが出力され、クラッシュの原因を追跡できるようになります。