Skip to content

omnipy.shared.protocols.config

CLASS DESCRIPTION
IsBrowserUserInterfaceConfig
IsColorConfig
IsConfigBase
IsDataConfig
IsDimsModeConfig
IsDimsModeMixin
IsEngineConfig
IsFontConfig
IsHtmlUserInterfaceConfig
IsHttpConfig
IsHttpRequestsConfig
IsJobConfig
IsJobRunnerConfig
IsJupyterUserInterfaceConfig
IsLayoutConfig
IsLocalOutputStorageConfig
IsLocalRunnerConfig
IsModelConfig
IsOutputStorageConfig
IsOutputStorageConfigBase
IsOverflowConfig
IsPrefectEngineConfig
IsRootLogConfig
IsS3OutputStorageConfig
IsTerminalUserInterfaceConfig
IsTextConfig
IsUserInterfaceConfig
IsUserInterfaceTypeConfig

IsBrowserUserInterfaceConfig

Bases: IsHtmlUserInterfaceConfig, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
set_width_and_height

Sets width and height, and notifies subscribers of the change. Only
subscribe
subscribe_attr
unsubscribe_all
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 
115
116
117
118
@runtime_checkable
class IsBrowserUserInterfaceConfig(IsHtmlUserInterfaceConfig, Protocol):
    """"""
    ...

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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

set_width_and_height 

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

Sets width and height, and notifies subscribers of the change. Only notifies self-subscribers once after both attributes have been updated.

Source code in src/omnipy/shared/protocols/config.py 
64
65
66
67
68
69
70
71
72
73
def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """
    Sets width and height, and notifies subscribers of the change. Only
    notifies self-subscribers once after both attributes have been
    updated.
    """

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsColorConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
dark_background

TYPE: bool

solid_background

TYPE: bool

style

TYPE: AllColorStyles.Literals | str

system

TYPE: DisplayColorSystem.Literals

Source code in src/omnipy/shared/protocols/config.py 
48
49
50
51
52
53
54
@runtime_checkable
class IsColorConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsConfigBase

Bases: IsDataPublisher, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
Source code in src/omnipy/shared/protocols/config.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@runtime_checkable
class IsConfigBase(IsDataPublisher, Protocol):
    """"""
    def as_model(self) -> 'IsModel[dict[str, object]]':
        ...

    def default_repr_to_terminal_str(
        self,
        ui_type: TerminalOutputUserInterfaceType.Literals,
    ) -> str:
        ...

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

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsDataConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
http

TYPE: IsHttpConfig

model

TYPE: IsModelConfig

ui

TYPE: IsUserInterfaceConfig

Source code in src/omnipy/shared/protocols/config.py 
195
196
197
198
199
200
@runtime_checkable
class IsDataConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsDimsModeConfig

Bases: IsUserInterfaceTypeConfig, IsDimsModeMixin, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
set_width_and_height

Sets width and height, and notifies subscribers of the change. Only
subscribe
subscribe_attr
unsubscribe_all
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 
82
83
84
85
@runtime_checkable
class IsDimsModeConfig(IsUserInterfaceTypeConfig, IsDimsModeMixin, Protocol):
    """"""
    ...

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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

set_width_and_height 

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

Sets width and height, and notifies subscribers of the change. Only notifies self-subscribers once after both attributes have been updated.

Source code in src/omnipy/shared/protocols/config.py 
64
65
66
67
68
69
70
71
72
73
def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """
    Sets width and height, and notifies subscribers of the change. Only
    notifies self-subscribers once after both attributes have been
    updated.
    """

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsDimsModeMixin

Bases: Protocol

ATTRIBUTE DESCRIPTION
dims_mode

TYPE: DisplayDimensionsUpdateMode.Literals

Source code in src/omnipy/shared/protocols/config.py 
76
77
78
79
@runtime_checkable
class IsDimsModeMixin(Protocol):
    """"""
    dims_mode: DisplayDimensionsUpdateMode.Literals = DisplayDimensionsUpdateMode.AUTO

dims_mode class-attribute instance-attribute 

dims_mode: DisplayDimensionsUpdateMode.Literals = DisplayDimensionsUpdateMode.AUTO

IsEngineConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
choice

TYPE: EngineChoice.Literals

local

TYPE: IsLocalRunnerConfig

prefect

TYPE: IsPrefectEngineConfig

Source code in src/omnipy/shared/protocols/config.py 
224
225
226
227
228
229
230
@runtime_checkable
class IsEngineConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsFontConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
families

TYPE: tuple[str, ...]

line_height

TYPE: pyd.NonNegativeFloat

size

TYPE: pyd.NonNegativeInt

weight

TYPE: pyd.NonNegativeInt

Source code in src/omnipy/shared/protocols/config.py 
 94
 95
 96
 97
 98
 99
100
@runtime_checkable
class IsFontConfig(IsConfigBase, Protocol):
    """"""
    families: tuple[str, ...]
    size: pyd.NonNegativeInt
    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.NonNegativeInt

weight instance-attribute 

weight: pyd.NonNegativeInt

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsHtmlUserInterfaceConfig

Bases: IsUserInterfaceTypeConfig, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
set_width_and_height

Sets width and height, and notifies subscribers of the change. Only
subscribe
subscribe_attr
unsubscribe_all
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 
103
104
105
106
@runtime_checkable
class IsHtmlUserInterfaceConfig(IsUserInterfaceTypeConfig, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

set_width_and_height 

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

Sets width and height, and notifies subscribers of the change. Only notifies self-subscribers once after both attributes have been updated.

Source code in src/omnipy/shared/protocols/config.py 
64
65
66
67
68
69
70
71
72
73
def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """
    Sets width and height, and notifies subscribers of the change. Only
    notifies self-subscribers once after both attributes have been
    updated.
    """

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsHttpConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
defaults

TYPE: IsHttpRequestsConfig

for_host

TYPE: defaultdict[str, IsHttpRequestsConfig]

Source code in src/omnipy/shared/protocols/config.py 
188
189
190
191
192
@runtime_checkable
class IsHttpConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsHttpRequestsConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
requests_per_time_period

TYPE: float

retry_attempts

TYPE: int

retry_backoff_strategy

TYPE: BackoffStrategy.Literals

retry_http_statuses

TYPE: tuple[int, ...]

time_period_in_secs

TYPE: float

Source code in src/omnipy/shared/protocols/config.py 
178
179
180
181
182
183
184
185
@runtime_checkable
class IsHttpRequestsConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsJobConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
output_storage

TYPE: IsOutputStorageConfig

Source code in src/omnipy/shared/protocols/config.py 
266
267
268
269
@runtime_checkable
class IsJobConfig(IsConfigBase, Protocol):
    """"""
    output_storage: IsOutputStorageConfig

output_storage instance-attribute 

output_storage: IsOutputStorageConfig

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsJobRunnerConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
Source code in src/omnipy/shared/protocols/config.py 
206
207
208
209
@runtime_checkable
class IsJobRunnerConfig(IsConfigBase, Protocol):
    """"""
    ...

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsJupyterUserInterfaceConfig

Bases: IsHtmlUserInterfaceConfig, IsDimsModeConfig, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
set_width_and_height

Sets width and height, and notifies subscribers of the change. Only
subscribe
subscribe_attr
unsubscribe_all
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 
109
110
111
112
@runtime_checkable
class IsJupyterUserInterfaceConfig(IsHtmlUserInterfaceConfig, IsDimsModeConfig, Protocol):
    """"""
    ...

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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

set_width_and_height 

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

Sets width and height, and notifies subscribers of the change. Only notifies self-subscribers once after both attributes have been updated.

Source code in src/omnipy/shared/protocols/config.py 
64
65
66
67
68
69
70
71
72
73
def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """
    Sets width and height, and notifies subscribers of the change. Only
    notifies self-subscribers once after both attributes have been
    updated.
    """

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsLayoutConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
justify

TYPE: Justify.Literals

max_nesting_depth

TYPE: pyd.NonNegativeInt | None

max_panels_hor

TYPE: pyd.NonNegativeInt | None

max_title_height

TYPE: MaxTitleHeight.Literals

min_crop_width

TYPE: pyd.NonNegativeInt

min_panel_width

TYPE: pyd.NonNegativeInt

overflow

TYPE: IsOverflowConfig

panel_design

TYPE: PanelDesign.Literals

panel_title_at_top

TYPE: bool

Source code in src/omnipy/shared/protocols/config.py 
139
140
141
142
143
144
145
146
147
148
149
150
@runtime_checkable
class IsLayoutConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsLocalOutputStorageConfig

Bases: IsOutputStorageConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
persist_data_dir_path

TYPE: str

Source code in src/omnipy/shared/protocols/config.py 
242
243
244
@runtime_checkable
class IsLocalOutputStorageConfig(IsOutputStorageConfigBase, Protocol):
    """"""

persist_data_dir_path instance-attribute 

persist_data_dir_path: str

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsLocalRunnerConfig

Bases: IsJobRunnerConfig, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
Source code in src/omnipy/shared/protocols/config.py 
212
213
214
215
@runtime_checkable
class IsLocalRunnerConfig(IsJobRunnerConfig, Protocol):
    """"""
    ...

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsModelConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
dynamically_convert_elements_to_models

TYPE: bool

interactive

TYPE: bool

Source code in src/omnipy/shared/protocols/config.py 
171
172
173
174
175
@runtime_checkable
class IsModelConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsOutputStorageConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
local

TYPE: IsLocalOutputStorageConfig

persist_outputs

TYPE: ConfigPersistOutputsOptions.Literals

protocol

TYPE: ConfigOutputStorageProtocolOptions.Literals

restore_outputs

TYPE: ConfigRestoreOutputsOptions.Literals

s3

TYPE: IsS3OutputStorageConfig

Source code in src/omnipy/shared/protocols/config.py 
256
257
258
259
260
261
262
263
@runtime_checkable
class IsOutputStorageConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsOutputStorageConfigBase

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
persist_data_dir_path

TYPE: str

Source code in src/omnipy/shared/protocols/config.py 
236
237
238
239
@runtime_checkable
class IsOutputStorageConfigBase(IsConfigBase, Protocol):
    """"""
    persist_data_dir_path: str

persist_data_dir_path instance-attribute 

persist_data_dir_path: str

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsOverflowConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
horizontal

TYPE: HorizontalOverflowMode.Literals

vertical

TYPE: VerticalOverflowMode.Literals

Source code in src/omnipy/shared/protocols/config.py 
121
122
123
124
125
@runtime_checkable
class IsOverflowConfig(IsConfigBase, Protocol):
    """"""
    horizontal: HorizontalOverflowMode.Literals
    vertical: VerticalOverflowMode.Literals

horizontal instance-attribute 

horizontal: HorizontalOverflowMode.Literals

vertical instance-attribute 

vertical: VerticalOverflowMode.Literals

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsPrefectEngineConfig

Bases: IsJobRunnerConfig, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
use_cached_results

TYPE: bool

Source code in src/omnipy/shared/protocols/config.py 
218
219
220
221
@runtime_checkable
class IsPrefectEngineConfig(IsJobRunnerConfig, Protocol):
    """"""
    use_cached_results: bool = False

use_cached_results class-attribute instance-attribute 

use_cached_results: bool = False

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsRootLogConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
file_log_min_level

TYPE: int

file_log_path

TYPE: str

locale

TYPE: LocaleType

log_format_str

TYPE: str

log_to_file

TYPE: bool

log_to_stderr

TYPE: bool

log_to_stdout

TYPE: bool

stderr

TYPE: TextIOBase

stderr_log_min_level

TYPE: int

stdout

TYPE: TextIOBase

stdout_log_min_level

TYPE: int

Source code in src/omnipy/shared/protocols/config.py 
275
276
277
278
279
280
281
282
283
284
285
286
287
288
@runtime_checkable
class IsRootLogConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsS3OutputStorageConfig

Bases: IsOutputStorageConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
access_key

TYPE: str

bucket_name

TYPE: str

endpoint_url

TYPE: str

persist_data_dir_path

TYPE: str

secret_key

TYPE: str

Source code in src/omnipy/shared/protocols/config.py 
247
248
249
250
251
252
253
@runtime_checkable
class IsS3OutputStorageConfig(IsOutputStorageConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsTerminalUserInterfaceConfig

Bases: IsDimsModeConfig, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
set_width_and_height

Sets width and height, and notifies subscribers of the change. Only
subscribe
subscribe_attr
unsubscribe_all
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 
88
89
90
91
@runtime_checkable
class IsTerminalUserInterfaceConfig(IsDimsModeConfig, Protocol):
    """"""
    ...

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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

set_width_and_height 

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

Sets width and height, and notifies subscribers of the change. Only notifies self-subscribers once after both attributes have been updated.

Source code in src/omnipy/shared/protocols/config.py 
64
65
66
67
68
69
70
71
72
73
def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """
    Sets width and height, and notifies subscribers of the change. Only
    notifies self-subscribers once after both attributes have been
    updated.
    """

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsTextConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
debug_mode

TYPE: bool

indent_tab_size

TYPE: pyd.NonNegativeInt

overflow

TYPE: IsOverflowConfig

pretty_printer

TYPE: PrettyPrinterLib.Literals

proportional_freedom

TYPE: pyd.NonNegativeFloat

tab_size

TYPE: pyd.NonNegativeInt

Source code in src/omnipy/shared/protocols/config.py 
128
129
130
131
132
133
134
135
136
@runtime_checkable
class IsTextConfig(IsConfigBase, Protocol):
    """"""
    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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsUserInterfaceConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
get_ui_type_config
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
browser

TYPE: IsBrowserUserInterfaceConfig

cache_dir_path

TYPE: str

detected_type

TYPE: SpecifiedUserInterfaceType.Literals

jupyter

TYPE: IsJupyterUserInterfaceConfig

layout

TYPE: IsLayoutConfig

terminal

TYPE: IsTerminalUserInterfaceConfig

text

TYPE: IsTextConfig

Source code in src/omnipy/shared/protocols/config.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
@runtime_checkable
class IsUserInterfaceConfig(IsConfigBase, Protocol):
    """"""
    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:
        ...

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[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

get_ui_type_config 

get_ui_type_config(ui_type: SpecifiedUserInterfaceType.Literals) -> IsUserInterfaceTypeConfig
Source code in src/omnipy/shared/protocols/config.py 
164
165
166
167
168
def get_ui_type_config(
    self,
    ui_type: SpecifiedUserInterfaceType.Literals,
) -> IsUserInterfaceTypeConfig:
    ...

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...

IsUserInterfaceTypeConfig

Bases: IsConfigBase, Protocol

METHOD DESCRIPTION
as_model
deepcopy
default_repr_to_terminal_str
set_width_and_height

Sets width and height, and notifies subscribers of the change. Only
subscribe
subscribe_attr
unsubscribe_all
ATTRIBUTE DESCRIPTION
color

TYPE: IsColorConfig

height

TYPE: pyd.NonNegativeInt | None

width

TYPE: pyd.NonNegativeInt | None

Source code in src/omnipy/shared/protocols/config.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
@runtime_checkable
class IsUserInterfaceTypeConfig(IsConfigBase, Protocol):
    """"""
    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:
        """
        Sets width and height, and notifies subscribers of the change. Only
        notifies self-subscribers once after both attributes have been
        updated.
        """

color instance-attribute 

color: IsColorConfig

height instance-attribute 

height: pyd.NonNegativeInt | None

width instance-attribute 

width: pyd.NonNegativeInt | None

as_model 

as_model() -> IsModel[dict[str, object]]
Source code in src/omnipy/shared/protocols/config.py 
32
33
def as_model(self) -> 'IsModel[dict[str, object]]':
    ...

deepcopy 

deepcopy() -> Self
Source code in src/omnipy/shared/protocols/util.py 
16
17
def deepcopy(self) -> Self:
    ...

default_repr_to_terminal_str 

default_repr_to_terminal_str(ui_type: TerminalOutputUserInterfaceType.Literals) -> str
Source code in src/omnipy/shared/protocols/config.py 
35
36
37
38
39
def default_repr_to_terminal_str(
    self,
    ui_type: TerminalOutputUserInterfaceType.Literals,
) -> str:
    ...

set_width_and_height 

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

Sets width and height, and notifies subscribers of the change. Only notifies self-subscribers once after both attributes have been updated.

Source code in src/omnipy/shared/protocols/config.py 
64
65
66
67
68
69
70
71
72
73
def set_width_and_height(
    self,
    width: pyd.NonNegativeInt | None,
    height: pyd.NonNegativeInt | None,
) -> None:
    """
    Sets width and height, and notifies subscribers of the change. Only
    notifies self-subscribers once after both attributes have been
    updated.
    """

subscribe 

subscribe(callback_fun: Callable[..., None], do_callback: bool = True) -> None
Source code in src/omnipy/shared/protocols/util.py 
10
11
def subscribe(self, callback_fun: Callable[..., None], do_callback: bool = True) -> None:
    ...

subscribe_attr 

subscribe_attr(attr_name: str, callback_fun: Callable[..., None])
Source code in src/omnipy/shared/protocols/util.py 
7
8
def subscribe_attr(self, attr_name: str, callback_fun: Callable[..., None]):
    ...

unsubscribe_all 

unsubscribe_all() -> None
Source code in src/omnipy/shared/protocols/util.py 
13
14
def unsubscribe_all(self) -> None:
    ...