How do I attach a remote debugger to a Python process?

Question

I'm tired of inserting

import pdb; pdb.set_trace()

lines into my Python programs and debugging through the console. How do I connect a remote debugger and insert breakpoints from a civilized user interface?

score 57 · Accepted Answer · edited Mar 01 '19 at 20:01

57

use Winpdb. It is a platform independent graphical GPL Python debugger with support for remote debugging over a network, multiple threads, namespace modification, embedded debugging, encrypted communication and is up to 20 times faster than pdb.

Features:

GPL license. Winpdb is Free Software.
Compatible with CPython 2.3 through 2.6 and Python 3000
Compatible with wxPython 2.6 through 2.8
Platform independent, and tested on Ubuntu Gutsy and Windows XP.
User Interfaces: rpdb2 is console based, while winpdb requires wxPython 2.6 or later.

_{(source: winpdb.org)}

edited Mar 01 '19 at 20:01

Glorfindel

21,988
13
81
109

answered Feb 13 '09 at 05:32

nosklo

217,122
57
293
297

sudo aptitude install winpdb – Yauhen Yakimovich Feb 05 '14 at 16:53
As of now, the original winpdb is not maintained and the website is dead. However, it has been forked: [here](https://pypi.org/project/winpdb-reborn/) – stevecu Aug 20 '22 at 15:56

CitizenB · Answer 2 · 2017-12-12T21:09:43.887

18

A little bit late, but here is a very lightweight remote debugging solution courtesy of http://michaeldehaan.net/post/35403909347/tips-on-using-debuggers-with-ansible:

pip install epdb on the remote host.
Make sure your firewalling setup is not allowing non-local connections to port 8080 on the remote host, since epdb defaults to listening on any address (INADDR_ANY), not 127.0.0.1.
Instead of using import pdb; pdb.set_trace() in your program, use import epdb; epdb.serve().
Securely log in to the remote host, since epdb.connect() uses telnet.
Attach to the program using python -c 'import epdb; epdb.connect()'.

Adjust the security bits to suit your local network setup and security stance, of course.

edited Dec 12 '17 at 21:09

answered Apr 04 '15 at 21:55

CitizenB

849
8
9

3

This helped me to debug a python app that's running inside a Docker container. The setup was further complicated by the use of Docker Compose and nginx + uwsgi to run the python app so none of the other solutions worked for me. This one did. – duality_ Sep 20 '16 at 08:16
This is the slickest way to debug curses applications. Cheers! – Qix - MONICA WAS MISTREATED Apr 19 '17 at 19:18
Does this still work? I get `module 'epdb' has no attribute 'serve'` – arjabbar Jun 21 '18 at 21:31
@arjabbar Any chance you're using https://github.com/native-human/epdb and not https://pypi.org/project/epdb/ ? – adaszko May 15 '19 at 07:09
Apologies for the only-very-slightly late reply, this still works for me nowadays. `pip install epdb` from a python 3.5.2 venv with pip 19.2.1 gets me epdb 0.15.1 from https://github.com/sassoftware/epdb, and the `epdb.serve()` and `epdb.connect()` methods still work as indicated in the answer above. – CitizenB Aug 07 '19 at 21:43

score 18 · Answer 3 · answered Feb 12 '09 at 21:07

Well, you can get something quite similar to that using a twisted manhole, which works like this:

from twisted.internet import reactor
from twisted.cred import portal, checkers 
from twisted.conch import manhole, manhole_ssh 

def getManholeFactory(namespace):
    realm = manhole_ssh.TerminalRealm()
    def getManhole(_): 
        return manhole.Manhole(namespace) 
    realm.chainedProtocolFactory.protocolFactory = getManhole
    p = portal.Portal(realm)
    p.registerChecker(
        checkers.InMemoryUsernamePassword DatabaseDontUse(admin='foobar'))
    f = manhole_ssh.ConchFactory(p)
    return f

reactor.listenTCP(2222, getManholeFactory(globals()))
reactor.run()

Then you just login to the program over ssh;

$ ssh admin@localhost -p 2222
admin@localhost's password:

Using foobar as the password.

When you login you'll get a normal python prompt where you can just poke at the data. It's not quite the same as getting a traceback sent over to a host.

Now, this might be tricky to integrate to a GUI program, in that case you might need to choose another reactor, for instance for gtk based programs used the gtk2reactor etc.

If you want the actual traceback sent over you need to create a socket channel for both stderr, stdin and stdout which goes over the network instead of printing to your local host. Shouldn't be too hard to accomplish by using twisted.

score 4 · Answer 4 · edited May 24 '22 at 00:42

4

Two solutions from modern IDEs:

PTVS (Python tools for Visual Studio) cross-platform remote debugging
PyCharm / PyDev remote debugging

edited May 24 '22 at 00:42

Cristian Ciupitu

20,270
7
50
76

answered Mar 02 '15 at 15:37

denfromufa

5,610
13
81
138

2

Pycharm requires that it be Professional version – gdbj Jul 13 '17 at 14:10
1

PTVS seems to have loads of issues, esp with containers. And CPython is not supported? – lucid_dreamer Sep 24 '17 at 21:27
1

You also cannot attach to a remote process using PyCharm's remote debugger (see: https://youtrack.jetbrains.com/issue/PY-14702) – Apteryx Oct 26 '18 at 18:30

score 1 · Answer 5 · answered Aug 06 '20 at 12:09

1

I find pudb useful at emergency

pip install pudb

Project Description https://pypi.org/project/pudb/

Tutorial: https://vimeo.com/5255125

answered Aug 06 '20 at 12:09

Vinoj John Hosan

6,448
2
41
37

How do I attach a remote debugger to a Python process?

5 Answers5

Linked