File size: 1,490 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 |
"""Abstract base class for kernel managers."""
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
import abc
from typing import Any
class KernelManagerABC(metaclass=abc.ABCMeta):
"""KernelManager ABC.
The docstrings for this class can be found in the base implementation:
`jupyter_client.manager.KernelManager`
"""
@abc.abstractproperty
def kernel(self) -> Any:
pass
# --------------------------------------------------------------------------
# Kernel management
# --------------------------------------------------------------------------
@abc.abstractmethod
def start_kernel(self, **kw: Any) -> None:
"""Start the kernel."""
pass
@abc.abstractmethod
def shutdown_kernel(self, now: bool = False, restart: bool = False) -> None:
"""Shut down the kernel."""
pass
@abc.abstractmethod
def restart_kernel(self, now: bool = False, **kw: Any) -> None:
"""Restart the kernel."""
pass
@abc.abstractproperty
def has_kernel(self) -> bool:
pass
@abc.abstractmethod
def interrupt_kernel(self) -> None:
"""Interrupt the kernel."""
pass
@abc.abstractmethod
def signal_kernel(self, signum: int) -> None:
"""Send a signal to the kernel."""
pass
@abc.abstractmethod
def is_alive(self) -> bool:
"""Test whether the kernel is alive."""
pass
|