Skip to main content

GDB-like Python Debugger in the Trepan family

Project description

Downloads Build Status Latest Version Supported Python versions

Abstract

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.6 up to and not including 3K. Use pydb for Python earlier than 2.6. 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.

Command Completion

Starting with release 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.

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.

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 release 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.)

Source-code Syntax Colorization

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

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.)

Out-of-Process Debugging

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

Egg and PIP Installable

Can be installed via the usual pip or easy_install. How To Install has full instructions and installing from git.

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.5.tar.gz (178.8 kB view details)

Uploaded Source

Built Distributions

trepan-0.4.5-py2.7.egg (532.5 kB view details)

Uploaded Source

trepan-0.4.5-py2.6.egg (534.1 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for trepan-0.4.5.tar.gz
Algorithm Hash digest
SHA256 d0c1d854ef2a4f69836fa9665d3e512346b7911133c7356c5fb32d3628e80308
MD5 f1cf8077ec7be8db2a541793ef74624d
BLAKE2b-256 0995b067a8f1dc315345fa3cc6e89f12e2df36782f93db78aeb6c1dbcea493f8

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for trepan-0.4.5-py2.7.egg
Algorithm Hash digest
SHA256 5a82b447e8168a978cea63b7dadaa398f8f1b1f34d3b58ec55706bd16762403c
MD5 8dfd3f8476efcf843e728e35139d2e92
BLAKE2b-256 51a1b4a8c5b882bb7e00cf71d96b4735c4f6412706698d0174f3817e50a63b46

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for trepan-0.4.5-py2.6.egg
Algorithm Hash digest
SHA256 94c2a1df4a9005e09a751c340bc7739e5009139df30b161f57bf04cc12fefad9
MD5 57203908d06efdb23409a9053b9c8bcd
BLAKE2b-256 8c3bf6a905904a04bb0a369db5b4cd8d4885d4e3b2526d74ca616eab403174d8

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