Module omnipy.api.protocols.private.engine

Overview

View Source

from typing import Protocol, runtime_checkable, Type

from omnipy.api.protocols.private.log import IsRunStateRegistry

from omnipy.api.protocols.public.config import IsEngineConfig

@runtime_checkable

class IsEngine(Protocol):

    """"""

    def __init__(self) -> None:

        ...

    @classmethod

    def get_config_cls(cls) -> Type[IsEngineConfig]:

        ...

    def set_config(self, config: IsEngineConfig) -> None:

        ...

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

        ...

Classes

IsEngine

class IsEngine(
    *args,
    **kwargs
)

View Source

@runtime_checkable

class IsEngine(Protocol):

    """"""

    def __init__(self) -> None:

        ...

    @classmethod

    def get_config_cls(cls) -> Type[IsEngineConfig]:

        ...

    def set_config(self, config: IsEngineConfig) -> None:

        ...

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

        ...

---

Static methods

get_config_cls

def get_config_cls(

) -> Type[omnipy.api.protocols.public.config.IsEngineConfig]

Returns:

Type	Description
Type[IsEngineConfig]

View Source

    @classmethod

    def get_config_cls(cls) -> Type[IsEngineConfig]:

        ...

Methods

set_config

def set_config(
    self,
    config: omnipy.api.protocols.public.config.IsEngineConfig
) -> None

Parameters:

Name	Type	Description	Default
config	IsEngineConfig

Returns:

Type	Description
NoneType

View Source

    def set_config(self, config: IsEngineConfig) -> None:

        ...

set_registry

def set_registry(
    self,
    registry: omnipy.api.protocols.private.log.IsRunStateRegistry | None
) -> None

Parameters:

Name	Type	Description	Default
registry	omnipy.api.protocols.private.log.IsRunStateRegistry	None

Returns:

Type	Description
NoneType

View Source

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

        ...