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