Debug Python code in Deephaven
Debugging is a critical part of software development. Deephaven supports debugging in many contexts with different IDEs, allowing you to step through code, analyze state, and find problems.
How debugging works with Deephaven
Setting up a debugger in Deephaven depends on how Deephaven is running and which IDE you're using:
- Pip installation: Debug locally using standard IDE debuggers (PyCharm Community/Professional or VS Code). Your code runs in the same Python environment as your IDE.
- Docker and source installations: Debug remotely using PyCharm Professional's remote debugging server. Code runs in a container or separate process, requiring a remote connection.
The Deephaven web IDE does not have a built-in debugger. You must use an external IDE to debug Python scripts and user-defined functions.
Debugging support by installation method
The following table shows current debugging support for different Deephaven installation methods:
| Debugger IDE | Docker | Pip | Source |
|---|---|---|---|
| PyCharm Community | ❌ | ✅ | ❌ |
| PyCharm Professional | ✅ | ✅ | ✅ |
| VS Code | ❌ | ✅ | ❌ |
Note
PyCharm Professional is a paid product with remote debugging capabilities. PyCharm Community is free but only supports local debugging (pip installation only).
Warning
PyCharm debugging has only been verified to work with PyCharm 2024 or higher. Earlier versions may have compatibility issues.
Getting started
The guides in this section are organized by installation method. Choose the guide that matches how you installed Deephaven: Docker, pip, or source. Each guide shows you how to set up a debugger for the supported IDEs.
After setup, see Common problems for Deephaven-specific debugging issues you may encounter. For general debugger usage, refer to your IDE's debugging documentation.