Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1"""Abstract base class for kernel clients"""
3# -----------------------------------------------------------------------------
4# Copyright (c) The Jupyter Development Team
5#
6# Distributed under the terms of the BSD License. The full license is in
7# the file COPYING, distributed as part of this software.
8# -----------------------------------------------------------------------------
9# -----------------------------------------------------------------------------
10# Imports
11# -----------------------------------------------------------------------------
12from __future__ import annotations
14import abc
15from typing import TYPE_CHECKING, Any
17if TYPE_CHECKING:
18 from .channelsabc import ChannelABC
20# -----------------------------------------------------------------------------
21# Main kernel client class
22# -----------------------------------------------------------------------------
25class KernelClientABC(metaclass=abc.ABCMeta):
26 """KernelManager ABC.
28 The docstrings for this class can be found in the base implementation:
30 `jupyter_client.client.KernelClient`
31 """
33 @abc.abstractproperty
34 def kernel(self) -> Any:
35 pass
37 @abc.abstractproperty
38 def shell_channel_class(self) -> type[ChannelABC]:
39 pass
41 @abc.abstractproperty
42 def iopub_channel_class(self) -> type[ChannelABC]:
43 pass
45 @abc.abstractproperty
46 def hb_channel_class(self) -> type[ChannelABC]:
47 pass
49 @abc.abstractproperty
50 def stdin_channel_class(self) -> type[ChannelABC]:
51 pass
53 @abc.abstractproperty
54 def control_channel_class(self) -> type[ChannelABC]:
55 pass
57 # --------------------------------------------------------------------------
58 # Channel management methods
59 # --------------------------------------------------------------------------
61 @abc.abstractmethod
62 def start_channels(
63 self,
64 shell: bool = True,
65 iopub: bool = True,
66 stdin: bool = True,
67 hb: bool = True,
68 control: bool = True,
69 ) -> None:
70 """Start the channels for the client."""
71 pass
73 @abc.abstractmethod
74 def stop_channels(self) -> None:
75 """Stop the channels for the client."""
76 pass
78 @abc.abstractproperty
79 def channels_running(self) -> bool:
80 """Get whether the channels are running."""
81 pass
83 @abc.abstractproperty
84 def shell_channel(self) -> ChannelABC:
85 pass
87 @abc.abstractproperty
88 def iopub_channel(self) -> ChannelABC:
89 pass
91 @abc.abstractproperty
92 def stdin_channel(self) -> ChannelABC:
93 pass
95 @abc.abstractproperty
96 def hb_channel(self) -> ChannelABC:
97 pass
99 @abc.abstractproperty
100 def control_channel(self) -> ChannelABC:
101 pass