Merge pull request #23 from cocolato/feat/support_rpdb

support rpdb

Author: cocolato

README.md

@@ -8,6 +8,7 @@ It's a fork/optimized version from [elifiner/pydump](https://github.com/elifiner
 * fix bug in python3.10+
 * supported more pdb commnd
 * a useful command line tool for debug
+* supported remote debug (rpdb)
 
 
 Pydumpling writes the `python current traceback` into a file and 
@@ -128,7 +129,7 @@ Type "help", "copyright", "credits" or "license" for more information.
 
 ### Use Command Line
 
-Use command line to print the traceback:
+#### Use command line to print the traceback:
 `python -m pydumpling --print test.deump`
 
 It will print:
@@ -144,7 +145,7 @@ TypeError: unsupported operand type(s) for +: 'int' and 'str'
 ```
 
 
-Use command line to do pdb debug:
+#### Use command line to do pdb debug:
 `python -m pydumpling --debug test.deump`
 
 It will open the pdb window:
@@ -153,5 +154,11 @@ It will open the pdb window:
 (Pdb) 
 ```
 
+#### Use command line to do remote pdb debug:
+`python -m pydumpling --rdebug test.deump`
+It will open the debugger on port 4444, then we can access pdb using telnet、netcat... :
+`nc 127.0.0.1 4444`
+![alt text](static/rpdb.png)
+
 ## TODO
 - []

README_zh.md

@@ -6,6 +6,7 @@
 * 修复其在3.10+版本中的bug
 * 支持更多的pdb命令
 * 提供了一个方便用来调试的命令行工具
+* 支持服务器远程调试(remote pdb)
 
 pydumpling可以在代码的任何位置中，将当前Python程序的traceback写到一个文件中，可以稍后在Python调试器中加载它。目前pydump支持很多兼容PDB api的调试器（pdbpp, udb, ipdb)
 
@@ -124,7 +125,7 @@ Type "help", "copyright", "credits" or "license" for more information.
 
 ### 命令行使用
 
-使用命令行来打印traceback:
+#### 使用命令行来打印traceback:
 `python -m pydumpling --print test.deump`
 
 将会输出:
@@ -140,7 +141,7 @@ TypeError: unsupported operand type(s) for +: 'int' and 'str'
 ```
 
 
-使用命令行来进行pdb调试:
+#### 使用命令行来进行pdb调试:
 `python -m pydumpling --debug test.deump`
 
 将会打开pdb调试会话:
@@ -149,5 +150,11 @@ TypeError: unsupported operand type(s) for +: 'int' and 'str'
 (Pdb) 
 ```
 
+#### 使用命令行来进行remote pdb调试
+`python -m pydumpling --rdebug test.deump`
+它会在机器的4444端口上打开pdb调试器，然后我们可以在另外一台机器上使用telnet、netcat来进行远程调试：
+`nc 127.0.0.1 4444`
+![alt text](static/rpdb.png)
+
 ## TODO
 - []

pydumpling/__init__.py

@@ -1,7 +1,9 @@
 from __future__ import absolute_import, division, print_function, unicode_literals
 
+from .rpdb import r_post_mortem
 from .debug_dumpling import debug_dumpling, load_dumpling
 from .pydumpling import save_dumping, dump_current_traceback, __version__
 
+
 __version__ == __version__
-__all__ = ["debug_dumpling", "load_dumpling", "save_dumping", "dump_current_traceback"]
+__all__ = ["debug_dumpling", "load_dumpling", "save_dumping", "dump_current_traceback", "r_post_mortem"]

pydumpling/cli.py

@@ -1,6 +1,7 @@
 import argparse
 import os.path
 from .debug_dumpling import debug_dumpling, load_dumpling
+from .rpdb import r_post_mortem
 from .helpers import print_traceback_and_except
 
 DUMP_FILE_EXTENSION: str = ".dump"
@@ -36,6 +37,12 @@ def validate_file_name(file_name: str) -> str:
     help="enter pdb debugging interface"
 )
 
