Opstartcrash van PyInstaller in de Kivy-app repareren met Python 3.10

Opstartcrashes begrijpen in Kivy-apps die zijn gebouwd met PyInstaller

Het bouwen van een Kivy-app met PyInstaller is een gebruikelijke aanpak voor het verpakken van Python-applicaties in zelfstandige uitvoerbare bestanden. Ondanks een succesvol bouwproces komen ontwikkelaars echter soms onverwachte crashes tegen bij het starten van de verpakte app. Dit probleem kan bijzonder frustrerend zijn als er geen gedetailleerd foutbericht wordt weergegeven.

In dit geval werkt de app perfect in de ontwikkelomgeving, zoals PyCharm, maar faalt wanneer deze wordt verpakt met PyInstaller. Met afhankelijkheden als Kivy 2.3.0, Python 3.10 en bibliotheken als numpy, scipy en pandas wordt het identificeren van de bron van de crash van cruciaal belang voor het oplossen van het probleem.

Fouten zoals "onverwachte fouten" zonder duidelijk spoor wijzen vaak op ontbrekende afhankelijkheden, onjuiste SPEC-bestandsconfiguraties of inconsistenties in de virtuele omgeving. Gezien het belang om ervoor te zorgen dat alle benodigde bestanden correct worden gebundeld, is het beoordelen van het PyInstaller SPEC-bestand en de runtime-afhankelijkheden een cruciale stap.

In dit artikel worden mogelijke oorzaken van de crash onderzocht, waarbij de nadruk ligt op het verbeteren van uw SPEC-bestand, het beheren van verborgen importbewerkingen en het garanderen dat noodzakelijke Kivy-afhankelijkheden correct worden afgehandeld tijdens het bouwproces.

Opstartfouten van de Kivy-app oplossen met PyInstaller

De hierboven gegeven scripts zijn gericht op het oplossen van een heel specifiek probleem: een Kivy-app gebouwd met PyInstaller crasht bij het opstarten met een 'onverwachte fout'. Het eerste script behandelt een mogelijk probleem met ontbreken verborgen import. Dit is een veel voorkomend probleem bij het gebruik van PyInstaller, omdat het niet automatisch alle afhankelijkheden detecteert, vooral niet zoals bibliotheken numpig, panda's, of pittig. Door deze verborgen imports handmatig op te geven in het Analyse sectie van het SPEC-bestand zorgen we ervoor dat PyInstaller alle benodigde modules bundelt, waardoor wordt voorkomen dat de app crasht vanwege ontbrekende componenten.

De tweede belangrijke stap in het script is het opnemen van Boom() in de VERZAMELEN fase. Deze opdracht zorgt ervoor dat de afhankelijkheden van de app met betrekking tot Kivy, zoals de SDL2- en GLEW-bibliotheken, correct worden opgenomen in de build. Deze zijn essentieel voor het weergeven van de grafische interface van de app. Als deze bestanden niet worden meegeleverd, werkt de Kivy-app niet goed, ook al wordt het bouwproces zonder fouten voltooid. Door ervoor te zorgen dat deze binaire bestanden worden opgenomen, kunt u runtime-problemen met ontbrekende grafische of geluidscomponenten voorkomen.

Het script behandelt ook de opname van externe bestanden, zoals een JSON-bestand gemaakt door de JsonStore in Kivy. Hoewel dit JSON-bestand tijdens runtime wordt gegenereerd, is het van cruciaal belang om ervoor te zorgen dat het tijdens het verpakkingsproces op de juiste manier wordt verwerkt. De gegevens betoog in de Analyse Met deze functie kunnen we dit bestand expliciet opnemen in de gebundelde app. Door dit te doen, vermijden we de fout waarbij de app crasht vanwege ontbrekende externe gegevensbestanden tijdens de initialisatie.

Tenslotte zien we ook het gebruik van UPX-compressie en de strip optie. De UPX-compressie wordt gebruikt om de omvang van de gebundelde applicatie te verkleinen, waardoor distributie eenvoudiger wordt. Het inschakelen van UPX veroorzaakt echter soms compatibiliteitsproblemen, en daarom is het gekoppeld aan strip=Onwaar om te voorkomen dat debug-symbolen uit binaire bestanden worden verwijderd. Door de debug-symbolen te behouden, kunnen we de oorzaak van eventuele crashes of fouten tijdens runtime beter traceren. Het uitschakelen van traceback in vensters is een andere configuratie die helpt bij het diagnosticeren van problemen, omdat hierdoor foutmeldingen in de console kunnen verschijnen, waardoor inzicht wordt verkregen in mogelijke problemen bij het opstarten.

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

PyInstaller optimaliseren voor Kivy-apps om opstartfouten te voorkomen

Wanneer u met PyInstaller en Kivy werkt, is een belangrijk aspect waarmee u rekening moet houden het beheer van externe afhankelijkheden en bibliotheken. Het standaardgedrag van PyInstaller ziet soms bepaalde bibliotheken of bestanden over het hoofd, vooral bij het werken met complexere instellingen zoals virtuele omgevingen of wetenschappelijke bibliotheken zoals numpig En panda's. Ervoor zorgen dat alle verborgen importbewerkingen worden gespecificeerd in het hiddenimports parameter is van cruciaal belang. Bovendien neemt PyInstaller mogelijk niet automatisch grafische en multimedia-afhankelijkheden op, zoals die van sdl2 of glew, die beide essentieel zijn voor Kivy-apps.

Een ander aspect dat ontwikkelaars vaak over het hoofd zien, heeft te maken met virtuele omgevingen. Wanneer u een Kivy-app bouwt met PyInstaller binnen een virtuele omgeving, is het belangrijk ervoor te zorgen dat alle afhankelijkheden correct worden gebundeld. Het gaat hierbij om het aanpassen van de pathex instelling om naar de juiste mappen te verwijzen waarin de bibliotheken zijn geïnstalleerd. Als u dit niet doet, kan dit tot gevolg hebben dat de verpakte app prima werkt in de ontwikkelomgeving, maar crasht bij het opstarten in productie. Dit probleem kan vaak worden vermeden door de buildconfiguratie volledig te onderzoeken en ervoor te zorgen dat alle paden en afhankelijkheden correct zijn.

Ten slotte is een juiste omgang met bronnen zoals afbeeldingen, lettertypen en gegevensbestanden van cruciaal belang om onverwachte opstartfouten te voorkomen. In Kivy-apps zijn vaak externe bronnen vereist, en als deze niet expliciet zijn opgenomen in de PyInstaller datas sectie kan de app crashen tijdens de initialisatie wanneer wordt geprobeerd toegang te krijgen tot ontbrekende bestanden. Het is essentieel om te verifiëren dat alle bestanden die de app tijdens runtime nodig heeft, correct zijn opgenomen in de uiteindelijke build.