Skip to main content
===========================
python-manhole
===========================

Manhole is a python daemon thread that will accept unix domain socket connections and present the
stacktraces for all threads and an interactive prompt.

Access to the socket is restricted to the application's effective user id or root.

Usage::

import manhole
manhole.install() # this will start the daemon thread

Now in a shell you can do either of these::

netcat -U /tmp/manhole-1234
socat - unix-connect:/tmp/manhole-1234
socat readline unix-connect:/tmp/manhole-1234

Sample output::

$ nc -U /tmp/manhole-1234

Python 2.7.3 (default, Apr 10 2013, 06:20:15)
[GCC 4.6.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> dir()
['__builtins__', 'dump_stacktraces', 'os', 'socket', 'sys', 'traceback']
>>> print 'foobar'
foobar


Features
========

* Uses unix domain sockets, only root or same effective user can connect.
* Current implementation runs a daemon thread that waits for connection.
* Lightweight: does not fiddle with your process's singal handlers, settings, file descriptors, etc
* Compatible with apps that fork, reinstalls the Manhole thread after fork - had to monkeypatch os.fork/os.forkpty for this.

What happens when you actually connect to the socket
----------------------------------------------------

1. Credentials are checked (if it's same user or root)
2. sys.__std\*__/sys.std\* are be redirected to the UDS
3. Stacktraces for each thread are written to the UDS
3. REPL is started so you can fiddle with the process


Whishlist
---------

* Be compatible with eventlet/stackless (provide alternative implementation without thread)
* More configurable (chose what sys.__std\*__/sys.std\* to patch on connect time)


Requirements
============

Not sure yet ... maybe Python 2.6 and 2.7. Check Travis:

.. image:: https://secure.travis-ci.org/ionelmc/python-manhole.png
:alt: Build Status
:target: http://travis-ci.org/ionelmc/python-manhole

.. image:: https://coveralls.io/repos/ionelmc/python-manhole/badge.png?branch=master
:alt: Coverage Status
:target: https://coveralls.io/r/ionelmc/python-manhole

Release files for manhole 0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for manhole 0.1
File Size Uploaded
manhole-0.1.tar.gz 16.5 kB Details

Release files / manhole-0.1.tar.gz

Download URL manhole-0.1.tar.gz
Size 16.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d3b7c98841205a5cd46c3fbd54c95f6bcc4bd0487029deef958f1d61f3e3c4d5
BLAKE2b-256 checksum
How to use checksums
2557033b6570088aff5dc460112605dd647832d79726f1d25d920f3f12fb29fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.8.1

2 release files

1.8.0

2 release files

1.7.0

2 release files

1.6.0

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.0

1 release file

1.1.0

2 release files

1.0.0

2 release files

0.6.2

1 release file

0.6.1

1 release file

0.6.0

2 release files

0.5.2

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.0

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2

1 release file

0.1.2

1 release file

0.1.1

1 release file

This release

0.1 This release

1 release file

0.0.1

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page