Oprava zlyhania pri spustení PyInstaller v aplikácii Kivy pomocou Pythonu 3.10

Pochopenie zlyhaní pri spustení v aplikáciách Kivy vytvorených pomocou PyInstaller

Vytvorenie aplikácie Kivy pomocou PyInstaller je bežný prístup na balenie aplikácií Pythonu do samostatných spustiteľných súborov. Napriek úspešnému procesu zostavovania sa však vývojári niekedy stretávajú s neočakávanými zlyhaniami pri spustení zabalenej aplikácie. Tento problém môže byť obzvlášť frustrujúci, keď nie je poskytnuté žiadne podrobné chybové hlásenie.

V tomto prípade aplikácia funguje perfektne vo vývojovom prostredí, ako je PyCharm, ale zlyhá, keď je zabalená pomocou PyInstaller. So závislosťami ako Kivy 2.3.0, Python 3.10 a knižnicami ako numpy, scipy a pandy sa identifikácia zdroja zlyhania stáva kritickým pre vyriešenie problému.

Chyby ako „neočakávaná chyba“ bez jasnej stopy často poukazujú na chýbajúce závislosti, nesprávne konfigurácie súborov SPEC alebo nezrovnalosti vo virtuálnom prostredí. Vzhľadom na to, že je dôležité zabezpečiť, aby boli všetky potrebné súbory správne zviazané, je rozhodujúcim krokom kontrola súboru PyInstaller SPEC a závislostí runtime.

Tento článok skúma možné príčiny zlyhania so zameraním na vylepšenie vášho súboru SPEC, správu skrytých importov a zabezpečenie správneho spracovania potrebných závislostí Kivy počas procesu zostavovania.

Riešenie problémov so spustením aplikácie Kivy App pomocou PyInstaller

Vyššie uvedené skripty sú zamerané na riešenie veľmi špecifického problému: aplikácia Kivy vytvorená pomocou PyInstaller spadne pri spustení s „neočakávanou chybou“. Prvý skript rieši potenciálny problém s chýbaním skryté dovozy. Toto je bežný problém pri používaní PyInstaller, pretože automaticky nezistí všetky závislosti, najmä knižnice ako numpy, pandy, alebo scipy. Ručným zadaním týchto skrytých importov v Analýza časti súboru SPEC zabezpečujeme, aby PyInstaller spájal všetky potrebné moduly, čím sa zabráni zlyhaniu aplikácie v dôsledku chýbajúcich komponentov.

Druhým dôležitým krokom v scenári je zahrnutie strom() v ZBIERŤ fázy. Tento príkaz zaisťuje, že závislosti aplikácie súvisiace s Kivy, ako sú knižnice SDL2 a GLEW, sú správne zahrnuté do zostavy. Tie sú nevyhnutné na vykreslenie grafického rozhrania aplikácie. Ak tieto súbory nie sú zahrnuté, aplikácia Kivy sa nespustí správne, aj keď sa proces zostavovania dokončí bez chýb. Zabezpečenie, že tieto binárne súbory sú zahrnuté, pomáha vyhnúť sa problémom s behu súvisiacim s chýbajúcimi grafickými alebo zvukovými komponentmi.

Skript tiež rieši zahrnutie externých súborov, ako je napríklad súbor JSON vytvorený pomocou JsonStore v Kivy. Aj keď sa tento súbor JSON generuje za behu, je dôležité zabezpečiť, aby sa s ním počas procesu balenia správne zaobchádzalo. The údajov argument v Analýza funkcia nám umožňuje explicitne zahrnúť tento súbor do pribalenej aplikácie. Vyhneme sa tak chybe, pri ktorej aplikácia spadne z dôvodu chýbajúcich externých dátových súborov počas inicializácie.

Nakoniec vidíme aj použitie UPX kompresie a prúžok možnosť. Kompresia UPX sa používa na zmenšenie veľkosti pribalenej aplikácie, čím sa zjednodušuje distribúcia. Povolenie UPX však niekedy spôsobuje problémy s kompatibilitou, a preto je spárovaný s strip=False aby ste sa vyhli odstráneniu ladiacich symbolov z binárnych súborov. Zachovaním symbolov ladenia môžeme lepšie sledovať príčinu zlyhaní alebo chýb počas behu. Vypnutie sledovania v okne je ďalšou konfiguráciou, ktorá pomáha pri diagnostike problémov, pretože umožňuje, aby sa v konzole zobrazovali chybové hlásenia, čo poskytuje prehľad o možných problémoch pri spustení.

# 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')

Optimalizácia PyInstaller pre Kivy Apps, aby sa predišlo chybám pri spustení

Pri práci s PyInstaller a Kivy je jedným z kľúčových aspektov, ktoré treba zvážiť, správa externých závislostí a knižníc. Predvolené správanie PyInstaller niekedy prehliada určité knižnice alebo súbory, najmä pri práci so zložitejšími nastaveniami, ako sú virtuálne prostredia alebo vedecké knižnice, ako napr. numpy a pandy. Zabezpečenie, že všetky skryté importy sú špecifikované v hiddenimports parameter je kritický. Okrem toho PyInstaller nemusí automaticky zahŕňať grafické a multimediálne závislosti, ako sú tie z sdl2 alebo glew, ktoré sú pre aplikácie Kivy nevyhnutné.

Ďalší aspekt, ktorý vývojári často prehliadajú, súvisí s virtuálnymi prostrediami. Pri vytváraní aplikácie Kivy pomocou PyInstaller vo virtuálnom prostredí je dôležité zabezpečiť, aby boli všetky závislosti správne spojené. To zahŕňa úpravu pathex nastavenie tak, aby ukazovalo na správne adresáre, kde sú nainštalované knižnice. Ak tak neurobíte, môže to mať za následok, že zabalená aplikácia bude vo vývojovom prostredí fungovať správne, ale pri spustení v produkcii zlyhá. Tomuto problému sa často dá vyhnúť úplným preskúmaním konfigurácie zostavy a zabezpečením správnosti všetkých ciest a závislostí.

A napokon, správne zaobchádzanie so zdrojmi, ako sú obrázky, písma a dátové súbory, je kľúčové pri predchádzaní neočakávaným chybám pri spustení. V aplikáciách Kivy sa často vyžadujú externé zdroje, a ak nie sú explicitne zahrnuté v PyInstaller datas časti, aplikácia môže zlyhať počas inicializácie pri pokuse o prístup k chýbajúcim súborom. Je nevyhnutné overiť, že všetky súbory, ktoré aplikácia potrebuje pri spustení, sú správne zahrnuté vo finálnej zostave.