omnipy.config.engine

Configuration models for selecting and tuning job runner engines.

CLASS	DESCRIPTION
EngineConfig	Top-level engine selection and per-engine configuration.
JobRunnerConfig	Base configuration shared by all job runner engines.
LocalRunnerConfig	Configuration for the local in-process job runner.
PrefectEngineConfig	Configuration for the Prefect-backed job runner.

EngineConfig

Bases: ConfigBase

              flowchart BT
              omnipy.config.engine.EngineConfig[EngineConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.ConfigBase --> omnipy.config.engine.EngineConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                




              click omnipy.config.engine.EngineConfig href "" "omnipy.config.engine.EngineConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

Top-level engine selection and per-engine configuration.

Used by:

• Reference Code reference omnipy hub  runtime  RuntimeConfig  engine

ATTRIBUTE	DESCRIPTION
choice	TYPE: EngineChoice.Literals
local	TYPE: IsLocalRunnerConfig
prefect	TYPE: IsPrefectEngineConfig

Source code in src/omnipy/config/engine.py

class EngineConfig(ConfigBase):
    """Top-level engine selection and per-engine configuration."""

    choice: EngineChoice.Literals = EngineChoice.LOCAL
    local: IsLocalRunnerConfig = pyd.Field(default_factory=LocalRunnerConfig)
    prefect: IsPrefectEngineConfig = pyd.Field(default_factory=PrefectEngineConfig)

choice class-attribute instance-attribute

choice: EngineChoice.Literals = EngineChoice.LOCAL

local class-attribute instance-attribute

local: IsLocalRunnerConfig = pyd.Field(default_factory=LocalRunnerConfig)

prefect class-attribute instance-attribute

prefect: IsPrefectEngineConfig = pyd.Field(default_factory=PrefectEngineConfig)

JobRunnerConfig

Bases: ConfigBase

              flowchart BT
              omnipy.config.engine.JobRunnerConfig[JobRunnerConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.ConfigBase --> omnipy.config.engine.JobRunnerConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                




              click omnipy.config.engine.JobRunnerConfig href "" "omnipy.config.engine.JobRunnerConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

Base configuration shared by all job runner engines.

Subclassed by:

• Reference Code reference omnipy config  engine
  •  LocalRunnerConfig
  •  PrefectEngineConfig

Source code in src/omnipy/config/engine.py

class JobRunnerConfig(ConfigBase):
    """Base configuration shared by all job runner engines."""

    ...

LocalRunnerConfig

Bases: JobRunnerConfig

              flowchart BT
              omnipy.config.engine.LocalRunnerConfig[LocalRunnerConfig]
              omnipy.config.engine.JobRunnerConfig[JobRunnerConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.engine.JobRunnerConfig --> omnipy.config.engine.LocalRunnerConfig
                                omnipy.config.ConfigBase --> omnipy.config.engine.JobRunnerConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                





              click omnipy.config.engine.LocalRunnerConfig href "" "omnipy.config.engine.LocalRunnerConfig"
              click omnipy.config.engine.JobRunnerConfig href "" "omnipy.config.engine.JobRunnerConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

Configuration for the local in-process job runner.

Used by:

• Reference Code reference omnipy config  engine  EngineConfig  local

Source code in src/omnipy/config/engine.py

class LocalRunnerConfig(JobRunnerConfig):
    """Configuration for the local in-process job runner."""

    ...

PrefectEngineConfig

Bases: JobRunnerConfig

              flowchart BT
              omnipy.config.engine.PrefectEngineConfig[PrefectEngineConfig]
              omnipy.config.engine.JobRunnerConfig[JobRunnerConfig]
              omnipy.config.ConfigBase[ConfigBase]
              omnipy.util.publisher.DataPublisher[DataPublisher]

                              omnipy.config.engine.JobRunnerConfig --> omnipy.config.engine.PrefectEngineConfig
                                omnipy.config.ConfigBase --> omnipy.config.engine.JobRunnerConfig
                                omnipy.util.publisher.DataPublisher --> omnipy.config.ConfigBase
                                omnipy.util.pydantic.BaseModel --> omnipy.util.publisher.DataPublisher
                





              click omnipy.config.engine.PrefectEngineConfig href "" "omnipy.config.engine.PrefectEngineConfig"
              click omnipy.config.engine.JobRunnerConfig href "" "omnipy.config.engine.JobRunnerConfig"
              click omnipy.config.ConfigBase href "" "omnipy.config.ConfigBase"
              click omnipy.util.publisher.DataPublisher href "" "omnipy.util.publisher.DataPublisher"
            

Configuration for the Prefect-backed job runner.

Used by:

• Reference Code reference omnipy config  engine  EngineConfig  prefect

ATTRIBUTE	DESCRIPTION
use_cached_results	TYPE: bool

Source code in src/omnipy/config/engine.py

class PrefectEngineConfig(JobRunnerConfig):
    """Configuration for the Prefect-backed job runner."""

    use_cached_results: bool = False

use_cached_results class-attribute instance-attribute

use_cached_results: bool = False