Skip to main content

Modular Python Debugger

Project description

Downloads Build Status Latest Version Supported Python versions

Overview

This is a gdb-like debugger for Python. It is a rewrite of pydb from the ground up.

This code assumes Python in the version range of 2.4 up to and not including 3K. Use pydb for Python earlier than 2.4. Use trepan3 for Python 3.2 and up.

A command-line interface (CLI) is provided as well as an remote access interface over TCP/IP.

See the Tutorial for how to use.

Features

There’s a lot of cool stuff here that’s not in pydb or the stock Python debugger pdb.

Source-code Syntax Colorization

Starting with version 0.2.0 terminal source code is colorized and we make use of terminal bold and emphasized text in debugger output and help text. Of course, you can also turn this off.

Smart Eval

Starting with release 0.2.0, if you want to evaluate the current source line before it is run in the code, use eval. To evaluate text of a common fragment of line, such as the expression part of an if statement, you can do that with eval?. See the help for eval for more information.

Out-of-Process Debugging

You can now debug your program in a different process or even a different computer on a different network!

More Stepping Control

Sometimes you want small steps, and sometimes large stepping.

This fundamental issue is handled in a couple ways:

Step Granularity

There are now step _event_ and next _event_ commands with aliases to s+, s> and so on. The plus-suffixed commands force a different line on a subsequent stop, the dash-suffixed commands don’t. Suffixes >, <, and ! specify call, return and exception events respectively. And without a suffix you get the default; this is set by the set different command.

Event Filtering and Tracing

By default the debugger stops at every event: call, return, line, exception, c-call, c-exception. If you just want to stop at line events (which is largely what you happens in _pdb_) you can. If however you just want to stop at calls and returns, that’s possible too. Or pick some combination.

In conjunction with handling _all_ events by default, the event status is shown when stopped. The reason for stopping is also available via info program.

Event Tracing of Calls and Returns

I’m not sure why this was not done before. Probably because of the lack of the ability to set and move by different granularities, tracing calls and returns lead to too many uninteresting stops (such as at the same place you just were at). Also, stopping on function definitions probably also added to this tedium.

Because we’re really handling return events, we can show you the return value. (_pdb_ has an “undocumented” _retval_ command that doesn’t seem to work.)

Debugger Macros via Python Lambda expressions

Starting with version 0.2.3 there are debugger macros. In gdb, there is a macro debugger command to extend debugger commands.

However Python has its own rich programming language so it seems silly to recreate the macro language that is in _gdb_. Simpler and more powerful is just to use Python here. A debugger macro here is just a lambda expression which returns a string or a list of strings. Each string returned should be a debugger command.

We also have _aliases_ for the extremely simple situation where you want to give an alias to an existing debugger command. But beware: some commands, like step inspect command suffixes and change their behavior accordingly.

We also envision a number of other ways to allow extension of this debugger either through additional modules, or user-supplied debugger command directories.

If what you were looking for in macros was more front-end control over the debugger, then consider using the experimental (and not finished) Bullwinkle protocol.

Byte-code Instruction Introspection

We do more in the way of looking at the byte codes to give better information. Through this we can provide: * a skip command. It is like the jump command, but you don’t have to deal with line numbers. * disassembly of code fragments. You can now disassemble relative to the stack frames you are currently stopped at. * Better interpretation of where you are when inside execfile or exec. (But really though this is probably a Python compiler misfeature.) * Check that breakpoints are set only where they make sense. * A more accurate determination of if you are at a function-defining def statement (because the caller instruction contains MAKE_FUNCTION.)

Debugger Command Arguments can be Variables and Expressions

Commands that take integer arguments like up, list or disassemble allow you to use a Python expression which may include local or global variables that evaluates to an integer. This eliminates the need in _gdb_ for special “dollar” debugger variables. (Note however because of shlex parsing ,expressions can’t have embedded blanks.)

Egg and PIP Installable

To use pip, you need to give the –egg option. Or you can use easy_install:

pip install –egg trepan

or:

easy_install trepan

See also How To Install https://code.google.com/p/pydbgr/wiki/HowToInstall

Command Completion

Starting version 2.8 readline command completion has been added. Command completion is not just a simple static list, but varies depending on the context. For example, for frame-changing commands which take optional numbers, on the list of valid numbers is considered.

Modularity

The Debugger plays nice with other trace hooks. You can have several debugger objects.

Many of the things listed below doesn’t directly effect end-users, but it does eventually by way of more robust and featureful code. And keeping developers happy is a good thing.(TM)

  • Commands and subcommands are individual classes now, not methods in a class. This means they now have properties like the context in which they can be run, minimum abbreviation name or alias names. To add a new command you basically add a file in a directory.

  • I/O is it’s own layer. This simplifies interactive readline behavior from reading commands over a TCP socket.

  • An interface is it’s own layer. Local debugging, remote debugging, running debugger commands from a file (source) are different interfaces. This means, for example, that we are able to give better error reporting if a debugger command file has an error.

  • There is an experimental Python-friendly interface for front-ends

  • more testable. Much more unit and functional tests. More of _pydb_’s integration test will eventually be added.

Etc.

Of course, I think pydb has a number of cool things that are not in the stock Python debugger, pdb. See this for those features.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trepan-0.4.1.tar.gz (177.5 kB view details)

Uploaded Source

Built Distributions

trepan-0.4.1-py2.7.egg (531.5 kB view details)

Uploaded Source

trepan-0.4.1-py2.6.egg (533.0 kB view details)

Uploaded Source

File details

Details for the file trepan-0.4.1.tar.gz.

File metadata

  • Download URL: trepan-0.4.1.tar.gz
  • Upload date:
  • Size: 177.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for trepan-0.4.1.tar.gz
Algorithm Hash digest
SHA256 fef4205a6c42d73dde58506e6e83605253abf9867c94b91a259a21f48529adcd
MD5 0288619381cedc61e1e2b2803e4cc999
BLAKE2b-256 94754856df95af3a64e852d16c6a4c8eefb1c0009207f59f7685bf8f128b3f5f

See more details on using hashes here.

Provenance

File details

Details for the file trepan-0.4.1-py2.7.egg.

File metadata

  • Download URL: trepan-0.4.1-py2.7.egg
  • Upload date:
  • Size: 531.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for trepan-0.4.1-py2.7.egg
Algorithm Hash digest
SHA256 8a667fdad99ab5a94ee3338ec4658a1dd65f76a581d140f083a3e1d2b6f7a1de
MD5 69311105fbb93f985c7889ff7759351e
BLAKE2b-256 83a6c60c65dcc8d72223c24637d61a3f475a63c9335fee5a971329be94c155cb

See more details on using hashes here.

Provenance

File details

Details for the file trepan-0.4.1-py2.6.egg.

File metadata

  • Download URL: trepan-0.4.1-py2.6.egg
  • Upload date:
  • Size: 533.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for trepan-0.4.1-py2.6.egg
Algorithm Hash digest
SHA256 161b35da7874e60083f92ba14f7fd02729514ae45aa5c4a543adf824f7cfbc80
MD5 7985ffa0bd294a43b0441bddbec00656
BLAKE2b-256 bdf424727f95dd1b5d21edd5165364bf647a38e7303f86efc79ce7009ad14db5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page