Debian Codegraph @

src/calibre/rpdb.py

raw
1 #!/usr/bin/env python
2 # License: GPLv3 Copyright: 2014, Kovid Goyal <kovid at kovidgoyal.net>
3
4 import atexit
5 import inspect
6 import os
7 import pdb
8 import select
9 import socket
10 import sys
11 import time
12 from contextlib import suppress
13
14 from calibre.constants import cache_dir
15
16 PROMPT = '(debug) '
17 QUESTION = '\x00\x01\x02'
18
19
20 class RemotePdb(pdb.Pdb):
21 def __init__(self, addr='127.0.0.1', port=4444, skip=None):
22 # Open a reusable socket to allow for reloads
23 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
24 self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
25 self.sock.bind((addr, port))
26 self.sock.listen(1)
27 with suppress(OSError):
28 print(f'pdb is running on {addr}:{port}', file=sys.stderr)
29 clientsocket, address = self.sock.accept()
30 clientsocket.setblocking(True)
31 self.clientsocket = clientsocket
32 self.handle = clientsocket.makefile('rw')
33 pdb.Pdb.__init__(self, completekey='tab', stdin=self.handle, stdout=self.handle, skip=skip)
34 self.prompt = PROMPT
35
36 def prints(self, *args, **kwargs):
37 kwargs['file'] = self.handle
38 kwargs['flush'] = True
39 print(*args, **kwargs)
40
41 def ask_question(self, query):
42 self.handle.write(QUESTION)
43 self.prints(query, end='')
44 self.handle.write(PROMPT)
45 self.handle.flush()
46 return self.handle.readline()
47
48 def end_session(self, arg=None):
49 self.clear_all_breaks()
50 self.reset()
51 self.handle.close()
52 self.clientsocket.shutdown(socket.SHUT_RDWR)
53 self.clientsocket.close()
54 try:
55 self.sock.shutdown(socket.SHUT_RDWR)
56 self.sock.close()
57 except OSError:
58 pass
59 return pdb.Pdb.do_continue(self, arg or '')
60
61 def do_clear(self, arg):
62 if not arg:
63 ans = self.ask_question('Clear all breaks? [y/n]: ')
64 if ans.strip().lower() in {'y', 'yes'}:
65 self.clear_all_breaks()
66 self.prints('All breaks cleared')
67 return
68 return pdb.Pdb.do_clear(self, arg)
69
70 do_cl = do_clear
71
72 def do_continue(self, arg):
73 if not self.breaks:
74 ans = self.ask_question('There are no breakpoints set. Continuing will terminate this debug session. Are you sure? [y/n]: ')
75 if ans.strip().lower() in {'y', 'yes'}:
76 return self.end_session()
77 return
78 return pdb.Pdb.do_continue(self, arg)
79
80 do_c = do_cont = do_continue
81
82 do_EOF = do_quit = do_exit = do_q = end_session
83
84
85 def set_trace(port=4444, skip=None):
86 frame_obj = inspect.currentframe()
87 assert frame_obj is not None
88 frame = frame_obj.f_back
89
90 try:
91 debugger = RemotePdb(port=port, skip=skip)
92 debugger.set_trace(frame)
93 except KeyboardInterrupt:
94 print('Debugging aborted by keyboard interrupt')
95 except Exception:
96 print('Failed to run debugger')
97 import traceback
98
99 traceback.print_exc()
100
101
102 def cli(port=4444):
103 print(f'Connecting to remote debugger on port {port}...')
104 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
105 for i in range(20):
106 try:
107 sock.connect(('127.0.0.1', port))
108 break
109 except OSError:
110 pass
111 time.sleep(0.1)
112 else:
113 try:
114 sock.connect(('127.0.0.1', port))
115 except OSError as err:
116 print('Failed to connect to remote debugger:', err, file=sys.stderr)
117 raise SystemExit(1)
118 print('Connected to remote process', flush=True)
119 try:
120 import readline
121 except ImportError:
122 pass
123 else:
124 histfile = os.path.join(cache_dir(), 'rpdb.history')
125 try:
126 readline.read_history_file(histfile)
127 except OSError:
128 pass
129 atexit.register(readline.write_history_file, histfile)
130 p = pdb.Pdb()
131 readline.set_completer(p.complete) # type: ignore
132 readline.parse_and_bind('tab: complete')
133
134 sock.setblocking(True)
135 with suppress(KeyboardInterrupt):
136 end_of_input = PROMPT.encode('utf-8')
137 while True:
138 recvd = b''
139 while select.select([sock], [], [], 0)[0] or not recvd.endswith(end_of_input):
140 buf = sock.recv(4096)
141 if not buf:
142 return
143 recvd += buf
144 recvd = recvd.decode('utf-8', 'replace')
145 recvd = recvd[: -len(PROMPT)]
146 raw = ''
147 if recvd.startswith(QUESTION):
148 recvd = recvd[len(QUESTION) :]
149 print(recvd, end='', flush=True)
150 raw = sys.stdin.readline() or 'n'
151 else:
152 print(recvd, end='', flush=True)
153 try:
154 raw = input(PROMPT)
155 except EOFError, KeyboardInterrupt:
156 pass
157 else:
158 raw += '\n'
159 if not raw:
160 raw = 'quit\n'
161 if raw:
162 sock.sendall(raw.encode('utf-8'))
163
164
165 if __name__ == '__main__':
166 cli()