omnipy.shared.protocols.config

Protocols for Omnipy configuration objects and config sections.

CLASS	DESCRIPTION
IsBrowserUserInterfaceConfig	HTML UI configuration specialized for browser rendering.
IsColorConfig	Color settings shared by terminal and HTML-style renderers.
IsConfigBase	Base protocol for Omnipy configuration objects.
IsDataConfig	Top-level configuration bundle for data, models, and HTTP access.
IsDimsModeConfig	UI config that also exposes display-dimension refresh behavior.
IsDimsModeMixin	Mixin protocol for configs that track dimension refresh behavior.
IsEngineConfig	Top-level engine selection and per-engine configuration bundle.
IsFontConfig	Font settings for HTML-based Omnipy renderers.
IsHtmlUserInterfaceConfig	Base configuration for browser- and notebook-style HTML frontends.
IsHttpConfig	HTTP configuration with default and per-host request policies.
IsHttpRequestsConfig	HTTP retry and throttling policy for one request profile.
IsJobConfig	Job execution configuration shared across tasks and flows.
IsJobRunnerConfig	Base protocol for engine-specific job-runner configuration sections.
IsJupyterUserInterfaceConfig	HTML UI configuration specialized for Jupyter environments.
IsLayoutConfig	Panel and layout settings for structured output rendering.
IsLocalOutputStorageConfig	Filesystem-backed settings for persisted job outputs.
IsLocalRunnerConfig	Runner configuration for the local execution backend.
IsModelConfig	Configuration controlling model behavior and conversions.
IsOutputStorageConfig	Persisted-output policy and backend selection.
IsOutputStorageConfigBase	Base protocol for persisted-output storage backends.
IsOverflowConfig	Overflow behavior for horizontally and vertically constrained output.
IsPrefectEngineConfig	Runner configuration for the Prefect execution backend.
IsRootLogConfig	Root logging configuration for Omnipy runtime objects.
IsS3OutputStorageConfig	S3-compatible settings for persisted job outputs.
IsTerminalUserInterfaceConfig	Terminal-specific user-interface configuration.
IsTextConfig	Text-formatting settings used by Omnipy renderers.
IsUserInterfaceConfig	Top-level bundle of frontend-specific UI configuration sections.
IsUserInterfaceTypeConfig	Base configuration shared by concrete user-interface frontends.

IsBrowserUserInterfaceConfig

