web-pdb 2.0.1

Important Notice

Currently this project is in a minimum maintenance mode. It means that I will try to maintain compatibility with new Python versions and address critical issues, if any arise. But at the moment I have no time or resources to develop new features or properly review external contributions. That is why only pull requests with bug fixes will be prioritized. Other issues or pull requests may or may not be reviewed or accepted.

Features

• Responsive design based on Bootstrap with light and dark modes.

• Python syntax highlighting with Prism (the default and “Okaida” themes).

• Supports all PDB features.

• Standard input and output can be redirected to the web-console to interact with Python scripts remotely.

• Current file box tracks current position in the file being executed. Red line numbers indicate breakpoints, if any.

• Globals and Locals boxes show local and global variables in the current scope. Special variables that start and end with double underscores __ are excluded (you can always view them using PDB commands).

• Command history that stores up to 10 last unique PDB commands (accessed by arrow UP/DOWN keys).

Usage

Install Web-PDB into your working Python environment:

pip install web-pdb

Insert the following line into your Python program at the point where you want to start debugging:

import web_pdb; web_pdb.set_trace()

The set_trace() call will suspend your program and open a web-UI at the default port 5555 (port value can be changed). Enter in your browser’s address bar: http://<your Python machine hostname or IP>:5555, for example http://monty-python:5555, and you should see the web-UI like the one on the preceding screenshot. Now you can use all PDB commands and features. Additional Current file, Globals and Locals information boxes help you better track your program runtime state.

Note: it is strongly recommended to work with the Web-PDB web-UI only in one browser session. With more than one browser window accessing the web-UI it may display incorrect data in one or more browser sessions.

Subsequent set_trace() calls can be used as hardcoded breakpoints.

Web-PDB is compatible with the new breakpoint() function added in Python 3.7. Set environment variable PYTHONBREAKPOINT="web_pdb.set_trace" to launch Web-PDB with breakpoint().

Additionally, Web-PDB provides catch_post_mortem context manager that can catch unhandled exceptions raised within its scope and automatically start PDB post-mortem debugging session. For example:

import web_pdb

with web_pdb.catch_post_mortem():
    # Some error-prone code
    assert foo == bar, 'Oops!'

For more detailed info about the Web-PDB API read docstrings in the ./web_pdb/__init__.py file.

Considerations for Multithreading and Multiprocessing Programs

Compatibility

• Python: 3.8+

• Browsers: All modern browsers should work

Implementation Details

Web-PDB uses a custom asynchronous HTTP server based on asyncio library that runs in a separate thread. Take this into account when using Web-PDB in your environment.

Starting from v2.0, Web-PDB Python backend has no external dependencies, except for Python Standard Library.

License

MIT, see LICENSE.txt.

The debugger icon made by Freepik from www.flaticon.com is licensed by CC 3.0 BY.