|
1 |
| -PyDev.Debugger |
2 |
| -============== |
| 1 | +# PyDev.Debugger |
| 2 | + |
| 3 | + |
| 4 | +## New |
| 5 | + |
| 6 | +Latest `3.x` version: the PyDev debugger now supports `sys.monitoring` which enables |
| 7 | +really fast tracing on `Python 3.12` (so, if speed is an issue, make sure you upgrade). |
| 8 | + |
| 9 | +## Important |
| 10 | + |
| 11 | +https://github.com/fabioz/PyDev.Debugger is the main repository |
| 12 | +for `pydevd` and the latest versions can always be used directly in: |
| 13 | + |
| 14 | +- [PyDev for Eclipse](http://pydev.org): Enables the usage of `pydevd` in Eclipse (Open Source). |
| 15 | + |
| 16 | +- [Python Debugger (PyDev) for VSCode](https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev-python-debugger): Enables |
| 17 | + the usage of `pydevd` in VSCode (note that while `pydevd` itself is open source, this extension is commercial |
| 18 | + and helps in the development of the Open Source version. It has a free trial and can be used by acquiring a license for |
| 19 | + `PyDev for VSCode` at: https://www.pydev.org/vscode/index.html). |
| 20 | + |
| 21 | + Note that the `Python Debugger (PyDev) for VSCode` may be used as a standalane extension for debugging `Python` by |
| 22 | + creating the proper configuration in a `launch.json` and launching it. |
| 23 | + |
| 24 | + Alternatively, [PyDev for VSCode](https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev) |
| 25 | + leverages it to offer additional features such as debugging of test cases. |
| 26 | + |
| 27 | +## History / Support |
| 28 | + |
| 29 | +The `PyDev Debugger` (`pydevd` for short) is a **Python debugger** which historically was created to |
| 30 | +work with `PyDev` (in Eclipse). |
| 31 | + |
| 32 | +Over the years (as it's open source -- EPL) it was adopted by other IDEs/companies |
| 33 | +(so, it was integrated into PyCharm and VSCode Python through `debugpy`, which also bundles `pydevd`). |
| 34 | + |
| 35 | +Note that although it was adopted by other IDEs (and over the years companies of other |
| 36 | +commercial IDEs did provide backing), by far most of the work was done without any |
| 37 | +external backing and the ongoing work on the project relies on community support. |
| 38 | + |
| 39 | +So, if you like using it, please consider becoming a backer of the project (this is |
| 40 | +done through the `PyDev` umbrella, so please see https://www.pydev.org/about.html |
| 41 | +for how to contribute to the project). |
| 42 | + |
| 43 | + |
| 44 | +## Source code / using |
3 | 45 |
|
4 | 46 | The sources for the PyDev.Debugger may be seen at:
|
5 | 47 |
|
6 | 48 | https://github.com/fabioz/PyDev.Debugger
|
7 | 49 |
|
8 | 50 | In general, the debugger backend should **NOT** be installed separately if you're using an IDE which already
|
9 |
| -bundles it (such as PyDev, PyCharm or bundled through debugpy, which is the debug adapter used in |
10 |
| -VSCode Python and Visual Studio Python). |
| 51 | +bundles it (such as [PyDev for Eclipse](http://pydev.org), [Python Debugger (PyDev) for VSCode](https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev-python-debugger), |
| 52 | +PyCharm or the Microsoft Python VSCode Extension, which uses `debugpy`, which is another debug adapter bundling `pydevd` to be used in the Microsoft |
| 53 | +VSCode Python Extension and Visual Studio Python). |
11 | 54 |
|
12 | 55 | It is however available in PyPi so that it can be installed for doing remote debugging with `pip` -- so, when
|
13 | 56 | debugging a process which runs in another machine, it's possible to `pip install pydevd` and in the code use
|
14 |
| -`pydevd.settrace(host='10.1.1.1')` to connect the debugger backend to the debugger UI running in the IDE |
| 57 | +`pydevd.settrace(host="10.1.1.1")` (in PyDev) or `pydevd.settrace(host="10.1.1.1", protocol="dap")` (in PyDev for VSCode) |
| 58 | +to connect the debugger backend to the debugger UI running in the IDE |
15 | 59 | (whereas previously the sources had to be manually copied from the IDE installation).
|
16 | 60 |
|
17 |
| -`pydevd` is compatible with Python 3.6 onwards. |
| 61 | +For instructions on how to `Remote Debug` with `PyDev`, see: https://www.pydev.org/manual_adv_remote_debugger.html |
18 | 62 |
|
19 |
| -For `Python 2` please keep using `pydevd 2.8.0`. |
| 63 | +For instructions on how to `Remote Debug` with `PyDev for VSCode`, see: https://marketplace.visualstudio.com/items?itemName=fabioz.vscode-pydev-python-debugger |
| 64 | + |
| 65 | +`pydevd` is compatible with Python 3.8 onwards and is tested both with CPython as well as PyPy. |
20 | 66 |
|
21 |
| -`pydevd` is tested both with CPython as well as PyPy. |
| 67 | +For `Python 3.3 to 3.7` please keep using `pydevd 2.10.0`. |
| 68 | + |
| 69 | +For `Python 2` please keep using `pydevd 2.8.0`. |
22 | 70 |
|
23 | 71 | Recent versions contain speedup modules using Cython, which are generated with a few changes in the regular files
|
24 | 72 | to `cythonize` the files. To update and compile the cython sources (and generate some other auto-generated files),
|
|
0 commit comments