Отладка

Техники и лучшие практики для отладки плагинов и обработки ошибок в процессе разработки языкового модуля Python.

Отладка плагинов Python, встроенных в приложения на C++, такие как Plugify, требует смешанного режима отладки для обработки как кода Python (управляемого), так и кода C++ (нативного). Это руководство предоставляет обзор того, как отлаживать плагины Python в этом контексте, и направляет вас к внешним ресурсам для получения подробных инструкций.

Предварительные требования

Перед отладкой ваших плагинов на Python убедитесь, что у вас установлено следующее:

Visual Studio (2022 или новее) с установленными рабочими нагрузками Разработка на Python и Разработка классических приложений на C++.
Python (версия 3.12 или новее) установлен и настроен.
Основная библиотека Plugify (собрана и доступна).
Языковой модуль Python (plugify-module-python3.12) установлен и настроен.
Плагин на Python для отладки.

Отладка плагинов Python в смешанном режиме

Смешанный режим отладки позволяет одновременно отлаживать как код Python, так и базовое приложение на C++. Ниже приведены общие шаги по отладке плагинов Python, встроенных в приложения на C++:

Настройте вашу среду разработки

Убедитесь, что ваш плагин на Python правильно настроен и размещен в каталоге плагинов Plugify.
Откройте ваш проект Plugify в Visual Studio.

Включите смешанный режим отладки

Щелкните правой кнопкой мыши по вашему проекту Plugify в Обозревателе решений и выберите Свойства.
Перейдите на вкладку Отладка.
В разделе Тип отладчика выберите Смешанный (Python/Native).

Подключите отладчик к Plugify

Запустите Plugify с загруженным плагином на Python.
В Visual Studio перейдите в Отладка > Присоединиться к процессу.
Найдите процесс Plugify в списке и нажмите Присоединить.

Установите точки останова

Откройте файлы скриптов Python вашего плагина в Visual Studio.
Установите точки останова в вашем коде, щелкнув в левом поле рядом с номерами строк.

Отлаживайте ваш плагин

Активируйте функциональность в вашем плагине, которую вы хотите отладить.
Отладчик приостановит выполнение на ваших точках останова, позволяя вам проверять переменные, пошагово выполнять код и анализировать стек вызовов.

Проверьте логи Plugify на наличие сообщений об ошибках.
Используйте отладчик для определения точной строки кода, вызывающей сбой.
Проверяйте переменные и память для диагностики проблемы.

2. Плагин не загружается

Убедитесь, что плагин находится в правильном каталоге.
Проверьте наличие отсутствующих зависимостей Python или несовместимых версий.
Используйте отладчик для пошагового выполнения кода инициализации плагина.

3. Неожиданное поведение

Установите точки останова в соответствующих функциях для отслеживания потока выполнения.
Проверяйте значения переменных для выявления расхождений.
Используйте условные точки останова для отладки конкретных сценариев.

Продвинутые советы по отладке

1. Используйте логирование

Добавьте операторы логирования в код вашего плагина на Python для отслеживания потока выполнения и значений переменных.
Используйте встроенную систему логирования Plugify для вывода сообщений в консоль или файлы логов.

2. Отладка нативного кода

Используйте Окно дизассемблирования в Visual Studio для проверки нативного кода C++.
Устанавливайте точки останова в коде C++ для отладки взаимодействия между компонентами Python и C++.