Åtgärda PyInstaller Startup Crash i Kivy App med Python 3.10

Förstå startkrascher i Kivy-appar byggda med PyInstaller

Att bygga en Kivy-app med PyInstaller är en vanlig metod för att paketera Python-applikationer till fristående körbara filer. Men trots en framgångsrik byggprocess stöter utvecklare ibland på oväntade krascher när de startar den paketerade appen. Det här problemet kan vara särskilt frustrerande när inget detaljerat felmeddelande tillhandahålls.

I det här fallet körs appen perfekt i utvecklingsmiljön, som PyCharm, men misslyckas när den paketeras med PyInstaller. Med beroenden som Kivy 2.3.0, Python 3.10 och bibliotek som numpy, scipy och pandas blir det avgörande att identifiera källan till kraschen för att lösa problemet.

Fel som "oväntat fel" utan tydliga spår pekar ofta på saknade beroenden, felaktiga SPEC-filkonfigurationer eller inkonsekvenser i den virtuella miljön. Med tanke på vikten av att se till att alla nödvändiga filer är korrekt buntade, är det ett avgörande steg att granska PyInstaller SPEC-filen och runtime-beroenden.

Den här artikeln utforskar möjliga orsaker till kraschen, med fokus på att förbättra din SPEC-fil, hantera dolda importer och se till att nödvändiga Kivy-beroenden hanteras korrekt under byggprocessen.

Felsöka Kivy App Startup Errors med PyInstaller

Skripten ovan är inriktade på att lösa ett mycket specifikt problem: en Kivy-app byggd med PyInstaller som kraschar vid start med ett "oväntat fel". Det första skriptet tar upp ett potentiellt problem med saknas dolda importer. Detta är ett vanligt problem när du använder PyInstaller, eftersom det inte automatiskt upptäcker alla beroenden, särskilt bibliotek som numpy, pandor, eller krypigt. Genom att manuellt ange dessa dolda importer i Analys avsnittet i SPEC-filen ser vi till att PyInstaller paketerar alla nödvändiga moduler, vilket förhindrar att appen kraschar på grund av saknade komponenter.

Det andra viktiga steget i manuset är införandet av Träd() i SAMLA fas. Det här kommandot säkerställer att appens beroenden relaterade till Kivy, såsom SDL2- och GLEW-biblioteken, är korrekt inkluderade i bygget. Dessa är viktiga för att återge appens grafiska gränssnitt. Om dessa filer inte ingår kommer Kivy-appen inte att fungera korrekt, även om byggprocessen slutförs utan fel. Att se till att dessa binärer ingår hjälper till att undvika körtidsproblem relaterade till saknad grafik eller ljudkomponenter.

Skriptet adresserar också inkluderingen av externa filer, till exempel en JSON-fil skapad av JsonStore i Kivy. Även om den här JSON-filen genereras under körning, är det viktigt att säkerställa att den hanteras korrekt under paketeringsprocessen. De data argument i Analys funktionen tillåter oss att uttryckligen inkludera denna fil i den medföljande appen. Genom att göra det undviker vi felet där appen kraschar på grund av att externa datafiler saknas under initieringen.

Slutligen ser vi också användningen av UPX-komprimering och remsa alternativ. UPX-komprimeringen används för att minska storleken på den medföljande applikationen, vilket gör distributionen enklare. Men att aktivera UPX orsakar ibland kompatibilitetsproblem, vilket är anledningen till att det är ihopparat med strip=False för att undvika att ta bort felsökningssymboler från binärer. Genom att behålla felsökningssymbolerna kan vi bättre spåra orsaken till eventuella krascher eller fel under körning. Att inaktivera fönsterspårning är en annan konfiguration som hjälper till att diagnostisera problem, eftersom det tillåter felmeddelanden att visas i konsolen, vilket ger insikter om potentiella problem vid start.

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

Optimera PyInstaller för Kivy Apps för att förhindra startfel

När du arbetar med PyInstaller och Kivy är en viktig aspekt att ta hänsyn till hanteringen av externa beroenden och bibliotek. PyInstallers standardbeteende förbiser ibland vissa bibliotek eller filer, särskilt när man arbetar med mer komplexa inställningar som virtuella miljöer eller vetenskapliga bibliotek som t.ex. numpy och pandor. Se till att alla dolda importer är specificerade i hiddenimports parametern är kritisk. Dessutom kanske PyInstaller inte automatiskt inkluderar grafiska och multimediaberoenden som de från sdl2 eller glew, som båda är viktiga för Kivy-appar.

En annan aspekt som utvecklare ofta förbiser är relaterad till virtuella miljöer. När du bygger en Kivy-app med PyInstaller i en virtuell miljö är det viktigt att se till att alla beroenden buntas ihop korrekt. Detta innebär att justera pathex inställning för att peka på rätt kataloger där biblioteken är installerade. Underlåtenhet att göra det kan leda till att den paketerade appen körs bra i utvecklingsmiljön men kraschar vid start i produktionen. Detta problem kan ofta undvikas genom att fullständigt undersöka byggkonfigurationen och säkerställa att alla sökvägar och beroenden är korrekta.

Slutligen är korrekt hantering av resurser som bilder, teckensnitt och datafiler avgörande för att förhindra oväntade startfel. I Kivy-appar krävs ofta externa resurser, och om dessa inte uttryckligen ingår i PyInstaller datas avsnitt, kan appen krascha under initiering när man försöker komma åt saknade filer. Det är viktigt att verifiera att alla filer som behövs av appen vid körning är korrekt inkluderade i den slutliga versionen.