File size: 2,776 Bytes
d1ceb73 |
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 |
"""Abstract base class for kernel clients"""
# -----------------------------------------------------------------------------
# Copyright (c) The Jupyter Development Team
#
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
# -----------------------------------------------------------------------------
# -----------------------------------------------------------------------------
# Imports
# -----------------------------------------------------------------------------
from __future__ import annotations
import abc
from typing import TYPE_CHECKING, Any
if TYPE_CHECKING:
from .channelsabc import ChannelABC
# -----------------------------------------------------------------------------
# Main kernel client class
# -----------------------------------------------------------------------------
class KernelClientABC(metaclass=abc.ABCMeta):
"""KernelManager ABC.
The docstrings for this class can be found in the base implementation:
`jupyter_client.client.KernelClient`
"""
@abc.abstractproperty
def kernel(self) -> Any:
pass
@abc.abstractproperty
def shell_channel_class(self) -> type[ChannelABC]:
pass
@abc.abstractproperty
def iopub_channel_class(self) -> type[ChannelABC]:
pass
@abc.abstractproperty
def hb_channel_class(self) -> type[ChannelABC]:
pass
@abc.abstractproperty
def stdin_channel_class(self) -> type[ChannelABC]:
pass
@abc.abstractproperty
def control_channel_class(self) -> type[ChannelABC]:
pass
# --------------------------------------------------------------------------
# Channel management methods
# --------------------------------------------------------------------------
@abc.abstractmethod
def start_channels(
self,
shell: bool = True,
iopub: bool = True,
stdin: bool = True,
hb: bool = True,
control: bool = True,
) -> None:
"""Start the channels for the client."""
pass
@abc.abstractmethod
def stop_channels(self) -> None:
"""Stop the channels for the client."""
pass
@abc.abstractproperty
def channels_running(self) -> bool:
"""Get whether the channels are running."""
pass
@abc.abstractproperty
def shell_channel(self) -> ChannelABC:
pass
@abc.abstractproperty
def iopub_channel(self) -> ChannelABC:
pass
@abc.abstractproperty
def stdin_channel(self) -> ChannelABC:
pass
@abc.abstractproperty
def hb_channel(self) -> ChannelABC:
pass
@abc.abstractproperty
def control_channel(self) -> ChannelABC:
pass
|