+pydumpling_cli_action_group.add_argument(
+    "--rdebug",
+    action="store_true",
+    help="enter rpdb debugging interface"
+)
+
 parser.add_argument(
     "filename",
     type=validate_file_name,
@@ -51,3 +58,5 @@ def main() -> None:
         print_traceback_and_except(dumpling_)
     elif args.debug:
         debug_dumpling(file_name)
+    elif args.rdebug:
+        r_post_mortem(file_name)

pydumpling/debug_dumpling.py

@@ -17,14 +17,16 @@ def load_dumpling(filename):
         except Exception:
             return pickle.load(f)
 
-
-def debug_dumpling(dump_file, pdb=pdb):
+def mock_inspect():
     inspect.isframe = lambda obj: isinstance(
         obj, types.FrameType) or obj.__class__ == FakeFrame
     inspect.istraceback = lambda obj: isinstance(
         obj, types.TracebackType) or obj.__class__ == FakeTraceback
     inspect.iscode = lambda obj: isinstance(
         obj, types.CodeType) or obj.__class__ == FakeCode
+
+def debug_dumpling(dump_file, pdb=pdb):
+    mock_inspect()
     dumpling = load_dumpling(dump_file)
     if not StrictVersion("0.0.1") <= StrictVersion(dumpling["version"]) < StrictVersion("1.0.0"):
         raise ValueError("Unsupported dumpling version: %s" %

pydumpling/rpdb.py

@@ -0,0 +1,136 @@
+import pdb
+import socket
+import threading
+import sys
+import traceback
+from .debug_dumpling import load_dumpling, mock_inspect
+
+DEFAULT_ADDR = "127.0.0.1"
+DEFAULT_PORT = 4444
+
+
+class FileObjectWrapper(object):
+    def __init__(self, fileobject, stdio):
+        self._obj = fileobject
+        self._io = stdio
+
+    def __getattr__(self, attr):
+        if hasattr(self._obj, attr):
+            attr = getattr(self._obj, attr)
+        elif hasattr(self._io, attr):
+            attr = getattr(self._io, attr)
+        else:
+            raise AttributeError("Attribute %s is not found" % attr)
+        return attr
+
+
+class Rpdb(pdb.Pdb):
+
+    def __init__(self, addr=DEFAULT_ADDR, port=DEFAULT_PORT):
+        """Initialize the socket and initialize pdb."""
+
+        # Backup stdin and stdout before replacing them by the socket handle
+        self.old_stdout = sys.stdout
+        self.old_stdin = sys.stdin
+        self.port = port
+
+        # Open a 'reusable' socket to let the webapp reload on the same port
+        self.skt = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        self.skt.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
+        self.skt.bind((addr, port))
+        self.skt.listen(1)
+
+        # Writes to stdout are forbidden in mod_wsgi environments
+        try:
+            sys.stderr.write("pdb is running on %s:%d\n"
+                             % self.skt.getsockname())
+        except IOError:
+            pass
+
+        (clientsocket, address) = self.skt.accept()
+        handle = clientsocket.makefile('rw')
+        pdb.Pdb.__init__(self, completekey='tab',
+                         stdin=FileObjectWrapper(handle, self.old_stdin),
+                         stdout=FileObjectWrapper(handle, self.old_stdin))
+        sys.stdout = sys.stdin = handle
+        self.handle = handle
+        OCCUPIED.claim(port, sys.stdout)
+
+    def shutdown(self):
+        """Revert stdin and stdout, close the socket."""
+        sys.stdout = self.old_stdout
+        sys.stdin = self.old_stdin
+        self.handle.close()
+        OCCUPIED.unclaim(self.port)
+        self.skt.shutdown(socket.SHUT_RDWR)
+        self.skt.close()
+
+    def do_continue(self, arg):
+        """Clean-up and do underlying continue."""
+        try:
+            return pdb.Pdb.do_continue(self, arg)
+        finally:
+            self.shutdown()
+
+    do_c = do_cont = do_continue
+
+    def do_quit(self, arg):
+        """Clean-up and do underlying quit."""
+        try:
+            return pdb.Pdb.do_quit(self, arg)
+        finally:
+            self.shutdown()
+
+    do_q = do_exit = do_quit
+
+    def do_EOF(self, arg):
+        """Clean-up and do underlying EOF."""
+        try:
+            return pdb.Pdb.do_EOF(self, arg)
+        finally:
+            self.shutdown()
+
+
+class OccupiedPorts(object):
+    """Maintain rpdb port versus stdin/out file handles.
+
+    Provides the means to determine whether or not a collision binding to a
+    particular port is with an already operating rpdb session.
+
+    Determination is according to whether a file handle is equal to what is
+    registered against the specified port.
+    """
+
+    def __init__(self):
+        self.lock = threading.RLock()
+        self.claims = {}
+
+    def claim(self, port, handle):
+        self.lock.acquire(True)
+        self.claims[port] = id(handle)
+        self.lock.release()
+
+    def is_claimed(self, port, handle):
+        self.lock.acquire(True)
+        got = (self.claims.get(port) == id(handle))
+        self.lock.release()
+        return got
+
+    def unclaim(self, port):
+        self.lock.acquire(True)
+        del self.claims[port]
+        self.lock.release()
+
+# {port: sys.stdout} pairs to track recursive rpdb invocation on same port.
+# This scheme doesn't interfere with recursive invocations on separate ports -
+# useful, eg, for concurrently debugging separate threads.
+OCCUPIED = OccupiedPorts()
+
+
+def r_post_mortem(dump_file, addr=DEFAULT_ADDR, port=DEFAULT_PORT):
+    mock_inspect()
+    dumpling = load_dumpling(dump_file)
+    tb = dumpling["traceback"]
+    debugger = Rpdb(addr=addr, port=port)
+    debugger.reset()
+    debugger.interaction(None, tb)