Виправлення збою при запуску PyInstaller у програмі Kivy за допомогою Python 3.10

Розуміння аварійних завершень запуску в програмах Kivy, створених за допомогою PyInstaller

Створення програми Kivy за допомогою PyInstaller є звичайним підходом для упаковки програм Python в автономні виконувані файли. Однак, незважаючи на успішний процес збирання, розробники іноді стикаються з неочікуваними збоями під час запуску запакованої програми. Ця проблема може бути особливо неприємною, якщо не надається детальне повідомлення про помилку.

У цьому випадку програма ідеально працює в середовищі розробки, наприклад PyCharm, але не вдається запакувати за допомогою PyInstaller. З такими залежностями, як Kivy 2.3.0, Python 3.10 і такими бібліотеками, як numpy, scipy і pandas, визначення джерела збою стає критичним для вирішення проблеми.

Такі помилки, як «неочікувана помилка» без чіткого сліду, часто вказують на відсутність залежностей, неправильну конфігурацію файлу SPEC або невідповідність віртуального середовища. Враховуючи важливість забезпечення правильного об’єднання всіх необхідних файлів, перегляд файлу PyInstaller SPEC і залежностей середовища виконання є важливим кроком.

У цій статті досліджуються можливі причини збою, зосереджуючись на покращенні вашого файлу SPEC, керуванні прихованими імпортами та забезпеченні належної обробки необхідних залежностей Kivy під час процесу збирання.

Усунення помилок запуску програми Kivy за допомогою PyInstaller

Наведені вище сценарії зосереджені на вирішенні дуже конкретної проблеми: програма Kivy, створена за допомогою PyInstaller, аварійно завершує роботу під час запуску з «несподіваною помилкою». Перший сценарій вирішує потенційну проблему з відсутністю прихований імпорт. Це поширена проблема під час використання PyInstaller, оскільки він не визначає автоматично всі залежності, особливо такі бібліотеки, як numpy, панди, або scipy. Вручну вказавши ці приховані імпорти в Аналіз у розділі файлу SPEC, ми гарантуємо, що PyInstaller збирає всі необхідні модулі, запобігаючи збою програми через відсутність компонентів.

Другим важливим кроком у сценарії є включення Дерево() в ЗБИРАТИ фаза. Ця команда гарантує, що залежності програми, пов’язані з Kivy, як-от бібліотеки SDL2 і GLEW, правильно включені до збірки. Вони необхідні для відтворення графічного інтерфейсу програми. Якщо ці файли не включено, програма Kivy не працюватиме належним чином, навіть якщо процес збирання завершиться без помилок. Переконайтеся, що ці двійкові файли включено, щоб уникнути проблем під час виконання, пов’язаних із відсутніми графічними чи звуковими компонентами.

Сценарій також стосується включення зовнішніх файлів, таких як файл JSON, створений JsonStore в Киві. Хоча цей файл JSON створюється під час виконання, дуже важливо переконатися, що він правильно обробляється під час процесу пакування. The дані аргумент в Аналіз функція дозволяє нам явно включити цей файл у пакетний додаток. Таким чином ми уникаємо помилки, через яку програма аварійно завершує роботу через відсутність зовнішніх файлів даних під час ініціалізації.

Нарешті, ми також бачимо використання стиснення UPX і смужка варіант. Стиснення UPX використовується для зменшення розміру пакетної програми, що полегшує розповсюдження. Однак увімкнення UPX іноді викликає проблеми сумісності, тому його поєднується з strip=False щоб уникнути видалення символів налагодження з двійкових файлів. Зберігаючи символи налагодження, ми можемо краще відстежувати причини будь-яких збоїв або помилок під час виконання. Вимкнення зворотного відстеження у вікні — це ще одна конфігурація, яка допомагає діагностувати проблеми, оскільки дозволяє повідомленням про помилки з’являтися на консолі, надаючи інформацію про потенційні проблеми під час запуску.

# 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 для програм Kivy для запобігання помилкам запуску

Під час роботи з PyInstaller і Kivy одним із ключових аспектів, який слід враховувати, є керування зовнішніми залежностями та бібліотеками. Поведінка PyInstaller за замовчуванням іноді пропускає певні бібліотеки або файли, особливо під час роботи зі складнішими налаштуваннями, такими як віртуальні середовища або наукові бібліотеки, такі як numpy і панди. Переконайтеся, що всі приховані імпорти вказані в hiddenimports параметр критичний. Крім того, PyInstaller може не автоматично включати графічні та мультимедійні залежності, наприклад із sdl2 або glew, обидва важливі для програм Kivy.

Ще один аспект, який розробники часто не помічають, пов’язаний з віртуальними середовищами. Під час створення програми Kivy за допомогою PyInstaller у віртуальному середовищі важливо переконатися, що всі залежності об’єднано правильно. Це передбачає коригування pathex налаштування вказує на правильні каталоги, де встановлено бібліотеки. Якщо цього не зробити, запакована програма може нормально працювати в середовищі розробки, але аварійно завершувати роботу під час запуску. Цієї проблеми часто можна уникнути, повністю вивчивши конфігурацію збірки та переконавшись, що всі шляхи та залежності правильні.

Нарешті, належне поводження з такими ресурсами, як зображення, шрифти та файли даних, має вирішальне значення для запобігання несподіваним помилкам запуску. У програмах Kivy часто потрібні зовнішні ресурси, і якщо вони явно не включені в PyInstaller datas розділі програма може аварійно завершувати роботу під час ініціалізації під час спроби отримати доступ до відсутніх файлів. Важливо переконатися, що всі файли, необхідні програмі під час виконання, належним чином включено в остаточну збірку.