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 managers."""
3# Copyright (c) Jupyter Development Team.
4# Distributed under the terms of the Modified BSD License.
5import abc
6from typing import Any
9class KernelManagerABC(metaclass=abc.ABCMeta):
10 """KernelManager ABC.
12 The docstrings for this class can be found in the base implementation:
14 `jupyter_client.manager.KernelManager`
15 """
17 @abc.abstractproperty
18 def kernel(self) -> Any:
19 pass
21 # --------------------------------------------------------------------------
22 # Kernel management
23 # --------------------------------------------------------------------------
25 @abc.abstractmethod
26 def start_kernel(self, **kw: Any) -> None:
27 """Start the kernel."""
28 pass
30 @abc.abstractmethod
31 def shutdown_kernel(self, now: bool = False, restart: bool = False) -> None:
32 """Shut down the kernel."""
33 pass
35 @abc.abstractmethod
36 def restart_kernel(self, now: bool = False, **kw: Any) -> None:
37 """Restart the kernel."""
38 pass
40 @abc.abstractproperty
41 def has_kernel(self) -> bool:
42 pass
44 @abc.abstractmethod
45 def interrupt_kernel(self) -> None:
46 """Interrupt the kernel."""
47 pass
49 @abc.abstractmethod
50 def signal_kernel(self, signum: int) -> None:
51 """Send a signal to the kernel."""
52 pass
54 @abc.abstractmethod
55 def is_alive(self) -> bool:
56 """Test whether the kernel is alive."""
57 pass