Debugging

Techniques and best practices for debugging plugins and handling errors in Python language module development process.

Debugging Python plugins that are embedded in C++ applications, such as Plugify, requires mixed-mode debugging to handle both Python (managed) and C++ (native) code. This guide provides an overview of how to debug Python plugins in this context and directs you to external resources for detailed instructions.

Prerequisites

Before debugging your Python plugins, ensure you have the following:

Visual Studio (2022 or later) with the Python development and Desktop development with C++ workloads installed.
Python (version 3.12 or later) installed and configured.
Plugify Core Library (built and available).
Python Language Module (`plugify-module-python3.12`) installed and configured.
A Python plugin to debug.

Debugging Python Plugins in Mixed Mode

Mixed-mode debugging allows you to debug both Python code and the underlying C++ application simultaneously. Below are the general steps to debug Python plugins embedded in C++ applications:

Set Up Your Development Environment

Ensure your Python plugin is properly configured and placed in the Plugify plugins directory.
Open your Plugify project in Visual Studio.

Enable Mixed-Mode Debugging

Right-click your Plugify project in the Solution Explorer and select Properties.
Go to the Debugging tab.
Under Debugger Type, select Mixed (Python/Native).

Attach the Debugger to Plugify

Launch Plugify with your Python plugin loaded.
In Visual Studio, go to Debug > Attach to Process.
Find the Plugify process in the list and click Attach.

Set Breakpoints

Open the Python script files for your plugin in Visual Studio.
Set breakpoints in your code by clicking in the left margin next to the line numbers.

Debug Your Plugin

Trigger the functionality in your plugin that you want to debug.
The debugger will pause execution at your breakpoints, allowing you to inspect variables, step through code, and analyze the call stack.

Check the Plugify logs for error messages.
Use the debugger to identify the exact line of code causing the crash.
Inspect variables and memory to diagnose the issue.

2. Plugin Not Loading

Verify that the plugin is placed in the correct directory.
Check for missing Python dependencies or incompatible versions.
Use the debugger to step through the plugin initialization code.

3. Unexpected Behavior

Set breakpoints in the relevant functions to trace the flow of execution.
Inspect variable values to identify discrepancies.
Use conditional breakpoints to debug specific scenarios.

Advanced Debugging Tips

1. Use Logging

Add logging statements to your Python plugin code to track execution flow and variable values.
Use Plugify's built-in logging system to output messages to the console or log files.

2. Debugging Native Code

Use the Disassembly Window in Visual Studio to inspect native C++ code.
Set breakpoints in C++ code to debug interactions between Python and C++ components.