https://github.com/squidfunk/pyo3-debug-vscode
Debugging PyO3 with Visual Studio Code
https://github.com/squidfunk/pyo3-debug-vscode
Last synced: 11 months ago
JSON representation
Debugging PyO3 with Visual Studio Code
- Host: GitHub
- URL: https://github.com/squidfunk/pyo3-debug-vscode
- Owner: squidfunk
- License: mit
- Created: 2025-04-04T19:59:57.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-05T16:48:00.000Z (about 1 year ago)
- Last Synced: 2025-04-28T13:11:50.868Z (about 1 year ago)
- Language: Python
- Size: 2.84 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Debugging PyO3 with Visual Studio Code
This is a sample project that shows how to debug [PyO3] extension using [Visual
Studio Code]. It allows to set breakpoints in Python sources and tests, as well
as in Rust sources, and step through Python and Rust code simultaneously. This
was tricky to set up, so I thought I'd share my configuration.
[PyO3]: https://pyo3.rs
[Visual Studio Code]: https://code.visualstudio.com/
## Prerequisites
This project assumes you have a Python and Rust toolchain up and running. In
Visual Studio Code, make sure you have the following extensions installed:
- [CodeLLDB]
- [Rust Analyzer]
[CodeLLDB]: https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb
[Rust Analyzer]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer
## Installation
Create a virtual environment and install the required packages:
```
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
## Usage
There are two launch configurations:
1. __Debug Script__: Debug the current active Python script. This is the most
common use case. You can set breakpoints in Python code and step through it.
2. __Debug Test__: Debug the current active Python test. It assumes that you are
using [pytest] as your test runner. You can set breakpoints in Python code
and step through it.
[pytest]: https://docs.pytest.org/en/stable/
## License
__MIT License__
Copyright (c) 2025 Martin Donath
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.