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 or pdb from the ground 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. See ipython-trepan for using this in ipython or an ipython notebook.

Features

Since this debugger is similar to other trepanning debuggers and gdb in general, knowledge gained by learning this is transferable to those debuggers and vice versa.

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

Uploaded Source

Built Distributions

trepan-0.4.8-py3.4.egg (545.4 kB view details)

Uploaded Source

trepan-0.4.8-py3-none-any.whl (266.7 kB view details)

Uploaded Python 3

trepan-0.4.8-py2.7.egg (552.8 kB view details)

Uploaded Source

trepan-0.4.8-py2.6.egg (554.4 kB view details)

Uploaded Source

trepan-0.4.8-py2-none-any.whl (283.1 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for trepan-0.4.8.tar.gz
Algorithm Hash digest
SHA256 9d6378944d5919bb17e109b5d8fea78c180911b120cd6c81fb142e9d7a03990d
MD5 90cbc985f11b089f92b7a22e9a372bd5
BLAKE2b-256 c2c99f9062bd848061b606685d1756a2265570e19dccc7d6cfac0673cf492dc7

See more details on using hashes here.

Provenance

File details

Details for the file trepan-0.4.8-py3.4.egg.

File metadata

  • Download URL: trepan-0.4.8-py3.4.egg
  • Upload date:
  • Size: 545.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for trepan-0.4.8-py3.4.egg
Algorithm Hash digest
SHA256 f9b8455dc559683d6ed043cacf97acf5810baf286299d39eb01ff634ee5774b1
MD5 81487a90865ddbb7afc1fe35ceaf435c
BLAKE2b-256 30bc4bc6f8c86adbf0c18e4e2753d47738a24182f865ec80db344b733ff3886d

See more details on using hashes here.

Provenance

File details

Details for the file trepan-0.4.8-py3-none-any.whl.

File metadata

File hashes

Hashes for trepan-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 fcc0b4c6822ea6dfb4384a3144c7caa73742c2a2b9d0d2375545754f0f1e88d5
MD5 b22283ac43ccfe25fdb8729ef2105a88
BLAKE2b-256 cef1cfb351aed67072f7f3ed054724b1d1957dfef144340e084960a82b9f7488

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for trepan-0.4.8-py2.7.egg
Algorithm Hash digest
SHA256 7ab38aade1160e085fc72e6e9b4de12447134c7c8f6d1e7f60b6f25e705ac7b8
MD5 47f06f35274cdac7c42ccb94e9531e23
BLAKE2b-256 f6fb157f4b8b936fb0da0f376d121974181bbf8e583016969bffd7d91d549880

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for trepan-0.4.8-py2.6.egg
Algorithm Hash digest
SHA256 b6263f164b4693fbe7818ea131cecd7a2db178fe3343ff2587c69ad743e78b6e
MD5 a1404db8cbf3f1555ba64eb1ccd94d5d
BLAKE2b-256 b09ab0aead2eb13e8622c1b66f60a384af67285dce49be0585e59f47c1546132

See more details on using hashes here.

Provenance

File details

Details for the file trepan-0.4.8-py2-none-any.whl.

File metadata

File hashes

Hashes for trepan-0.4.8-py2-none-any.whl
Algorithm Hash digest
SHA256 1c17cdb0f983b3f63e293222ac33b23db40019c43ff3393d4282adbdf6e768fa
MD5 99693c2aadbfd9f983d87a172909082b
BLAKE2b-256 8fde242ba02e369e2534ac3821e788435c0ef77a817fa71bcb6e4bd257b17606

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