Welcome to pudb’s documentation!

PuDB: a console-based visual debugger for Python

Gitlab Build Status Github Build Status Python Package Index Release Page

Its goal is to provide all the niceties of modern GUI-based debuggers in a more lightweight and keyboard-friendly package. PuDB allows you to debug code right where you write and test it–in a terminal.

Here are some screenshots:

  • Light theme

    _images/pudb-screenshot-light.png
  • Dark theme

    _images/pudb-screenshot-dark.png

You may watch screencasts too:

Features

  • Syntax-highlighted source, the stack, breakpoints and variables are all visible at once and continuously updated. This helps you be more aware of what’s going on in your program. Variable displays can be expanded, collapsed and have various customization options.

  • Pre-bundled themes, including dark themes via “Ctrl-P”. Could set a custom theme also.

  • Simple, keyboard-based navigation using single keystrokes makes debugging quick and easy. PuDB understands cursor-keys and Vi shortcuts for navigation. Other keys are inspired by the corresponding pdb commands.

  • Use search to find relevant source code, or use “m” to invoke the module browser that shows loaded modules, lets you load new ones and reload existing ones.

  • Breakpoints can be set just by pointing at a source line and hitting “b” and then edited visually in the breakpoints window. Or hit “t” to run to the line under the cursor.

  • Drop to a Python shell in the current environment by pressing “!”. Or open a command prompt alongside the source-code via “Ctrl-X”.

  • PuDB places special emphasis on exception handling. A post-mortem mode makes it easy to retrace a crashing program’s last steps.

  • Ability to control the debugger from a separate terminal.

  • IPython integration (see wiki)

  • Should work with Python 3.6 and newer. (Versions 2019.2 and older continue to support Python 2.7.)

Development Version

You may obtain the development version using the Git version control tool.:

git clone https://github.com/inducer/pudb.git

You may also browse the code online.

Table of Contents

Indices and Tables