forked from ipython/ipykernel
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathkernelbase.py
More file actions
1411 lines (1210 loc) · 50.2 KB
/
kernelbase.py
File metadata and controls
1411 lines (1210 loc) · 50.2 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
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Base class for a kernel that talks to frontends over 0MQ."""
# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
from __future__ import annotations
import inspect
import itertools
import logging
import os
import queue
import sys
import threading
import time
import typing as t
import uuid
import warnings
from datetime import datetime
from functools import partial
from signal import SIGINT, SIGTERM, Signals
from .thread import CONTROL_THREAD_NAME
if sys.platform != "win32":
from signal import SIGKILL
else:
SIGKILL = "windown-SIGKILL-sentinel"
try:
# jupyter_client >= 5, use tz-aware now
from jupyter_client.session import utcnow as now
except ImportError:
# jupyter_client < 5, use local now()
now = datetime.now
import psutil
import zmq
import zmq_anyio
from anyio import TASK_STATUS_IGNORED, create_task_group, sleep, to_thread
from anyio.abc import TaskStatus
from IPython.core.error import StdinNotImplementedError
from jupyter_client.session import Session
from traitlets.config.configurable import SingletonConfigurable
from traitlets.traitlets import (
Any,
Bool,
Dict,
Float,
Instance,
Integer,
List,
Unicode,
default,
)
from ipykernel.jsonutil import json_clean
from ._version import kernel_protocol_version
from .iostream import OutStream
_AWAITABLE_MESSAGE: str = (
"For consistency across implementations, it is recommended that `{func_name}`"
" either be a coroutine function (`async def`) or return an awaitable object"
" (like an `asyncio.Future`). It might become a requirement in the future."
" Coroutine functions and awaitables have been supported since"
" ipykernel 6.0 (2021). {target} does not seem to return an awaitable"
)
def _accepts_parameters(meth, param_names):
parameters = inspect.signature(meth).parameters
accepts = dict.fromkeys(param_names, False)
for param in param_names:
param_spec = parameters.get(param)
accepts[param] = (
param_spec
and param_spec.kind in [param_spec.KEYWORD_ONLY, param_spec.POSITIONAL_OR_KEYWORD]
) or any(p.kind == p.VAR_KEYWORD for p in parameters.values())
return accepts
class Kernel(SingletonConfigurable):
"""The base kernel class."""
_aborted_time: float
# ---------------------------------------------------------------------------
# Kernel interface
# ---------------------------------------------------------------------------
# attribute to override with a GUI
eventloop = Any(None)
processes: dict[str, psutil.Process] = {}
session = Instance(Session, allow_none=True)
profile_dir = Instance("IPython.core.profiledir.ProfileDir", allow_none=True)
shell_socket = Instance(zmq_anyio.Socket, allow_none=True)
implementation: str
implementation_version: str
banner: str
_is_test = Bool(False)
control_socket = Instance(zmq_anyio.Socket, allow_none=True)
control_tasks: t.Any = List()
debug_shell_socket = Any()
control_thread = Any()
shell_channel_thread = Any()
iopub_socket = Any()
iopub_thread = Any()
stdin_socket = Any()
log: logging.Logger = Instance(logging.Logger, allow_none=True) # type:ignore[assignment]
# identities:
int_id = Integer(-1)
ident = Unicode()
@default("ident")
def _default_ident(self):
return str(uuid.uuid4())
# This should be overridden by wrapper kernels that implement any real
# language.
language_info: dict[str, object] = {}
# any links that should go in the help menu
help_links: List[dict[str, str]] = List()
# Experimental option to break in non-user code.
# The ipykernel source is in the call stack, so the user
# has to manipulate the step-over and step-into in a wize way.
debug_just_my_code = Bool(
True,
help="""Set to False if you want to debug python standard and dependent libraries.
""",
).tag(config=True)
# track associations with current request
# Private interface
_darwin_app_nap = Bool(
True,
help="""Whether to use appnope for compatibility with OS X App Nap.
Only affects OS X >= 10.9.
""",
).tag(config=True)
# track associations with current request
_allow_stdin = Bool(False)
_parents: Dict[str, t.Any] = Dict({"shell": {}, "control": {}})
_parent_ident = Dict({"shell": b"", "control": b""})
@property
def _parent_header(self):
warnings.warn(
"Kernel._parent_header is deprecated in ipykernel 6. Use .get_parent()",
DeprecationWarning,
stacklevel=2,
)
return self.get_parent()
# Time to sleep after flushing the stdout/err buffers in each execute
# cycle. While this introduces a hard limit on the minimal latency of the
# execute cycle, it helps prevent output synchronization problems for
# clients.
# Units are in seconds. The minimum zmq latency on local host is probably
# ~150 microseconds, set this to 500us for now. We may need to increase it
# a little if it's not enough after more interactive testing.
_execute_sleep = Float(0.0005).tag(config=True)
# Frequency of the kernel's event loop.
# Units are in seconds, kernel subclasses for GUI toolkits may need to
# adapt to milliseconds.
_poll_interval = Float(0.01).tag(config=True)
stop_on_error_timeout = Float(
0.0,
config=True,
help="""time (in seconds) to wait for messages to arrive
when aborting queued requests after an error.
Requests that arrive within this window after an error
will be cancelled.
Increase in the event of unusually slow network
causing significant delays,
which can manifest as e.g. "Run all" in a notebook
aborting some, but not all, messages after an error.
""",
)
# If the shutdown was requested over the network, we leave here the
# necessary reply message so it can be sent by our registered atexit
# handler. This ensures that the reply is only sent to clients truly at
# the end of our shutdown process (which happens after the underlying
# IPython shell's own shutdown).
_shutdown_message = None
# This is a dict of port number that the kernel is listening on. It is set
# by record_ports and used by connect_request.
_recorded_ports = Dict()
# Track execution count here. For IPython, we override this to use the
# execution count we store in the shell.
execution_count = 0
msg_types = [
"execute_request",
"complete_request",
"inspect_request",
"history_request",
"comm_info_request",
"kernel_info_request",
"connect_request",
"shutdown_request",
"is_complete_request",
"interrupt_request",
]
# control channel accepts all shell messages
# and some of its own
control_msg_types = [
*msg_types,
"debug_request",
"usage_request",
"create_subshell_request",
"delete_subshell_request",
"list_subshell_request",
]
_eventloop_set: threading.Event
def __init__(self, **kwargs):
"""Initialize the kernel."""
super().__init__(**kwargs)
self._eventloop_set = threading.Event()
# Kernel application may swap stdout and stderr to OutStream,
# which is the case in `IPKernelApp.init_io`, hence `sys.stdout`
# can already by different from TextIO at initialization time.
self._stdout: OutStream | t.TextIO = sys.stdout
self._stderr: OutStream | t.TextIO = sys.stderr
# Build dict of handlers for message types
self.shell_handlers = {}
for msg_type in self.msg_types:
self.shell_handlers[msg_type] = getattr(self, msg_type)
self.control_handlers = {}
for msg_type in self.control_msg_types:
self.control_handlers[msg_type] = getattr(self, msg_type)
# Storing the accepted parameters for do_execute, used in execute_request
self._do_exec_accepted_params = _accepts_parameters(
self.do_execute, ["cell_meta", "cell_id"]
)
async def process_control(self):
try:
while True:
await self.process_control_message()
except BaseException:
if self.control_stop.is_set():
return
raise
async def process_control_message(self, msg=None):
"""dispatch control requests"""
assert self.control_socket is not None
assert self.session is not None
assert self.control_thread is None or threading.current_thread() == self.control_thread
msg = msg or await self.control_socket.arecv_multipart().wait()
idents, msg = self.session.feed_identities(msg)
try:
msg = self.session.deserialize(msg, content=True)
except Exception:
self.log.error("Invalid Control Message", exc_info=True) # noqa: G201
return
self.log.debug("Control received: %s", msg)
# Set the parent message for side effects.
self.set_parent(idents, msg, channel="control")
self._publish_status("busy", "control")
header = msg["header"]
msg_type = header["msg_type"]
handler = self.control_handlers.get(msg_type, None)
if handler is None:
self.log.error("UNKNOWN CONTROL MESSAGE TYPE: %r", msg_type)
else:
try:
result = handler(self.control_socket, idents, msg)
if inspect.isawaitable(result):
await result
except Exception:
self.log.error("Exception in control handler:", exc_info=True) # noqa: G201
if sys.stdout is not None:
sys.stdout.flush()
if sys.stderr is not None:
sys.stderr.flush()
self._publish_status("idle", "control")
def should_handle(self, stream, msg, idents):
"""Check whether a shell-channel message should be handled
Allows subclasses to prevent handling of certain messages (e.g. aborted requests).
.. versionchanged:: 7
Subclass should_handle _may_ be async.
Base class implementation is not async.
"""
return True
async def enter_eventloop(self):
"""enter eventloop"""
self.log.info("Entering eventloop %s", self.eventloop)
# record handle, so we can check when this changes
eventloop = self.eventloop
if eventloop is None:
# Do not warn if shutting down.
if not (hasattr(self, "shell") and self.shell.exit_now):
self.log.info("Exiting as there is no eventloop")
return
async def advance_eventloop():
# check if eventloop changed:
if self.eventloop is not eventloop:
self.log.info("exiting eventloop %s", eventloop)
return
self.log.debug("Advancing eventloop %s", eventloop)
try:
eventloop(self)
except KeyboardInterrupt:
# Ctrl-C shouldn't crash the kernel
self.log.error("KeyboardInterrupt caught in kernel")
# begin polling the eventloop
while self.eventloop is eventloop:
# flush the eventloop every so often,
# giving us a chance to handle messages in the meantime
self.log.debug("Scheduling eventloop advance")
await sleep(0.001)
await advance_eventloop()
_message_counter = Any(
help="""Monotonic counter of messages
""",
)
@default("_message_counter")
def _message_counter_default(self):
return itertools.count()
async def shell_channel_thread_main(self):
"""Main loop for shell channel thread.
Listen for incoming messages on kernel shell_socket. For each message
received, extract the subshell_id from the message header and forward the
message to the correct subshell via ZMQ inproc pair socket.
"""
assert self.shell_socket is not None
assert self.session is not None
assert self.shell_channel_thread is not None
assert threading.current_thread() == self.shell_channel_thread
async with self.shell_socket, create_task_group() as tg:
try:
while True:
msg = await self.shell_socket.arecv_multipart(copy=False).wait()
# deserialize only the header to get subshell_id
# Keep original message to send to subshell_id unmodified.
_, msg2 = self.session.feed_identities(msg, copy=False)
try:
msg3 = self.session.deserialize(msg2, content=False, copy=False)
subshell_id = msg3["header"].get("subshell_id")
# Find inproc pair socket to use to send message to correct subshell.
socket = self.shell_channel_thread.manager.get_shell_channel_socket(
subshell_id
)
assert socket is not None
if not socket.started.is_set():
await tg.start(socket.start)
await socket.asend_multipart(msg, copy=False).wait()
except Exception:
self.log.error("Invalid message", exc_info=True) # noqa: G201
except BaseException:
if self.shell_stop.is_set():
return
raise
async def shell_main(self, subshell_id: str | None):
"""Main loop for a single subshell."""
if self._supports_kernel_subshells:
if subshell_id is None:
assert threading.current_thread() == threading.main_thread()
else:
assert threading.current_thread() not in (
self.shell_channel_thread,
threading.main_thread(),
)
# Inproc pair socket that this subshell uses to talk to shell channel thread.
socket = self.shell_channel_thread.manager.get_other_socket(subshell_id)
else:
assert subshell_id is None
assert threading.current_thread() == threading.main_thread()
socket = None
async with create_task_group() as tg:
if not socket.started.is_set():
await tg.start(socket.start)
tg.start_soon(self.process_shell, socket)
if subshell_id is None:
# Main subshell.
await to_thread.run_sync(self.shell_stop.wait)
tg.cancel_scope.cancel()
async def process_shell(self, socket=None):
# socket=None is valid if kernel subshells are not supported.
try:
while True:
await self.process_shell_message(socket=socket)
except BaseException:
if self.shell_stop.is_set():
return
raise
async def process_shell_message(self, msg=None, socket=None):
# If socket is None kernel subshells are not supported so use socket=shell_socket.
# If msg is set, process that message.
# If msg is None, await the next message to arrive on the socket.
assert self.session is not None
if self._supports_kernel_subshells:
assert threading.current_thread() not in (
self.control_thread,
self.shell_channel_thread,
)
assert socket is not None
else:
assert threading.current_thread() == threading.main_thread()
assert socket is None
socket = self.shell_socket
no_msg = msg is None if self._is_test else not await socket.apoll(0).wait()
msg = msg or await socket.arecv_multipart(copy=False).wait()
received_time = time.monotonic()
copy = not isinstance(msg[0], zmq.Message)
idents, msg = self.session.feed_identities(msg, copy=copy)
try:
msg = self.session.deserialize(msg, content=True, copy=copy)
except BaseException:
self.log.error("Invalid Message", exc_info=True) # noqa: G201
return
# Set the parent message for side effects.
self.set_parent(idents, msg, channel="shell")
self._publish_status("busy", "shell")
msg_type = msg["header"]["msg_type"]
# Only abort execute requests
if self._aborting and msg_type == "execute_request":
if not self.stop_on_error_timeout:
if no_msg:
self._aborting = False
elif received_time - self._aborted_time > self.stop_on_error_timeout:
self._aborting = False
if self._aborting:
await self._send_abort_reply(socket, msg, idents)
self._publish_status("idle", "shell")
return
# Print some info about this message and leave a '--->' marker, so it's
# easier to trace visually the message chain when debugging. Each
# handler prints its message at the end.
self.log.debug("\n*** MESSAGE TYPE:%s***", msg_type)
self.log.debug(" Content: %s\n --->\n ", msg["content"])
should_handle: bool | t.Awaitable[bool] = self.should_handle(socket, msg, idents)
if inspect.isawaitable(should_handle):
should_handle = await should_handle
if not should_handle:
self.log.debug("Not handling %s:%s", msg_type, msg["header"].get("msg_id"))
return
handler = self.shell_handlers.get(msg_type)
if handler is None:
self.log.warning("Unknown message type: %r", msg_type)
else:
self.log.debug("%s: %s", msg_type, msg)
try:
self.pre_handler_hook()
except Exception:
self.log.debug("Unable to signal in pre_handler_hook:", exc_info=True)
try:
result = handler(socket, idents, msg)
if inspect.isawaitable(result):
await result
except Exception:
self.log.error("Exception in message handler:", exc_info=True) # noqa: G201
except KeyboardInterrupt:
# Ctrl-c shouldn't crash the kernel here.
self.log.error("KeyboardInterrupt caught in kernel.")
finally:
try:
self.post_handler_hook()
except Exception:
self.log.debug("Unable to signal in post_handler_hook:", exc_info=True)
if sys.stdout is not None:
sys.stdout.flush()
if sys.stderr is not None:
sys.stderr.flush()
self._publish_status("idle", "shell")
async def control_main(self):
assert self.control_socket is not None
async with self.control_socket, create_task_group() as tg:
for task in self.control_tasks:
tg.start_soon(task)
tg.start_soon(self.process_control)
await to_thread.run_sync(self.control_stop.wait)
tg.cancel_scope.cancel()
def pre_handler_hook(self):
"""Hook to execute before calling message handler"""
# ensure default_int_handler during handler call
def post_handler_hook(self):
"""Hook to execute after calling message handler"""
async def start(self, *, task_status: TaskStatus = TASK_STATUS_IGNORED) -> None:
"""Process messages on shell and control channels"""
async with create_task_group() as tg:
self.control_stop = threading.Event()
if not self._is_test and self.control_socket is not None:
if self.control_thread:
self.control_thread.start_soon(self.control_main)
self.control_thread.start()
else:
tg.start_soon(self.control_main)
self.shell_interrupt: queue.Queue[bool] = queue.Queue()
self.shell_is_awaiting = False
self.shell_is_blocking = False
self.shell_stop = threading.Event()
if self.shell_channel_thread:
tg.start_soon(self.shell_main, None)
# Assign tasks to and start shell channel thread.
manager = self.shell_channel_thread.manager
self.shell_channel_thread.start_soon(self.shell_channel_thread_main)
self.shell_channel_thread.start_soon(
partial(manager.listen_from_control, self.shell_main, self.shell_channel_thread)
)
self.shell_channel_thread.start_soon(manager.listen_from_subshells)
self.shell_channel_thread.start()
else:
if not self._is_test and self.shell_socket is not None:
tg.start_soon(self.shell_main, None)
def stop(self):
if not self._eventloop_set.is_set():
# Stop the async task that is waiting for the eventloop to be set.
self._eventloop_set.set()
self.shell_stop.set()
self.control_stop.set()
def record_ports(self, ports):
"""Record the ports that this kernel is using.
The creator of the Kernel instance must call this methods if they
want the :meth:`connect_request` method to return the port numbers.
"""
self._recorded_ports = ports
# ---------------------------------------------------------------------------
# Kernel request handlers
# ---------------------------------------------------------------------------
def _publish_execute_input(self, code, parent, execution_count):
"""Publish the code request on the iopub stream."""
if not self.session:
return
self.session.send(
self.iopub_socket,
"execute_input",
{"code": code, "execution_count": execution_count},
parent=parent,
ident=self._topic("execute_input"),
)
def _publish_status(self, status, channel, parent=None):
"""send status (busy/idle) on IOPub"""
if not self.session:
return
self.session.send(
self.iopub_socket,
"status",
{"execution_state": status},
parent=parent or self.get_parent(channel),
ident=self._topic("status"),
)
def _publish_debug_event(self, event):
if not self.session:
return
self.session.send(
self.iopub_socket,
"debug_event",
event,
parent=self.get_parent(),
ident=self._topic("debug_event"),
)
def set_parent(self, ident, parent, channel="shell"):
"""Set the current parent request
Side effects (IOPub messages) and replies are associated with
the request that caused them via the parent_header.
The parent identity is used to route input_request messages
on the stdin channel.
"""
self._parent_ident[channel] = ident
self._parents[channel] = parent
def get_parent(self, channel=None):
"""Get the parent request associated with a channel.
.. versionadded:: 6
Parameters
----------
channel : str
the name of the channel ('shell' or 'control')
Returns
-------
message : dict
the parent message for the most recent request on the channel.
"""
if channel is None:
# If a channel is not specified, get information from current thread
if threading.current_thread().name == CONTROL_THREAD_NAME:
channel = "control"
else:
channel = "shell"
return self._parents.get(channel, {})
def send_response(
self,
socket,
msg_or_type,
content=None,
ident=None,
buffers=None,
track=False,
header=None,
metadata=None,
channel=None,
):
"""Send a response to the message we're currently processing.
This accepts all the parameters of :meth:`jupyter_client.session.Session.send`
except ``parent``.
This relies on :meth:`set_parent` having been called for the current
message.
"""
if not self.session:
return None
return self.session.send(
socket,
msg_or_type,
content,
self.get_parent(channel),
ident,
buffers,
track,
header,
metadata,
)
def init_metadata(self, parent):
"""Initialize metadata.
Run at the beginning of execution requests.
"""
# FIXME: `started` is part of ipyparallel
# Remove for ipykernel 5.0
return {
"started": now(),
}
def finish_metadata(self, parent, metadata, reply_content):
"""Finish populating metadata.
Run after completing an execution request.
"""
return metadata
async def execute_request(self, socket, ident, parent):
"""handle an execute_request"""
if not self.session:
return
try:
content = parent["content"]
code = content["code"]
silent = content.get("silent", False)
store_history = content.get("store_history", not silent)
user_expressions = content.get("user_expressions", {})
allow_stdin = content.get("allow_stdin", False)
cell_meta = parent.get("metadata", {})
cell_id = cell_meta.get("cellId")
except Exception:
self.log.error("Got bad msg from parent: %s", parent)
return
stop_on_error = content.get("stop_on_error", True)
metadata = self.init_metadata(parent)
# Re-broadcast our input for the benefit of listening clients, and
# start computing output
if not silent:
self.execution_count += 1
self._publish_execute_input(code, parent, self.execution_count)
# Arguments based on the do_execute signature
do_execute_args = {
"code": code,
"silent": silent,
"store_history": store_history,
"user_expressions": user_expressions,
"allow_stdin": allow_stdin,
}
if self._do_exec_accepted_params["cell_meta"]:
do_execute_args["cell_meta"] = cell_meta
if self._do_exec_accepted_params["cell_id"]:
do_execute_args["cell_id"] = cell_id
# Call do_execute with the appropriate arguments
reply_content = self.do_execute(**do_execute_args)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_execute", target=self.do_execute),
PendingDeprecationWarning,
stacklevel=1,
)
# Flush output before sending the reply.
if sys.stdout is not None:
sys.stdout.flush()
if sys.stderr is not None:
sys.stderr.flush()
# FIXME: on rare occasions, the flush doesn't seem to make it to the
# clients... This seems to mitigate the problem, but we definitely need
# to better understand what's going on.
if self._execute_sleep:
time.sleep(self._execute_sleep)
# Send the reply.
reply_content = json_clean(reply_content)
metadata = self.finish_metadata(parent, metadata, reply_content)
reply_msg = self.session.send(
socket,
"execute_reply",
content=reply_content,
parent=parent,
metadata=metadata,
ident=ident,
)
self.log.debug("%s", reply_msg)
assert reply_msg is not None
if not silent and reply_msg["content"]["status"] == "error" and stop_on_error:
# while this flag is true,
# execute requests will be aborted
self._aborting = True
self._aborted_time = time.monotonic()
self.log.info("Aborting queue")
def do_execute(
self,
code,
silent,
store_history=True,
user_expressions=None,
allow_stdin=False,
*,
cell_meta=None,
cell_id=None,
):
"""Execute user code. Must be overridden by subclasses."""
raise NotImplementedError
async def complete_request(self, socket, ident, parent):
"""Handle a completion request."""
if not self.session:
return
content = parent["content"]
code = content["code"]
cursor_pos = content["cursor_pos"]
matches = self.do_complete(code, cursor_pos)
if inspect.isawaitable(matches):
matches = await matches
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_complete", target=self.do_complete),
PendingDeprecationWarning,
stacklevel=1,
)
matches = json_clean(matches)
self.session.send(socket, "complete_reply", matches, parent, ident)
def do_complete(self, code, cursor_pos):
"""Override in subclasses to find completions."""
return {
"matches": [],
"cursor_end": cursor_pos,
"cursor_start": cursor_pos,
"metadata": {},
"status": "ok",
}
async def inspect_request(self, socket, ident, parent):
"""Handle an inspect request."""
if not self.session:
return
content = parent["content"]
reply_content = self.do_inspect(
content["code"],
content["cursor_pos"],
content.get("detail_level", 0),
set(content.get("omit_sections", [])),
)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_inspect", target=self.do_inspect),
PendingDeprecationWarning,
stacklevel=1,
)
# Before we send this object over, we scrub it for JSON usage
reply_content = json_clean(reply_content)
msg = self.session.send(socket, "inspect_reply", reply_content, parent, ident)
self.log.debug("%s", msg)
def do_inspect(self, code, cursor_pos, detail_level=0, omit_sections=()):
"""Override in subclasses to allow introspection."""
return {"status": "ok", "data": {}, "metadata": {}, "found": False}
async def history_request(self, socket, ident, parent):
"""Handle a history request."""
if not self.session:
return
content = parent["content"]
reply_content = self.do_history(**content)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_history", target=self.do_history),
PendingDeprecationWarning,
stacklevel=1,
)
reply_content = json_clean(reply_content)
msg = self.session.send(socket, "history_reply", reply_content, parent, ident)
self.log.debug("%s", msg)
def do_history(
self,
hist_access_type,
output,
raw,
session=None,
start=None,
stop=None,
n=None,
pattern=None,
unique=False,
):
"""Override in subclasses to access history."""
return {"status": "ok", "history": []}
async def connect_request(self, socket, ident, parent):
"""Handle a connect request."""
if not self.session:
return
content = self._recorded_ports.copy() if self._recorded_ports else {}
content["status"] = "ok"
msg = self.session.send(socket, "connect_reply", content, parent, ident)
self.log.debug("%s", msg)
@property
def kernel_info(self):
from .debugger import _is_debugpy_available
supported_features: list[str] = []
if self._supports_kernel_subshells:
supported_features.append("kernel subshells")
if _is_debugpy_available:
supported_features.append("debugger")
return {
"protocol_version": kernel_protocol_version,
"implementation": self.implementation,
"implementation_version": self.implementation_version,
"language_info": self.language_info,
"banner": self.banner,
"help_links": self.help_links,
"supported_features": supported_features,
}
async def kernel_info_request(self, socket, ident, parent):
"""Handle a kernel info request."""
if not self.session:
return
content = {"status": "ok"}
content.update(self.kernel_info)
msg = self.session.send(socket, "kernel_info_reply", content, parent, ident)
self.log.debug("%s", msg)
async def comm_info_request(self, socket, ident, parent):
"""Handle a comm info request."""
if not self.session:
return
content = parent["content"]
target_name = content.get("target_name", None)
# Should this be moved to ipkernel?
if hasattr(self, "comm_manager"):
comms = {
k: dict(target_name=v.target_name)
for (k, v) in self.comm_manager.comms.items()
if v.target_name == target_name or target_name is None
}
else:
comms = {}
reply_content = dict(comms=comms, status="ok")
msg = self.session.send(socket, "comm_info_reply", reply_content, parent, ident)
self.log.debug("%s", msg)
def _send_interrupt_children(self):
if os.name == "nt":
self.log.error("Interrupt message not supported on Windows")
else:
pid = os.getpid()
pgid = os.getpgid(pid)
# Prefer process-group over process
# but only if the kernel is the leader of the process group
if pgid and pgid == pid and hasattr(os, "killpg"):
try:
os.killpg(pgid, SIGINT)
except OSError:
os.kill(pid, SIGINT)
raise
else:
os.kill(pid, SIGINT)
async def interrupt_request(self, socket, ident, parent):
"""Handle an interrupt request."""
if not self.session:
return
content: dict[str, t.Any] = {"status": "ok"}
try:
self._send_interrupt_children()
except OSError as err: