Repository navigation
Expand file tree
/
Copy pathipythonServer.py
More file actions
680 lines (574 loc) · 22 KB
/
Copy pathipythonServer.py
File metadata and controls
680 lines (574 loc) · 22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
import sys
import socket
import select
import time
import re
import json
import struct
import imp
import traceback
import random
import os
import io
import inspect
import types
from collections import deque
import os
import warnings
from encodings import utf_8, ascii
try:
import thread
except ImportError:
# Renamed in Python3k
import _thread as thread
import visualstudio_py_util as _vspu
to_bytes = _vspu.to_bytes
read_bytes = _vspu.read_bytes
read_int = _vspu.read_int
read_string = _vspu.read_string
write_bytes = _vspu.write_bytes
write_int = _vspu.write_int
write_string = _vspu.write_string
try:
unicode
except NameError:
unicode = str
try:
BaseException
except NameError:
# BaseException not defined until Python 2.5
BaseException = Exception
try:
from Queue import Empty, Queue # Python 2
except ImportError:
from queue import Empty, Queue # Python 3
DEBUG = os.environ.get('DEBUG_DJAYAMANNE_IPYTHON') is not None
TEST = os.environ.get('PYTHON_DONJAYAMANNE_TEST') is not None
# The great "support IPython 2, 3, 4" strat begins
if not TEST:
try:
import jupyter
except ImportError:
jupyter_era = False
else:
jupyter_era = True
if jupyter_era:
# Jupyter / IPython 4.x
from jupyter_client import KernelManager
from jupyter_client.kernelspec import KernelSpecManager
from jupyter_client import MultiKernelManager
kernelSpecManager = KernelSpecManager()
multiKernelManager = MultiKernelManager()
else:
from IPython.kernel import KernelManager
from IPython.kernel.kernelspec import KernelSpecManager
from IPython.kernel.multikernelmanager import MultiKernelManager
kernelSpecManager = KernelSpecManager()
multiKernelManager = MultiKernelManager()
# End of the great "support IPython 2, 3, 4" strat
def _debug_write(out):
if DEBUG:
sys.__stdout__.write(out)
sys.__stdout__.write("\n")
sys.__stdout__.flush()
def listKernelSpecs():
"""Returns a dict mapping kernel names to resource directories."""
return kernelSpecManager.get_all_specs()
class IPythonExitException(Exception):
pass
class SafeSendLock(object):
"""a lock which ensures we're released if we take a KeyboardInterrupt exception acquiring it"""
def __init__(self):
self.lock = thread.allocate_lock()
def __enter__(self):
self.acquire()
def __exit__(self, exc_type, exc_value, tb):
self.release()
def acquire(self):
try:
self.lock.acquire()
except KeyboardInterrupt:
try:
self.lock.release()
except:
pass
raise
def release(self):
self.lock.release()
"""
- Add a list with the command ids
- Create a common lock object to be shared between iPythonKernelResponseMonitor and iPythonSocketServer
- iPythonSocketServer will grab a lock and insert an item into the command ids and then send the code for execution
- iPythonKernelResponseMonitor will keep going in a nutsy loop and when it gets a message for execution it will take the oldest item from the loop (pop)
- and send a socket message providing the information (this way we can tie the code to be executed with the message ids)
- Not the best, but that's how it will have to be done
- http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/_modules/pyquickhelper/ipythonhelper/notebook_runner.html
"""
class iPythonKernelResponseMonitor(object):
def __init__(self, kernelUUID, socketConnection, send_lock, shell_channel, iopub_channel):
import threading
self.kernel = multiKernelManager.get_kernel(kernelUUID)
self.conn = socketConnection
self.is_stop_requested = False
self.shell_channel = shell_channel
self.iopub_channel = iopub_channel
self.send_lock = send_lock
thread.start_new_thread(self.start_processing, ('shell', 1))
thread.start_new_thread(self.start_processing, ('io', 1))
def stop(self):
self.is_stop_requested = True
def check_for_exit_socket_loop(self):
return self.is_stop_requested
def _populateErrorContents(self, sourceContents, targetContents):
try:
targetContents.ename = sourceContents.ename
targetContents.evalue = sourceContents.evalue
targetContents.traceback = sourceContents.traceback
except AttributeError:
pass
def start_processing(self, channel, *args):
"""loop to read the io ports/messages"""
_debug_write('Started processing thread')
try:
while True:
if self.check_for_exit_socket_loop():
break
# message can be JSON, but not always
# (http://jupyter-client.readthedocs.io/en/latest/messaging.html)
# assume for now that dates are the only crappy (non JSONable
# stuff sent)
if channel == 'shell':
try:
exe_result = self.shell_channel.get_shell_msg(
timeout=30)
json_to_send = json.dumps(exe_result, default=str)
with self.send_lock:
_debug_write('shell_result')
write_bytes(self.conn, iPythonSocketServer._SHEL)
write_string(self.conn, json_to_send)
except Empty:
pass
if channel == 'io':
try:
msg = self.iopub_channel.get_iopub_msg(timeout=30)
json_to_send = json.dumps(msg, default=str)
with self.send_lock:
_debug_write('iopub_msg')
write_bytes(self.conn, iPythonSocketServer._IOPB)
write_string(self.conn, json_to_send)
except Empty:
pass
except IPythonExitException:
_debug_write('IPythonExitException')
_debug_write(traceback.format_exc())
pass
except socket.error:
_debug_write('socket error')
_debug_write(traceback.format_exc())
pass
except:
print('crap')
_debug_write('error in repl loop')
_debug_write(traceback.format_exc())
# try and exit gracefully, then interrupt main if necessary
time.sleep(2)
traceback.print_exc()
self.exit_process()
class iPythonSocketServer(object):
"""back end for executing REPL code. This base class handles all of the
communication with the remote process while derived classes implement the
actual inspection and introspection."""
"""Messages sent back as responses"""
_PONG = to_bytes('PONG')
_EXIT = to_bytes('EXIT')
_LSKS = to_bytes('LSKS')
_EROR = to_bytes('EROR')
_TEST = to_bytes('TEST')
_STRK = to_bytes('STRK')
_STPK = to_bytes('STPK')
_RSTK = to_bytes('RSTK')
_ITPK = to_bytes('ITPK')
_RUN = to_bytes('RUN ')
_SHEL = to_bytes('SHEL')
_IOPB = to_bytes('IOPB')
def __init__(self):
import threading
self.conn = None
self.send_lock = SafeSendLock()
self.input_event = threading.Lock()
# lock starts acquired (we use it like a manual reset event)
self.input_event.acquire()
self.input_string = None
self.exit_requested = False
self.execute_item = None
self.execute_item_lock = threading.Lock()
# lock starts acquired (we use it like manual reset event)
self.execute_item_lock.acquire()
self.kernelMonitor = None
self.shell_channel = None
def connect(self, port):
# start a new thread for communicating w/ the remote process
_debug_write('Connecting to socket port: ' + str(port))
self.conn = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.conn.connect(('127.0.0.1', port))
_debug_write('Connected to socket')
# perform the handshake
with self.send_lock:
write_string(self.conn, "Some Guid")
write_int(self.conn, os.getpid())
_debug_write('Handshake information sent')
thread.start_new_thread(self.start_processing, ())
def start_processing(self):
"""loop on created thread which processes communicates with the REPL window"""
_debug_write('Started processing thread')
try:
while True:
if self.check_for_exit_socket_loop():
break
# we receive a series of 4 byte commands. Each command then
# has it's own format which we must parse before continuing to
# the next command.
self.flush()
self.conn.settimeout(10)
try:
inp = read_bytes(self.conn, 4)
self.conn.settimeout(None)
cmd = iPythonSocketServer._COMMANDS.get(inp)
if inp and cmd is not None:
id = ""
try:
if iPythonSocketServer._COMMANDS_WITH_IDS.get(inp) == True:
while True:
try:
id = read_string(self.conn)
break
except socket.timeout:
pass
cmd(self, id)
else:
cmd(self)
except:
commandName = utf_8.decode(inp)[0]
try:
commandName = ascii.Codec.encode(commandName)[
0]
except UnicodeEncodeError:
pass
self.replyWithError(commandName, id)
else:
if inp:
print ('unknown command', inp)
break
except socket.timeout:
pass
except IPythonExitException:
_debug_write('IPythonExitException')
_debug_write(traceback.format_exc())
pass
except socket.error:
_debug_write('socket error')
_debug_write(traceback.format_exc())
pass
except:
print('crap')
_debug_write('error in repl loop')
_debug_write(traceback.format_exc())
# try and exit gracefully, then interrupt main if necessary
time.sleep(2)
traceback.print_exc()
self.exit_process()
def check_for_exit_socket_loop(self):
return self.exit_requested
def replyWithError(self, commandName, id):
with self.send_lock:
traceMessage = traceback.format_exc()
_debug_write('Replying with error:' + traceMessage)
write_bytes(self.conn, iPythonSocketServer._EROR)
write_string(self.conn, commandName)
write_string(self.conn, "" if id is None else id)
write_string(self.conn, traceMessage)
def _cmd_exit(self):
"""exits the interactive process"""
self.exit_requested = True
self.exit_process()
def _cmd_ping(self, id):
"""ping"""
_debug_write('Ping received')
while True:
try:
message = read_string(self.conn)
break
except socket.timeout:
pass
with self.send_lock:
_debug_write('Pong response being sent out')
write_bytes(self.conn, iPythonSocketServer._PONG)
write_string(self.conn, id)
write_string(self.conn, message)
def _cmd_lstk(self, id):
"""List kernel specs"""
_debug_write('Listing kernel specs')
kernelspecs = json.dumps(listKernelSpecs())
with self.send_lock:
_debug_write('Replying with kernel Specs= ' + kernelspecs)
write_bytes(self.conn, iPythonSocketServer._LSKS)
write_string(self.conn, id)
write_string(self.conn, kernelspecs)
def _cmd_strk(self, id):
"""Start a kernel by name"""
_debug_write('Listing kernel specs')
while True:
try:
kernelName = read_string(self.conn)
break
except socket.timeout:
pass
kernelUUID = multiKernelManager.start_kernel(kernel_name=kernelName)
self._postStartKernel(kernelUUID)
# get the config and the connection FileExistsError
try:
config = kernel_manager.config
except:
config = {}
try:
connection_file = kernel_manager.connection_file
except:
connection_file = ""
with self.send_lock:
_debug_write('Replying with kernel Specs= ' + str(kernelUUID))
write_bytes(self.conn, iPythonSocketServer._STRK)
write_string(self.conn, id)
write_string(self.conn, str(kernelUUID))
write_string(self.conn, json.dumps(config))
write_string(self.conn, connection_file)
def _postStartKernel(self, kernelUUID):
kernel_manager = multiKernelManager.get_kernel(kernelUUID)
kernel_client = kernel_manager.client()
kernel_client.start_channels()
try:
# IPython 3.x
kernel_client.wait_for_ready()
iopub = kernel_client
shell = kernel_client
# todo: get_stdin_msg
except AttributeError:
# Ipython 2.x
# Based on https://github.com/paulgb/runipy/pull/49/files
iopub = kernel_client.iopub_channel
shell = kernel_client.shell_channel
shell.get_shell_msg = shell.get_msg
iopub.get_iopub_msg = iopub.get_msg
# todo: get_stdin_msg
self.shell_channel = shell
self.kernelMonitor = iPythonKernelResponseMonitor(
kernelUUID, self.conn, self.send_lock, shell, iopub)
def _cmd_stpk(self, id):
"""Shutdown a kernel by UUID"""
while True:
try:
kernelUUID = read_string(self.conn)
break
except socket.timeout:
pass
try:
if self.kernelMonitor is not None:
self.kernelMonitor.stop()
finally:
pass
try:
kernel_manager = multiKernelManager.get_kernel(kernelUUID)
kernel_client = kernel_manager.client()
kernel_client.stop_channels()
finally:
pass
try:
kernel_manager = multiKernelManager.get_kernel(kernelUUID)
kernel_manager.shutdown_kernel()
except:
pass
finally:
self.shell_channel = None
self.kernelMonitor = None
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._STPK)
write_string(self.conn, id)
def _cmd_rstk(self, id):
"""Restart a kernel by UUID"""
while True:
try:
kernelUUID = read_string(self.conn)
break
except socket.timeout:
pass
try:
if self.kernelMonitor is not None:
self.kernelMonitor.stop()
finally:
self.kernelMonitor = None
kernel_manager = multiKernelManager.get_kernel(kernelUUID)
kernel_manager.restart_kernel(now=True)
self._postStartKernel(kernelUUID)
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._RSTK)
write_string(self.conn, id)
def _cmd_itpk(self, id):
"""Interrupt a kernel by UUID"""
while True:
try:
kernelUUID = read_string(self.conn)
break
except socket.timeout:
pass
kernel_manager = multiKernelManager.get_kernel(kernelUUID)
kernel_manager.interrupt_kernel()
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._ITPK)
write_string(self.conn, id)
def _cmd_run(self, id):
"""runs the received snippet of code (kernel is expected to have been started)"""
while True:
try:
code = read_string(self.conn)
break
except socket.timeout:
pass
msg_id = self.shell_channel.execute(code)
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._RUN)
write_string(self.conn, id)
write_string(self.conn, msg_id)
def _cmd_abrt(self):
"""aborts the current running command"""
# abort command, interrupts execution of the main thread.
pass
def _cmd_inpl(self):
"""handles the input command which returns a string of input"""
self.input_string = read_string(self.conn)
self.input_event.release()
def send_prompt(self, ps1, ps2, update_all=True):
"""sends the current prompt to the interactive window"""
# with self.send_lock:
# write_bytes(self.conn, iPythonSocketServer._PRPC)
# write_string(self.conn, ps1)
# write_string(self.conn, ps2)
# write_int(self.conn, update_all)
pass
def send_error(self):
"""reports that an error occured to the interactive window"""
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._ERRE)
def send_exit(self):
"""reports the that the REPL process has exited to the interactive window"""
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._EXIT)
def send_command_executed(self):
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._DONE)
def read_line(self):
"""reads a line of input from standard input"""
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._RDLN)
self.input_event.acquire()
return self.input_string
def write_stdout(self, value):
"""writes a string to standard output in the remote console"""
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._STDO)
write_string(self.conn, value)
def write_stderr(self, value):
"""writes a string to standard input in the remote console"""
with self.send_lock:
write_bytes(self.conn, iPythonSocketServer._STDE)
write_string(self.conn, value)
################################################################
# Implementation of execution, etc...
def execution_loop(self):
"""loop on the main thread which is responsible for executing code"""
while True:
exit = self.run_one_command(cur_modules, cur_ps1, cur_ps2)
if exit:
return
def run_command(self, command):
"""runs the specified command which is a string containing code"""
pass
def interrupt_main(self):
"""aborts the current running command"""
pass
def exit_process(self):
"""exits the REPL process"""
# TODO: Probably should cleanly shutdown the kernels
sys.exit(0)
def flush(self):
"""flushes the stdout/stderr buffers"""
pass
_COMMANDS = {
to_bytes('run '): _cmd_run,
to_bytes('abrt'): _cmd_abrt,
to_bytes('exit'): _cmd_exit,
to_bytes('ping'): _cmd_ping,
to_bytes('inpl'): _cmd_inpl,
to_bytes('lsks'): _cmd_lstk,
to_bytes('strk'): _cmd_strk,
to_bytes('stpk'): _cmd_stpk,
to_bytes('rstk'): _cmd_rstk,
to_bytes('itpk'): _cmd_itpk,
}
_COMMANDS_WITH_IDS = {
to_bytes('lsks'): True,
to_bytes('ping'): True,
to_bytes('strk'): True,
to_bytes('stpk'): True,
to_bytes('rstk'): True,
to_bytes('itpk'): True,
to_bytes('run '): True,
}
def exit_work_item():
sys.exit(0)
class iPythonReadLine(object):
def __init__(self):
self._input = io.open(sys.stdin.fileno(), encoding='utf-8')
def _deserialize(self, request):
"""Deserialize request from VSCode.
Args:
request: String with raw request from VSCode.
Returns:
Python dictionary with request data.
"""
return json.loads(request)
def _set_request_config(self, config):
self.use_snippets = config.get('useSnippets')
self.show_doc_strings = config.get('showDescriptions', True)
self.fuzzy_matcher = config.get('fuzzyMatcher', False)
def _process_request(self, request):
"""Accept serialized request from VSCode and write response.
"""
request = self._deserialize(request)
self._set_request_config(request.get('config', {}))
lookup = request.get('lookup', 'completions')
if lookup == 'definitions':
return self._write_response('defs')
elif lookup == 'arguments':
return self._write_response('arguments')
elif lookup == 'usages':
return self._write_response('usages')
else:
return self._write_response('Dont Know')
def _write_response(self, response):
sys.stdout.write(response + '\n')
sys.stdout.flush()
def watch(self):
port = int(sys.argv[1])
_debug_write('Socket port received: ' + str(port))
server = iPythonSocketServer()
server.connect(port)
sys.__stdout__.write('Started')
sys.__stdout__.write("\n")
sys.__stdout__.flush()
while True:
try:
self._process_request(self._input.readline())
except Exception:
sys.stderr.write(traceback.format_exc() + '\n')
sys.stderr.flush()
if __name__ == '__main__':
iPythonReadLine().watch()