Skip to content

omnipy.shared.protocols.engine.base

CLASS DESCRIPTION
IsEngine

IsEngine

Bases: Protocol

METHOD DESCRIPTION
__init__
get_config_cls
set_config
set_registry
ATTRIBUTE DESCRIPTION
config

TYPE: IsJobRunnerConfig

registry

TYPE: IsRunStateRegistry | None

Source code in src/omnipy/shared/protocols/engine/base.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
@runtime_checkable
class IsEngine(Protocol):
    """"""
    def __init__(self) -> None:
        ...

    @classmethod
    def get_config_cls(cls) -> Type[IsJobRunnerConfig]:
        ...

    def set_config(self, config: IsJobRunnerConfig) -> None:
        ...

    def set_registry(self, registry: IsRunStateRegistry | None) -> None:
        ...

    @property
    def config(self) -> IsJobRunnerConfig:
        ...

    @property
    def registry(self) -> IsRunStateRegistry | None:
        ...

config property 

config: IsJobRunnerConfig

registry property 

registry: IsRunStateRegistry | None

__init__ 

__init__() -> None
Source code in src/omnipy/shared/protocols/engine/base.py 
10
11
def __init__(self) -> None:
    ...

get_config_cls classmethod 

get_config_cls() -> Type[IsJobRunnerConfig]
Source code in src/omnipy/shared/protocols/engine/base.py 
13
14
15
@classmethod
def get_config_cls(cls) -> Type[IsJobRunnerConfig]:
    ...

set_config 

set_config(config: IsJobRunnerConfig) -> None
Source code in src/omnipy/shared/protocols/engine/base.py 
17
18
def set_config(self, config: IsJobRunnerConfig) -> None:
    ...

set_registry 

set_registry(registry: IsRunStateRegistry | None) -> None
Source code in src/omnipy/shared/protocols/engine/base.py 
20
21
def set_registry(self, registry: IsRunStateRegistry | None) -> None:
    ...