Bases: IsHtmlUserInterfaceConfig, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsBrowserUserInterfaceConfig[IsBrowserUserInterfaceConfig]
              omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig[IsHtmlUserInterfaceConfig]
              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig[IsUserInterfaceTypeConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig --> omnipy.shared.protocols.config.IsBrowserUserInterfaceConfig
                                omnipy.shared.protocols.config.IsUserInterfaceTypeConfig --> omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceTypeConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                





              click omnipy.shared.protocols.config.IsBrowserUserInterfaceConfig href "" "omnipy.shared.protocols.config.IsBrowserUserInterfaceConfig"
              click omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig href "" "omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig"
              click omnipy.shared.protocols.config.IsUserInterfaceTypeConfig href "" "omnipy.shared.protocols.config.IsUserInterfaceTypeConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

HTML UI configuration specialized for browser rendering.

Returned by:

• Reference Code reference omnipy
  • config  data  UserInterfaceConfig  browser
  • shared protocols  config  IsUserInterfaceConfig  browser

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
set_width_and_height	Update the preferred display dimensions for this frontend.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

ATTRIBUTE	DESCRIPTION
color	TYPE: IsColorConfig
font	TYPE: IsFontConfig
height	TYPE: pyd.NonNegativeInt | None
width	TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsBrowserUserInterfaceConfig(IsHtmlUserInterfaceConfig, Protocol):
    """HTML UI configuration specialized for browser rendering."""

    ...

color instance-attribute

color: IsColorConfig

font instance-attribute

font: IsFontConfig

height instance-attribute

height: pyd.NonNegativeInt | None

width instance-attribute

width: pyd.NonNegativeInt | None

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

set_width_and_height

set_width_and_height(width: pyd.NonNegativeInt | None, height: pyd.NonNegativeInt | None) -> None

Update the preferred display dimensions for this frontend.

PARAMETER	DESCRIPTION
width	New preferred width, or None when unknown. TYPE: pyd.NonNegativeInt | None
height	New preferred height, or None when unknown. TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """Update the preferred display dimensions for this frontend.

    Args:
        width: New preferred width, or ``None`` when unknown.
        height: New preferred height, or ``None`` when unknown.
    """

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsColorConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsColorConfig[IsColorConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsColorConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsColorConfig href "" "omnipy.shared.protocols.config.IsColorConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Color settings shared by terminal and HTML-style renderers.

ATTRIBUTE	DESCRIPTION
system	Available color-system capability for the target renderer. TYPE: DisplayColorSystem.Literals
style	Named color theme or explicit style identifier. TYPE: AllColorStyles.Literals | str
dark_background	Whether the target surface uses a dark background. TYPE: bool
solid_background	Whether panels should assume an opaque background. TYPE: bool

Returned by:

• Reference Code reference omnipy
  • config  data  UserInterfaceTypeConfig  color
  • shared protocols  config
    •  IsBrowserUserInterfaceConfig  color
    •  IsDimsModeConfig  color
    •  IsHtmlUserInterfaceConfig  color
    •  IsJupyterUserInterfaceConfig  color
    •  IsTerminalUserInterfaceConfig  color
    •  IsUserInterfaceTypeConfig  color

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsColorConfig(IsConfigBase, Protocol):
    """Color settings shared by terminal and HTML-style renderers.

    Attributes:
        system: Available color-system capability for the target renderer.
        style: Named color theme or explicit style identifier.
        dark_background: Whether the target surface uses a dark background.
        solid_background: Whether panels should assume an opaque background.
    """

    system: DisplayColorSystem.Literals
    style: AllColorStyles.Literals | str
    dark_background: bool
    solid_background: bool

dark_background instance-attribute

dark_background: bool

solid_background instance-attribute

solid_background: bool

style instance-attribute

style: AllColorStyles.Literals | str

system instance-attribute

system: DisplayColorSystem.Literals

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsConfigBase

Bases: IsDataPublisher, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                


              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Base protocol for Omnipy configuration objects.

Config objects publish updates, can be viewed as models, and provide a renderer-friendly string representation.

Subclassed by:

• Reference Code reference omnipy shared protocols
  •  config
    •  IsColorConfig
    •  IsDataConfig
    •  IsEngineConfig
    •  IsFontConfig
    •  IsHttpConfig
    •  IsHttpRequestsConfig
    •  IsJobConfig
    •  IsJobRunnerConfig
    •  IsLayoutConfig
    •  IsModelConfig
    •  IsOutputStorageConfig
    •  IsOutputStorageConfigBase
    •  IsOverflowConfig
    •  IsRootLogConfig
    •  IsTextConfig
    •  IsUserInterfaceConfig
    •  IsUserInterfaceTypeConfig
  • hub  runtime  IsRuntimeConfig

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsConfigBase(IsDataPublisher, Protocol):
    """Base protocol for Omnipy configuration objects.

    Config objects publish updates, can be viewed as models, and provide a
    renderer-friendly string representation.
    """
    def as_model(self) -> 'IsModel[Any]':
        ...

    def default_repr_to_terminal_str(
        self,
        ui_type: TerminalOutputUserInterfaceType.Literals,
    ) -> str:
        """Render the config for a terminal-style user interface.

        Args:
            ui_type: Terminal frontend variant requesting the representation.

        Returns:
            str: Terminal-friendly string representation of the config.
        """
        ...

    def __str__(self) -> str:
        ...

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsDataConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsDataConfig[IsDataConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsDataConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsDataConfig href "" "omnipy.shared.protocols.config.IsDataConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Top-level configuration bundle for data, models, and HTTP access.

ATTRIBUTE	DESCRIPTION
ui	User-interface and rendering settings. TYPE: IsUserInterfaceConfig
model	Model conversion and interaction settings. TYPE: IsModelConfig
http	HTTP retry and throttling settings. TYPE: IsHttpConfig

Returned by:

• Reference Code reference omnipy
  • data
    •  dataset  Dataset  config
    •  model  Model  config
    •  multi  MultiModelDataset  config
  • hub  runtime  RuntimeConfig  data
  • shared protocols
    •  data  IsDataClassCreator  config
    • hub  runtime  IsRuntimeConfig  data

Used by:

• Reference Code reference omnipy shared protocols  data  IsDataClassCreator  set_config

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsDataConfig(IsConfigBase, Protocol):
    """Top-level configuration bundle for data, models, and HTTP access.

    Attributes:
        ui: User-interface and rendering settings.
        model: Model conversion and interaction settings.
        http: HTTP retry and throttling settings.
    """

    ui: IsUserInterfaceConfig
    model: IsModelConfig
    http: IsHttpConfig

http instance-attribute

http: IsHttpConfig

model instance-attribute

model: IsModelConfig

ui instance-attribute

ui: IsUserInterfaceConfig

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsDimsModeConfig

Bases: IsUserInterfaceTypeConfig, IsDimsModeMixin, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsDimsModeConfig[IsDimsModeConfig]
              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig[IsUserInterfaceTypeConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]
              omnipy.shared.protocols.config.IsDimsModeMixin[IsDimsModeMixin]

                              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig --> omnipy.shared.protocols.config.IsDimsModeConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceTypeConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                


                omnipy.shared.protocols.config.IsDimsModeMixin --> omnipy.shared.protocols.config.IsDimsModeConfig
                


              click omnipy.shared.protocols.config.IsDimsModeConfig href "" "omnipy.shared.protocols.config.IsDimsModeConfig"
              click omnipy.shared.protocols.config.IsUserInterfaceTypeConfig href "" "omnipy.shared.protocols.config.IsUserInterfaceTypeConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
              click omnipy.shared.protocols.config.IsDimsModeMixin href "" "omnipy.shared.protocols.config.IsDimsModeMixin"
            

UI config that also exposes display-dimension refresh behavior.

Subclassed by:

• Reference Code reference omnipy shared protocols  config
  •  IsJupyterUserInterfaceConfig
  •  IsTerminalUserInterfaceConfig

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
set_width_and_height	Update the preferred display dimensions for this frontend.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

ATTRIBUTE	DESCRIPTION
color	TYPE: IsColorConfig
dims_mode	TYPE: DisplayDimensionsUpdateMode.Literals
height	TYPE: pyd.NonNegativeInt | None
width	TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsDimsModeConfig(IsUserInterfaceTypeConfig, IsDimsModeMixin, Protocol):
    """UI config that also exposes display-dimension refresh behavior."""

    ...

color instance-attribute

color: IsColorConfig

dims_mode class-attribute instance-attribute

dims_mode: DisplayDimensionsUpdateMode.Literals = DisplayDimensionsUpdateMode.AUTO

height instance-attribute

height: pyd.NonNegativeInt | None

width instance-attribute

width: pyd.NonNegativeInt | None

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

set_width_and_height

set_width_and_height(width: pyd.NonNegativeInt | None, height: pyd.NonNegativeInt | None) -> None

Update the preferred display dimensions for this frontend.

PARAMETER	DESCRIPTION
width	New preferred width, or None when unknown. TYPE: pyd.NonNegativeInt | None
height	New preferred height, or None when unknown. TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """Update the preferred display dimensions for this frontend.

    Args:
        width: New preferred width, or ``None`` when unknown.
        height: New preferred height, or ``None`` when unknown.
    """

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsDimsModeMixin

Bases: Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsDimsModeMixin[IsDimsModeMixin]

              

              click omnipy.shared.protocols.config.IsDimsModeMixin href "" "omnipy.shared.protocols.config.IsDimsModeMixin"
            

Mixin protocol for configs that track dimension refresh behavior.

ATTRIBUTE	DESCRIPTION
dims_mode	Policy controlling when display dimensions are refreshed. TYPE: DisplayDimensionsUpdateMode.Literals

Subclassed by:

• Reference Code reference omnipy shared protocols  config  IsDimsModeConfig

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsDimsModeMixin(Protocol):
    """Mixin protocol for configs that track dimension refresh behavior.

    Attributes:
        dims_mode: Policy controlling when display dimensions are refreshed.
    """

    dims_mode: DisplayDimensionsUpdateMode.Literals = DisplayDimensionsUpdateMode.AUTO

dims_mode class-attribute instance-attribute

dims_mode: DisplayDimensionsUpdateMode.Literals = DisplayDimensionsUpdateMode.AUTO

IsEngineConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsEngineConfig[IsEngineConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsEngineConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsEngineConfig href "" "omnipy.shared.protocols.config.IsEngineConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Top-level engine selection and per-engine configuration bundle.

ATTRIBUTE	DESCRIPTION
choice	Engine backend currently selected for execution. TYPE: EngineChoice.Literals
local	Configuration for the local backend. TYPE: IsLocalRunnerConfig
prefect	Configuration for the Prefect backend. TYPE: IsPrefectEngineConfig

Returned by:

• Reference Code reference omnipy
  • hub  runtime  RuntimeConfig  engine
  • shared protocols hub  runtime  IsRuntimeConfig  engine

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsEngineConfig(IsConfigBase, Protocol):
    """Top-level engine selection and per-engine configuration bundle.

    Attributes:
        choice: Engine backend currently selected for execution.
        local: Configuration for the local backend.
        prefect: Configuration for the Prefect backend.
    """

    choice: EngineChoice.Literals
    local: IsLocalRunnerConfig
    prefect: IsPrefectEngineConfig
    ...

choice instance-attribute

choice: EngineChoice.Literals

local instance-attribute

local: IsLocalRunnerConfig

prefect instance-attribute

prefect: IsPrefectEngineConfig

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsFontConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsFontConfig[IsFontConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsFontConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsFontConfig href "" "omnipy.shared.protocols.config.IsFontConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Font settings for HTML-based Omnipy renderers.

ATTRIBUTE	DESCRIPTION
families	Ordered list of font-family fallbacks. TYPE: tuple[str, ...]
size	Base font size. TYPE: pyd.NonNegativeFloat
weight	Default font weight. TYPE: pyd.NonNegativeInt
line_height	Relative line-height multiplier. TYPE: pyd.NonNegativeFloat

Returned by:

• Reference Code reference omnipy
  • config  data  HtmlUserInterfaceConfig  font
  • shared protocols  config
    •  IsBrowserUserInterfaceConfig  font
    •  IsHtmlUserInterfaceConfig  font
    •  IsJupyterUserInterfaceConfig  font

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsFontConfig(IsConfigBase, Protocol):
    """Font settings for HTML-based Omnipy renderers.

    Attributes:
        families: Ordered list of font-family fallbacks.
        size: Base font size.
        weight: Default font weight.
        line_height: Relative line-height multiplier.
    """

    families: tuple[str, ...]
    size: pyd.NonNegativeFloat
    weight: pyd.NonNegativeInt
    line_height: pyd.NonNegativeFloat

families instance-attribute

families: tuple[str, ...]

line_height instance-attribute

line_height: pyd.NonNegativeFloat

size instance-attribute

size: pyd.NonNegativeFloat

weight instance-attribute

weight: pyd.NonNegativeInt

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsHtmlUserInterfaceConfig

Bases: IsUserInterfaceTypeConfig, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig[IsHtmlUserInterfaceConfig]
              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig[IsUserInterfaceTypeConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig --> omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceTypeConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                




              click omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig href "" "omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig"
              click omnipy.shared.protocols.config.IsUserInterfaceTypeConfig href "" "omnipy.shared.protocols.config.IsUserInterfaceTypeConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Base configuration for browser- and notebook-style HTML frontends.

ATTRIBUTE	DESCRIPTION
font	Font settings used by the HTML renderer. TYPE: IsFontConfig

Subclassed by:

• Reference Code reference omnipy shared protocols  config
  •  IsBrowserUserInterfaceConfig
  •  IsJupyterUserInterfaceConfig

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
set_width_and_height	Update the preferred display dimensions for this frontend.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsHtmlUserInterfaceConfig(IsUserInterfaceTypeConfig, Protocol):
    """Base configuration for browser- and notebook-style HTML frontends.

    Attributes:
        font: Font settings used by the HTML renderer.
    """

    font: IsFontConfig

color instance-attribute

color: IsColorConfig

font instance-attribute

font: IsFontConfig

height instance-attribute

height: pyd.NonNegativeInt | None

width instance-attribute

width: pyd.NonNegativeInt | None

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

set_width_and_height

set_width_and_height(width: pyd.NonNegativeInt | None, height: pyd.NonNegativeInt | None) -> None

Update the preferred display dimensions for this frontend.

PARAMETER	DESCRIPTION
width	New preferred width, or None when unknown. TYPE: pyd.NonNegativeInt | None
height	New preferred height, or None when unknown. TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """Update the preferred display dimensions for this frontend.

    Args:
        width: New preferred width, or ``None`` when unknown.
        height: New preferred height, or ``None`` when unknown.
    """

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsHttpConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsHttpConfig[IsHttpConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsHttpConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsHttpConfig href "" "omnipy.shared.protocols.config.IsHttpConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

HTTP configuration with default and per-host request policies.

ATTRIBUTE	DESCRIPTION
defaults	Fallback request policy used when no host-specific override exists. TYPE: IsHttpRequestsConfig
for_host	Request-policy overrides keyed by host name. TYPE: defaultdict[str, IsHttpRequestsConfig]

Returned by:

• Reference Code reference omnipy
  • config  data  DataConfig  http
  • shared protocols  config  IsDataConfig  http

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsHttpConfig(IsConfigBase, Protocol):
    """HTTP configuration with default and per-host request policies.

    Attributes:
        defaults: Fallback request policy used when no host-specific override exists.
        for_host: Request-policy overrides keyed by host name.
    """

    defaults: IsHttpRequestsConfig
    for_host: defaultdict[str, IsHttpRequestsConfig]

defaults instance-attribute

defaults: IsHttpRequestsConfig

for_host instance-attribute

for_host: defaultdict[str, IsHttpRequestsConfig]

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsHttpRequestsConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsHttpRequestsConfig[IsHttpRequestsConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsHttpRequestsConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsHttpRequestsConfig href "" "omnipy.shared.protocols.config.IsHttpRequestsConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

HTTP retry and throttling policy for one request profile.

ATTRIBUTE	DESCRIPTION
requests_per_time_period	Maximum requests allowed per time window. TYPE: float
time_period_in_secs	Length of the throttling window in seconds. TYPE: float
retry_http_statuses	HTTP status codes that should trigger retries. TYPE: tuple[int, ...]
retry_attempts	Maximum number of retry attempts. TYPE: int
retry_backoff_strategy	Backoff strategy used between retries. TYPE: BackoffStrategy.Literals

Returned by:

• Reference Code reference omnipy
  • config  data  HttpConfig
    •  defaults
    •  for_host
  • shared protocols  config  IsHttpConfig
    •  defaults
    •  for_host

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsHttpRequestsConfig(IsConfigBase, Protocol):
    """HTTP retry and throttling policy for one request profile.

    Attributes:
        requests_per_time_period: Maximum requests allowed per time window.
        time_period_in_secs: Length of the throttling window in seconds.
        retry_http_statuses: HTTP status codes that should trigger retries.
        retry_attempts: Maximum number of retry attempts.
        retry_backoff_strategy: Backoff strategy used between retries.
    """

    requests_per_time_period: float
    time_period_in_secs: float
    retry_http_statuses: tuple[int, ...]
    retry_attempts: int
    retry_backoff_strategy: BackoffStrategy.Literals

requests_per_time_period instance-attribute

requests_per_time_period: float

retry_attempts instance-attribute

retry_attempts: int

retry_backoff_strategy instance-attribute

retry_backoff_strategy: BackoffStrategy.Literals

retry_http_statuses instance-attribute

retry_http_statuses: tuple[int, ...]

time_period_in_secs instance-attribute

time_period_in_secs: float

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsJobConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsJobConfig[IsJobConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsJobConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsJobConfig href "" "omnipy.shared.protocols.config.IsJobConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Job execution configuration shared across tasks and flows.

ATTRIBUTE	DESCRIPTION
output_storage	Settings controlling persisted job outputs. TYPE: IsOutputStorageConfig

Returned by:

• Reference Code reference omnipy
  • compute
    •  flow
      •  DagFlow  config
      •  DagFlowTemplateCore  config
      •  FuncFlow  config
      •  FuncFlowTemplateCore  config
      •  LinearFlow  config
      •  LinearFlowTemplateCore  config
    •  task
      •  Task  config
      •  TaskTemplateCore  config
  • hub  runtime  RuntimeConfig  job
  • shared protocols
    • compute
      •  job
        •  IsAnyFlow  config
        •  IsAnyFlowTemplate  config
        •  IsChildJobListArgJob  config
        •  IsChildJobListArgJobTemplate  config
        •  IsDagFlow  config
        •  IsDagFlowTemplate  config
        •  IsFuncArgJob  config
        •  IsFuncArgJobTemplate  config
        •  IsFuncFlow  config
        •  IsFuncFlowTemplate  config
        •  IsJob  config
        •  IsJobBase  config
        •  IsJobBaseCallable  config
        •  IsJobTemplate  config
        •  IsLinearFlow  config
        •  IsLinearFlowTemplate  config
        •  IsTask  config
        •  IsTaskTemplate  config
      •  job_creator
        •  IsJobConfigHolder  config
        •  IsJobCreator  config
    • hub  runtime  IsRuntimeConfig  job

Used by:

• Reference Code reference omnipy shared protocols compute  job_creator
  •  IsJobConfigHolder  set_config
  •  IsJobCreator  set_config

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsJobConfig(IsConfigBase, Protocol):
    """Job execution configuration shared across tasks and flows.

    Attributes:
        output_storage: Settings controlling persisted job outputs.
    """

    output_storage: IsOutputStorageConfig

output_storage instance-attribute

output_storage: IsOutputStorageConfig

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsJobRunnerConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsJobRunnerConfig[IsJobRunnerConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsJobRunnerConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsJobRunnerConfig href "" "omnipy.shared.protocols.config.IsJobRunnerConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Base protocol for engine-specific job-runner configuration sections.

Returned by:

• Reference Code reference omnipy
  • engine
    •  job_runner  JobRunnerEngine
      •  config
      •  get_config_cls
    •  local  LocalRunner  config
  • shared protocols engine
    •  base  IsEngine
      •  config
      •  get_config_cls
    •  job_runner  IsJobRunnerEngine
      •  config
      •  get_config_cls

Subclassed by:

• Reference Code reference omnipy shared protocols  config
  •  IsLocalRunnerConfig
  •  IsPrefectEngineConfig

Used by:

• Reference Code reference omnipy
  • engine
    •  job_runner  JobRunnerEngine  set_config
    •  local  LocalRunner  set_config
  • shared protocols engine
    •  base  IsEngine  set_config
    •  job_runner  IsJobRunnerEngine  set_config

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsJobRunnerConfig(IsConfigBase, Protocol):
    """Base protocol for engine-specific job-runner configuration sections."""

    ...

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsJupyterUserInterfaceConfig

Bases: IsHtmlUserInterfaceConfig, IsDimsModeConfig, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsJupyterUserInterfaceConfig[IsJupyterUserInterfaceConfig]
              omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig[IsHtmlUserInterfaceConfig]
              omnipy.shared.protocols.config.IsDimsModeConfig[IsDimsModeConfig]
              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig[IsUserInterfaceTypeConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]
              omnipy.shared.protocols.config.IsDimsModeMixin[IsDimsModeMixin]

                              omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig --> omnipy.shared.protocols.config.IsJupyterUserInterfaceConfig
                                omnipy.shared.protocols.config.IsUserInterfaceTypeConfig --> omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceTypeConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



                omnipy.shared.protocols.config.IsDimsModeConfig --> omnipy.shared.protocols.config.IsJupyterUserInterfaceConfig
                                omnipy.shared.protocols.config.IsUserInterfaceTypeConfig --> omnipy.shared.protocols.config.IsDimsModeConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceTypeConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                


                omnipy.shared.protocols.config.IsDimsModeMixin --> omnipy.shared.protocols.config.IsDimsModeConfig
                



              click omnipy.shared.protocols.config.IsJupyterUserInterfaceConfig href "" "omnipy.shared.protocols.config.IsJupyterUserInterfaceConfig"
              click omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig href "" "omnipy.shared.protocols.config.IsHtmlUserInterfaceConfig"
              click omnipy.shared.protocols.config.IsDimsModeConfig href "" "omnipy.shared.protocols.config.IsDimsModeConfig"
              click omnipy.shared.protocols.config.IsUserInterfaceTypeConfig href "" "omnipy.shared.protocols.config.IsUserInterfaceTypeConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
              click omnipy.shared.protocols.config.IsDimsModeMixin href "" "omnipy.shared.protocols.config.IsDimsModeMixin"
            

HTML UI configuration specialized for Jupyter environments.

Returned by:

• Reference Code reference omnipy
  • config  data  UserInterfaceConfig  jupyter
  • shared protocols
    •  config  IsUserInterfaceConfig  jupyter
    •  data  IsReactiveObjects  jupyter_ui_config

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
set_width_and_height	Update the preferred display dimensions for this frontend.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

ATTRIBUTE	DESCRIPTION
color	TYPE: IsColorConfig
dims_mode	TYPE: DisplayDimensionsUpdateMode.Literals
font	TYPE: IsFontConfig
height	TYPE: pyd.NonNegativeInt | None
width	TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsJupyterUserInterfaceConfig(IsHtmlUserInterfaceConfig, IsDimsModeConfig, Protocol):
    """HTML UI configuration specialized for Jupyter environments."""

    ...

color instance-attribute

color: IsColorConfig

dims_mode class-attribute instance-attribute

dims_mode: DisplayDimensionsUpdateMode.Literals = DisplayDimensionsUpdateMode.AUTO

font instance-attribute

font: IsFontConfig

height instance-attribute

height: pyd.NonNegativeInt | None

width instance-attribute

width: pyd.NonNegativeInt | None

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

set_width_and_height

set_width_and_height(width: pyd.NonNegativeInt | None, height: pyd.NonNegativeInt | None) -> None

Update the preferred display dimensions for this frontend.

PARAMETER	DESCRIPTION
width	New preferred width, or None when unknown. TYPE: pyd.NonNegativeInt | None
height	New preferred height, or None when unknown. TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """Update the preferred display dimensions for this frontend.

    Args:
        width: New preferred width, or ``None`` when unknown.
        height: New preferred height, or ``None`` when unknown.
    """

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsLayoutConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsLayoutConfig[IsLayoutConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsLayoutConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsLayoutConfig href "" "omnipy.shared.protocols.config.IsLayoutConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Panel and layout settings for structured output rendering.

ATTRIBUTE	DESCRIPTION
overflow	Overflow behavior used by panels and layouts. TYPE: IsOverflowConfig
panel_design	Visual panel style. TYPE: PanelDesign.Literals
panel_title_at_top	Whether panel titles should be rendered above content. TYPE: bool
max_title_height	Maximum title height policy. TYPE: MaxTitleHeight.Literals
min_panel_width	Minimum panel width before collapsing layout. TYPE: pyd.NonNegativeInt
min_crop_width	Minimum width before content is cropped. TYPE: pyd.NonNegativeInt
max_panels_hor	Maximum number of side-by-side panels, if limited. TYPE: pyd.NonNegativeInt | None
max_nesting_depth	Maximum nested panel depth, if limited. TYPE: pyd.NonNegativeInt | None
justify	Default content justification inside panels. TYPE: Justify.Literals

Returned by:

• Reference Code reference omnipy
  • config  data  UserInterfaceConfig  layout
  • shared protocols
    •  config  IsUserInterfaceConfig  layout
    •  data  IsReactiveObjects  layout_config

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsLayoutConfig(IsConfigBase, Protocol):
    """Panel and layout settings for structured output rendering.

    Attributes:
        overflow: Overflow behavior used by panels and layouts.
        panel_design: Visual panel style.
        panel_title_at_top: Whether panel titles should be rendered above content.
        max_title_height: Maximum title height policy.
        min_panel_width: Minimum panel width before collapsing layout.
        min_crop_width: Minimum width before content is cropped.
        max_panels_hor: Maximum number of side-by-side panels, if limited.
        max_nesting_depth: Maximum nested panel depth, if limited.
        justify: Default content justification inside panels.
    """

    overflow: IsOverflowConfig
    panel_design: PanelDesign.Literals
    panel_title_at_top: bool
    max_title_height: MaxTitleHeight.Literals
    min_panel_width: pyd.NonNegativeInt
    min_crop_width: pyd.NonNegativeInt
    max_panels_hor: pyd.NonNegativeInt | None
    max_nesting_depth: pyd.NonNegativeInt | None
    justify: Justify.Literals

justify instance-attribute

justify: Justify.Literals

max_nesting_depth instance-attribute

max_nesting_depth: pyd.NonNegativeInt | None

max_panels_hor instance-attribute

max_panels_hor: pyd.NonNegativeInt | None

max_title_height instance-attribute

max_title_height: MaxTitleHeight.Literals

min_crop_width instance-attribute

min_crop_width: pyd.NonNegativeInt

min_panel_width instance-attribute

min_panel_width: pyd.NonNegativeInt

overflow instance-attribute

overflow: IsOverflowConfig

panel_design instance-attribute

panel_design: PanelDesign.Literals

panel_title_at_top instance-attribute

panel_title_at_top: bool

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsLocalOutputStorageConfig

Bases: IsOutputStorageConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsLocalOutputStorageConfig[IsLocalOutputStorageConfig]
              omnipy.shared.protocols.config.IsOutputStorageConfigBase[IsOutputStorageConfigBase]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsOutputStorageConfigBase --> omnipy.shared.protocols.config.IsLocalOutputStorageConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsOutputStorageConfigBase
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                




              click omnipy.shared.protocols.config.IsLocalOutputStorageConfig href "" "omnipy.shared.protocols.config.IsLocalOutputStorageConfig"
              click omnipy.shared.protocols.config.IsOutputStorageConfigBase href "" "omnipy.shared.protocols.config.IsOutputStorageConfigBase"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Filesystem-backed settings for persisted job outputs.

Returned by:

• Reference Code reference omnipy
  • config  job  OutputStorageConfig  local
  • shared protocols  config  IsOutputStorageConfig  local

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

ATTRIBUTE	DESCRIPTION
persist_data_dir_path	TYPE: str

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsLocalOutputStorageConfig(IsOutputStorageConfigBase, Protocol):
    """Filesystem-backed settings for persisted job outputs."""

persist_data_dir_path instance-attribute

persist_data_dir_path: str

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsLocalRunnerConfig

Bases: IsJobRunnerConfig, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsLocalRunnerConfig[IsLocalRunnerConfig]
              omnipy.shared.protocols.config.IsJobRunnerConfig[IsJobRunnerConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsJobRunnerConfig --> omnipy.shared.protocols.config.IsLocalRunnerConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsJobRunnerConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                




              click omnipy.shared.protocols.config.IsLocalRunnerConfig href "" "omnipy.shared.protocols.config.IsLocalRunnerConfig"
              click omnipy.shared.protocols.config.IsJobRunnerConfig href "" "omnipy.shared.protocols.config.IsJobRunnerConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Runner configuration for the local execution backend.

Returned by:

• Reference Code reference omnipy
  • config  engine  EngineConfig  local
  • engine  local  LocalRunner  get_config_cls
  • shared protocols  config  IsEngineConfig  local

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsLocalRunnerConfig(IsJobRunnerConfig, Protocol):
    """Runner configuration for the local execution backend."""

    ...

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsModelConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsModelConfig[IsModelConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsModelConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsModelConfig href "" "omnipy.shared.protocols.config.IsModelConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Configuration controlling model behavior and conversions.

ATTRIBUTE	DESCRIPTION
interactive	Whether models favor interactive display behavior. TYPE: bool
dynamically_convert_elements_to_models	Whether nested elements are converted lazily. TYPE: bool

Returned by:

• Reference Code reference omnipy
  • config  data  DataConfig  model
  • shared protocols  config  IsDataConfig  model

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsModelConfig(IsConfigBase, Protocol):
    """Configuration controlling model behavior and conversions.

    Attributes:
        interactive: Whether models favor interactive display behavior.
        dynamically_convert_elements_to_models: Whether nested elements are converted lazily.
    """

    interactive: bool
    dynamically_convert_elements_to_models: bool

dynamically_convert_elements_to_models instance-attribute

dynamically_convert_elements_to_models: bool

interactive instance-attribute

interactive: bool

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsOutputStorageConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsOutputStorageConfig[IsOutputStorageConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsOutputStorageConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsOutputStorageConfig href "" "omnipy.shared.protocols.config.IsOutputStorageConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Persisted-output policy and backend selection.

ATTRIBUTE	DESCRIPTION
persist_outputs	Default policy for persisting job outputs. TYPE: ConfigPersistOutputsOptions.Literals
restore_outputs	Default policy for restoring persisted outputs. TYPE: ConfigRestoreOutputsOptions.Literals
protocol	Storage backend selected for persisted outputs. TYPE: ConfigOutputStorageProtocolOptions.Literals
local	Local-backend settings. TYPE: IsLocalOutputStorageConfig
s3	S3-backend settings. TYPE: IsS3OutputStorageConfig

Returned by:

• Reference Code reference omnipy
  • config  job  JobConfig  output_storage
  • shared protocols  config  IsJobConfig  output_storage

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsOutputStorageConfig(IsConfigBase, Protocol):
    """Persisted-output policy and backend selection.

    Attributes:
        persist_outputs: Default policy for persisting job outputs.
        restore_outputs: Default policy for restoring persisted outputs.
        protocol: Storage backend selected for persisted outputs.
        local: Local-backend settings.
        s3: S3-backend settings.
    """

    persist_outputs: ConfigPersistOutputsOptions.Literals
    restore_outputs: ConfigRestoreOutputsOptions.Literals
    protocol: ConfigOutputStorageProtocolOptions.Literals
    local: IsLocalOutputStorageConfig
    s3: IsS3OutputStorageConfig

local instance-attribute

local: IsLocalOutputStorageConfig

persist_outputs instance-attribute

persist_outputs: ConfigPersistOutputsOptions.Literals

protocol instance-attribute

protocol: ConfigOutputStorageProtocolOptions.Literals

restore_outputs instance-attribute

restore_outputs: ConfigRestoreOutputsOptions.Literals

s3 instance-attribute

s3: IsS3OutputStorageConfig

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsOutputStorageConfigBase

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsOutputStorageConfigBase[IsOutputStorageConfigBase]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsOutputStorageConfigBase
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsOutputStorageConfigBase href "" "omnipy.shared.protocols.config.IsOutputStorageConfigBase"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Base protocol for persisted-output storage backends.

ATTRIBUTE	DESCRIPTION
persist_data_dir_path	Root path used for persisted job outputs. TYPE: str

Subclassed by:

• Reference Code reference omnipy shared protocols  config
  •  IsLocalOutputStorageConfig
  •  IsS3OutputStorageConfig

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsOutputStorageConfigBase(IsConfigBase, Protocol):
    """Base protocol for persisted-output storage backends.

    Attributes:
        persist_data_dir_path: Root path used for persisted job outputs.
    """

    persist_data_dir_path: str

persist_data_dir_path instance-attribute

persist_data_dir_path: str

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsOverflowConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsOverflowConfig[IsOverflowConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsOverflowConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsOverflowConfig href "" "omnipy.shared.protocols.config.IsOverflowConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Overflow behavior for horizontally and vertically constrained output.

ATTRIBUTE	DESCRIPTION
horizontal	Horizontal overflow handling policy. TYPE: HorizontalOverflowMode.Literals
vertical	Vertical overflow handling policy. TYPE: VerticalOverflowMode.Literals

Returned by:

• Reference Code reference omnipy
  • config  data
    •  LayoutConfig  overflow
    •  TextConfig  overflow
  • shared protocols  config
    •  IsLayoutConfig  overflow
    •  IsTextConfig  overflow

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsOverflowConfig(IsConfigBase, Protocol):
    """Overflow behavior for horizontally and vertically constrained output.

    Attributes:
        horizontal: Horizontal overflow handling policy.
        vertical: Vertical overflow handling policy.
    """

    horizontal: HorizontalOverflowMode.Literals
    vertical: VerticalOverflowMode.Literals

horizontal instance-attribute

horizontal: HorizontalOverflowMode.Literals

vertical instance-attribute

vertical: VerticalOverflowMode.Literals

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsPrefectEngineConfig

Bases: IsJobRunnerConfig, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsPrefectEngineConfig[IsPrefectEngineConfig]
              omnipy.shared.protocols.config.IsJobRunnerConfig[IsJobRunnerConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsJobRunnerConfig --> omnipy.shared.protocols.config.IsPrefectEngineConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsJobRunnerConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                




              click omnipy.shared.protocols.config.IsPrefectEngineConfig href "" "omnipy.shared.protocols.config.IsPrefectEngineConfig"
              click omnipy.shared.protocols.config.IsJobRunnerConfig href "" "omnipy.shared.protocols.config.IsJobRunnerConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Runner configuration for the Prefect execution backend.

ATTRIBUTE	DESCRIPTION
use_cached_results	Whether Prefect should reuse cached task results. TYPE: bool

Returned by:

• Reference Code reference omnipy
  • components prefect engine  prefect  PrefectEngine  get_config_cls
  • config  engine  EngineConfig  prefect
  • shared protocols  config  IsEngineConfig  prefect

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsPrefectEngineConfig(IsJobRunnerConfig, Protocol):
    """Runner configuration for the Prefect execution backend.

    Attributes:
        use_cached_results: Whether Prefect should reuse cached task results.
    """

    use_cached_results: bool = False

use_cached_results class-attribute instance-attribute

use_cached_results: bool = False

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsRootLogConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsRootLogConfig[IsRootLogConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsRootLogConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsRootLogConfig href "" "omnipy.shared.protocols.config.IsRootLogConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Root logging configuration for Omnipy runtime objects.

ATTRIBUTE	DESCRIPTION
log_format_str	Format string used by root log handlers. TYPE: str
locale	Locale used for formatting and localization-sensitive output. TYPE: LocaleType
log_to_stdout	Whether logging to standard output is enabled. TYPE: bool
log_to_stderr	Whether logging to standard error is enabled. TYPE: bool
log_to_file	Whether file logging is enabled. TYPE: bool
stdout	Stream used for standard-output logging. TYPE: TextIOBase
stderr	Stream used for standard-error logging. TYPE: TextIOBase
stdout_log_min_level	Minimum level sent to standard output. TYPE: int
stderr_log_min_level	Minimum level sent to standard error. TYPE: int
file_log_min_level	Minimum level written to the log file. TYPE: int
file_log_path	Destination path for file logging. TYPE: str

Returned by:

• Reference Code reference omnipy
  • hub  runtime  RuntimeConfig  root_log
  • shared protocols hub  runtime
    •  IsRootLogObjects  config
    •  IsRuntimeConfig  root_log

Used by:

• Reference Code reference omnipy shared protocols hub  runtime  IsRootLogObjects  set_config

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsRootLogConfig(IsConfigBase, Protocol):
    """Root logging configuration for Omnipy runtime objects.

    Attributes:
        log_format_str: Format string used by root log handlers.
        locale: Locale used for formatting and localization-sensitive output.
        log_to_stdout: Whether logging to standard output is enabled.
        log_to_stderr: Whether logging to standard error is enabled.
        log_to_file: Whether file logging is enabled.
        stdout: Stream used for standard-output logging.
        stderr: Stream used for standard-error logging.
        stdout_log_min_level: Minimum level sent to standard output.
        stderr_log_min_level: Minimum level sent to standard error.
        file_log_min_level: Minimum level written to the log file.
        file_log_path: Destination path for file logging.
    """

    log_format_str: str
    locale: LocaleType
    log_to_stdout: bool
    log_to_stderr: bool
    log_to_file: bool
    stdout: TextIOBase
    stderr: TextIOBase
    stdout_log_min_level: int
    stderr_log_min_level: int
    file_log_min_level: int
    file_log_path: str

file_log_min_level instance-attribute

file_log_min_level: int

file_log_path instance-attribute

file_log_path: str

locale instance-attribute

locale: LocaleType

log_format_str instance-attribute

log_format_str: str

log_to_file instance-attribute

log_to_file: bool

log_to_stderr instance-attribute

log_to_stderr: bool

log_to_stdout instance-attribute

log_to_stdout: bool

stderr instance-attribute

stderr: TextIOBase

stderr_log_min_level instance-attribute

stderr_log_min_level: int

stdout instance-attribute

stdout: TextIOBase

stdout_log_min_level instance-attribute

stdout_log_min_level: int

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsS3OutputStorageConfig

Bases: IsOutputStorageConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsS3OutputStorageConfig[IsS3OutputStorageConfig]
              omnipy.shared.protocols.config.IsOutputStorageConfigBase[IsOutputStorageConfigBase]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsOutputStorageConfigBase --> omnipy.shared.protocols.config.IsS3OutputStorageConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsOutputStorageConfigBase
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                




              click omnipy.shared.protocols.config.IsS3OutputStorageConfig href "" "omnipy.shared.protocols.config.IsS3OutputStorageConfig"
              click omnipy.shared.protocols.config.IsOutputStorageConfigBase href "" "omnipy.shared.protocols.config.IsOutputStorageConfigBase"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

S3-compatible settings for persisted job outputs.

ATTRIBUTE	DESCRIPTION
endpoint_url	S3 API endpoint URL. TYPE: str
access_key	Access key used for authentication. TYPE: str
secret_key	Secret key used for authentication. TYPE: str
bucket_name	Bucket that stores persisted outputs. TYPE: str

Returned by:

• Reference Code reference omnipy
  • config  job  OutputStorageConfig  s3
  • shared protocols  config  IsOutputStorageConfig  s3

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsS3OutputStorageConfig(IsOutputStorageConfigBase, Protocol):
    """S3-compatible settings for persisted job outputs.

    Attributes:
        endpoint_url: S3 API endpoint URL.
        access_key: Access key used for authentication.
        secret_key: Secret key used for authentication.
        bucket_name: Bucket that stores persisted outputs.
    """

    endpoint_url: str
    access_key: str
    secret_key: str
    bucket_name: str

access_key instance-attribute

access_key: str

bucket_name instance-attribute

bucket_name: str

endpoint_url instance-attribute

endpoint_url: str

persist_data_dir_path instance-attribute

persist_data_dir_path: str

secret_key instance-attribute

secret_key: str

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsTerminalUserInterfaceConfig

Bases: IsDimsModeConfig, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsTerminalUserInterfaceConfig[IsTerminalUserInterfaceConfig]
              omnipy.shared.protocols.config.IsDimsModeConfig[IsDimsModeConfig]
              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig[IsUserInterfaceTypeConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]
              omnipy.shared.protocols.config.IsDimsModeMixin[IsDimsModeMixin]

                              omnipy.shared.protocols.config.IsDimsModeConfig --> omnipy.shared.protocols.config.IsTerminalUserInterfaceConfig
                                omnipy.shared.protocols.config.IsUserInterfaceTypeConfig --> omnipy.shared.protocols.config.IsDimsModeConfig
                                omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceTypeConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                


                omnipy.shared.protocols.config.IsDimsModeMixin --> omnipy.shared.protocols.config.IsDimsModeConfig
                



              click omnipy.shared.protocols.config.IsTerminalUserInterfaceConfig href "" "omnipy.shared.protocols.config.IsTerminalUserInterfaceConfig"
              click omnipy.shared.protocols.config.IsDimsModeConfig href "" "omnipy.shared.protocols.config.IsDimsModeConfig"
              click omnipy.shared.protocols.config.IsUserInterfaceTypeConfig href "" "omnipy.shared.protocols.config.IsUserInterfaceTypeConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
              click omnipy.shared.protocols.config.IsDimsModeMixin href "" "omnipy.shared.protocols.config.IsDimsModeMixin"
            

Terminal-specific user-interface configuration.

Returned by:

• Reference Code reference omnipy
  • config  data  UserInterfaceConfig  terminal
  • shared protocols  config  IsUserInterfaceConfig  terminal

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
set_width_and_height	Update the preferred display dimensions for this frontend.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

ATTRIBUTE	DESCRIPTION
color	TYPE: IsColorConfig
dims_mode	TYPE: DisplayDimensionsUpdateMode.Literals
height	TYPE: pyd.NonNegativeInt | None
width	TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsTerminalUserInterfaceConfig(IsDimsModeConfig, Protocol):
    """Terminal-specific user-interface configuration."""

    ...

color instance-attribute

color: IsColorConfig

dims_mode class-attribute instance-attribute

dims_mode: DisplayDimensionsUpdateMode.Literals = DisplayDimensionsUpdateMode.AUTO

height instance-attribute

height: pyd.NonNegativeInt | None

width instance-attribute

width: pyd.NonNegativeInt | None

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

set_width_and_height

set_width_and_height(width: pyd.NonNegativeInt | None, height: pyd.NonNegativeInt | None) -> None

Update the preferred display dimensions for this frontend.

PARAMETER	DESCRIPTION
width	New preferred width, or None when unknown. TYPE: pyd.NonNegativeInt | None
height	New preferred height, or None when unknown. TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """Update the preferred display dimensions for this frontend.

    Args:
        width: New preferred width, or ``None`` when unknown.
        height: New preferred height, or ``None`` when unknown.
    """

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsTextConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsTextConfig[IsTextConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsTextConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsTextConfig href "" "omnipy.shared.protocols.config.IsTextConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Text-formatting settings used by Omnipy renderers.

ATTRIBUTE	DESCRIPTION
overflow	Overflow behavior for text output. TYPE: IsOverflowConfig
tab_size	Number of spaces represented by a tab. TYPE: pyd.NonNegativeInt
indent_tab_size	Tab width used when indenting structured output. TYPE: pyd.NonNegativeInt
pretty_printer	Pretty-printing backend to use. TYPE: PrettyPrinterLib.Literals
proportional_freedom	Tuning value for proportional line breaking. TYPE: pyd.NonNegativeFloat
debug_mode	Whether extra rendering diagnostics should be shown. TYPE: bool

Returned by:

• Reference Code reference omnipy
  • config  data  UserInterfaceConfig  text
  • shared protocols
    •  config  IsUserInterfaceConfig  text
    •  data  IsReactiveObjects  text_config

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsTextConfig(IsConfigBase, Protocol):
    """Text-formatting settings used by Omnipy renderers.

    Attributes:
        overflow: Overflow behavior for text output.
        tab_size: Number of spaces represented by a tab.
        indent_tab_size: Tab width used when indenting structured output.
        pretty_printer: Pretty-printing backend to use.
        proportional_freedom: Tuning value for proportional line breaking.
        debug_mode: Whether extra rendering diagnostics should be shown.
    """

    overflow: IsOverflowConfig
    tab_size: pyd.NonNegativeInt
    indent_tab_size: pyd.NonNegativeInt
    pretty_printer: PrettyPrinterLib.Literals
    proportional_freedom: pyd.NonNegativeFloat
    debug_mode: bool

debug_mode instance-attribute

debug_mode: bool

indent_tab_size instance-attribute

indent_tab_size: pyd.NonNegativeInt

overflow instance-attribute

overflow: IsOverflowConfig

pretty_printer instance-attribute

pretty_printer: PrettyPrinterLib.Literals

proportional_freedom instance-attribute

proportional_freedom: pyd.NonNegativeFloat

tab_size instance-attribute

tab_size: pyd.NonNegativeInt

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsUserInterfaceConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsUserInterfaceConfig[IsUserInterfaceConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsUserInterfaceConfig href "" "omnipy.shared.protocols.config.IsUserInterfaceConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Top-level bundle of frontend-specific UI configuration sections.

ATTRIBUTE	DESCRIPTION
detected_type	Frontend type currently in use. TYPE: SpecifiedUserInterfaceType.Literals
terminal	Terminal-specific UI settings. TYPE: IsTerminalUserInterfaceConfig
jupyter	Jupyter-specific UI settings. TYPE: IsJupyterUserInterfaceConfig
browser	Browser-specific UI settings. TYPE: IsBrowserUserInterfaceConfig
text	Shared text-rendering settings. TYPE: IsTextConfig
layout	Shared layout-rendering settings. TYPE: IsLayoutConfig
cache_dir_path	Directory used for UI-related cache files. TYPE: str

Returned by:

• Reference Code reference omnipy
  • config  data  DataConfig  ui
  • shared protocols  config  IsDataConfig  ui

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
get_ui_type_config	Return the config section matching a concrete frontend type.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsUserInterfaceConfig(IsConfigBase, Protocol):
    """Top-level bundle of frontend-specific UI configuration sections.

    Attributes:
        detected_type: Frontend type currently in use.
        terminal: Terminal-specific UI settings.
        jupyter: Jupyter-specific UI settings.
        browser: Browser-specific UI settings.
        text: Shared text-rendering settings.
        layout: Shared layout-rendering settings.
        cache_dir_path: Directory used for UI-related cache files.
    """

    detected_type: SpecifiedUserInterfaceType.Literals
    terminal: IsTerminalUserInterfaceConfig
    jupyter: IsJupyterUserInterfaceConfig
    browser: IsBrowserUserInterfaceConfig
    text: IsTextConfig
    layout: IsLayoutConfig
    cache_dir_path: str

    def get_ui_type_config(
        self,
        ui_type: SpecifiedUserInterfaceType.Literals,
    ) -> IsUserInterfaceTypeConfig:
        """Return the config section matching a concrete frontend type.

        Args:
            ui_type: Frontend type whose config section should be returned.

        Returns:
            IsUserInterfaceTypeConfig: Config section for the requested frontend.
        """
        ...

browser instance-attribute

browser: IsBrowserUserInterfaceConfig

cache_dir_path instance-attribute

cache_dir_path: str

detected_type instance-attribute

detected_type: SpecifiedUserInterfaceType.Literals

jupyter instance-attribute

jupyter: IsJupyterUserInterfaceConfig

layout instance-attribute

layout: IsLayoutConfig

terminal instance-attribute

terminal: IsTerminalUserInterfaceConfig

text instance-attribute

text: IsTextConfig

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

get_ui_type_config

get_ui_type_config(ui_type: SpecifiedUserInterfaceType.Literals) -> IsUserInterfaceTypeConfig

Return the config section matching a concrete frontend type.

PARAMETER	DESCRIPTION
ui_type	Frontend type whose config section should be returned. TYPE: SpecifiedUserInterfaceType.Literals

RETURNS	DESCRIPTION
IsUserInterfaceTypeConfig	Config section for the requested frontend. TYPE: IsUserInterfaceTypeConfig

Source code in src/omnipy/shared/protocols/config.py

def get_ui_type_config(
    self,
    ui_type: SpecifiedUserInterfaceType.Literals,
) -> IsUserInterfaceTypeConfig:
    """Return the config section matching a concrete frontend type.

    Args:
        ui_type: Frontend type whose config section should be returned.

    Returns:
        IsUserInterfaceTypeConfig: Config section for the requested frontend.
    """
    ...

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...

IsUserInterfaceTypeConfig

Bases: IsConfigBase, Protocol

              flowchart BT
              omnipy.shared.protocols.config.IsUserInterfaceTypeConfig[IsUserInterfaceTypeConfig]
              omnipy.shared.protocols.config.IsConfigBase[IsConfigBase]
              omnipy.shared.protocols.util.IsDataPublisher[IsDataPublisher]

                              omnipy.shared.protocols.config.IsConfigBase --> omnipy.shared.protocols.config.IsUserInterfaceTypeConfig
                                omnipy.shared.protocols.util.IsDataPublisher --> omnipy.shared.protocols.config.IsConfigBase
                



              click omnipy.shared.protocols.config.IsUserInterfaceTypeConfig href "" "omnipy.shared.protocols.config.IsUserInterfaceTypeConfig"
              click omnipy.shared.protocols.config.IsConfigBase href "" "omnipy.shared.protocols.config.IsConfigBase"
              click omnipy.shared.protocols.util.IsDataPublisher href "" "omnipy.shared.protocols.util.IsDataPublisher"
            

Base configuration shared by concrete user-interface frontends.

ATTRIBUTE	DESCRIPTION
width	Preferred render width in characters or pixels, if known. TYPE: pyd.NonNegativeInt | None
height	Preferred render height in characters or pixels, if known. TYPE: pyd.NonNegativeInt | None
color	Color configuration for this frontend. TYPE: IsColorConfig

Returned by:

• Reference Code reference omnipy
  • config  data  UserInterfaceConfig  get_ui_type_config
  • shared protocols  config  IsUserInterfaceConfig  get_ui_type_config

Subclassed by:

• Reference Code reference omnipy shared protocols  config
  •  IsDimsModeConfig
  •  IsHtmlUserInterfaceConfig

METHOD	DESCRIPTION
as_model
deepcopy	Return a deep-copied publisher instance.
default_repr_to_terminal_str	Render the config for a terminal-style user interface.
set_width_and_height	Update the preferred display dimensions for this frontend.
subscribe	Subscribe to general publisher updates.
subscribe_attr	Subscribe to updates for one named attribute.
unsubscribe_all	Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/config.py

@runtime_checkable
class IsUserInterfaceTypeConfig(IsConfigBase, Protocol):
    """Base configuration shared by concrete user-interface frontends.

    Attributes:
        width: Preferred render width in characters or pixels, if known.
        height: Preferred render height in characters or pixels, if known.
        color: Color configuration for this frontend.
    """

    width: pyd.NonNegativeInt | None
    height: pyd.NonNegativeInt | None
    color: IsColorConfig

    def set_width_and_height(
        self,
        width: pyd.NonNegativeInt | None,
        height: pyd.NonNegativeInt | None,
    ) -> None:
        """Update the preferred display dimensions for this frontend.

        Args:
            width: New preferred width, or ``None`` when unknown.
            height: New preferred height, or ``None`` when unknown.
        """

color instance-attribute

color: IsColorConfig

height instance-attribute

height: pyd.NonNegativeInt | None

width instance-attribute

width: pyd.NonNegativeInt | None

as_model

as_model() -> IsModel[Any]

Source code in src/omnipy/shared/protocols/config.py

def as_model(self) -> 'IsModel[Any]':
    ...

deepcopy

deepcopy() -> Self

Return a deep-copied publisher instance.

RETURNS	DESCRIPTION
Self	Deep copy of the current publisher object. TYPE: Self

Source code in src/omnipy/shared/protocols/util.py

def deepcopy(self) -> Self:
    """Return a deep-copied publisher instance.

    Returns:
        Self: Deep copy of the current publisher object.
    """
    ...

default_repr_to_terminal_str

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str

Render the config for a terminal-style user interface.

PARAMETER	DESCRIPTION
ui_type	Terminal frontend variant requesting the representation. TYPE: TerminalOutputUserInterfaceType.Literals

RETURNS	DESCRIPTION
str	Terminal-friendly string representation of the config. TYPE: str

Source code in src/omnipy/shared/protocols/config.py

def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    """Render the config for a terminal-style user interface.

    Args:
        ui_type: Terminal frontend variant requesting the representation.

    Returns:
        str: Terminal-friendly string representation of the config.
    """
    ...

set_width_and_height

set_width_and_height(width: pyd.NonNegativeInt | None, height: pyd.NonNegativeInt | None) -> None

Update the preferred display dimensions for this frontend.

PARAMETER	DESCRIPTION
width	New preferred width, or None when unknown. TYPE: pyd.NonNegativeInt | None
height	New preferred height, or None when unknown. TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py

def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """Update the preferred display dimensions for this frontend.

    Args:
        width: New preferred width, or ``None`` when unknown.
        height: New preferred height, or ``None`` when unknown.
    """

subscribe

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None

Subscribe to general publisher updates.

PARAMETER	DESCRIPTION
callback_fun	Callback invoked when the publisher changes. TYPE: Callable[..., None]
do_callback	Whether to invoke the callback immediately after subscribing. TYPE: bool DEFAULT: True

Source code in src/omnipy/shared/protocols/util.py

def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    """Subscribe to general publisher updates.

    Args:
        callback_fun: Callback invoked when the publisher changes.
        do_callback: Whether to invoke the callback immediately after subscribing.
    """
    ...

subscribe_attr

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])

Subscribe to updates for one named attribute.

PARAMETER	DESCRIPTION
attr_name	Name of the published attribute to observe. TYPE: str
callback_fun	Callback invoked when that attribute changes. TYPE: Callable[..., None]

Source code in src/omnipy/shared/protocols/util.py

def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    """Subscribe to updates for one named attribute.

    Args:
        attr_name: Name of the published attribute to observe.
        callback_fun: Callback invoked when that attribute changes.
    """
    ...

unsubscribe_all

unsubscribe_all() -> None

Remove every registered subscriber.

Source code in src/omnipy/shared/protocols/util.py

def unsubscribe_all(self) -> None:
    """Remove every registered subscriber."""
    ...