Skip to content

GitLab

Last edited by Bruno Colombet
Page history

Python_debug

Introduction

To interactively debug your Python plugin within you favorite Python IDE, you have to launch anywave in debug command using the command line.

Launch AnyWave in debug mode

Depending on your OS platform, open a Terminal window or a console application and launch AnyWave using the following command:

anywave --plugin_debug --server_port 59000

If you installed the macOS version using the provided installation package, the anywave command is available from a terminal.
If you installed the Ubuntu 20.04 package, the command is available from a terminal.
If you installed the Windows release, you must add the PATH to the installation dir of AnyWave to the current system path or you must specify the full path to the anywave.exe file.

Get the python package

The API package is available here

Connect to AnyWave as a fake plugin

import anywave
properties = anywave.debug_connect(59000)
# properties is a dict returned by anywave

Test your code

While successfully connected to AnyWave, you can run any code using the anywave package.
You may have some issues as your code is not really running in the regular plugin context:

  • The args struct returned will contain some empty paths, like the working directory path associated with the plugin or the plugin dir path.
    You may have to take that into account while debugging.