omnipy.shared.protocols.compute.job

CLASS	DESCRIPTION
IsDagFlow
IsDagFlowTemplate
IsFlow
IsFlowTemplate
IsFuncFlow
IsFuncFlowTemplate
IsLinearFlow
IsLinearFlowTemplate
IsTask
IsTaskTemplate	Loosely coupled type replacement for the :py:class:~omnipy.compute.task.TaskTemplate class

IsDagFlow

Bases: IsTaskTemplateArgsJob[IsTaskTemplate, 'IsDagFlowTemplate[_CallP, _RetCovT]', 'IsDagFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlow, Protocol[_CallP, _RetCovT]

METHOD	DESCRIPTION
__init__
create_job
get_bound_args
has_coroutine_func
log
regenerate_unique_name
revise

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
flow_context	TYPE: IsNestedContext
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
task_templates	TYPE: tuple[_TaskTemplateCovT, ...]
time_of_cur_toplevel_flow_run	TYPE: datetime | None
time_of_last_run	TYPE: datetime | None
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsDagFlow(IsTaskTemplateArgsJob[IsTaskTemplate,
                                      'IsDagFlowTemplate[_CallP, _RetCovT]',
                                      'IsDagFlow[_CallP, _RetCovT]',
                                      _CallP,
                                      _RetCovT],
                IsFlow,
                Protocol[_CallP, _RetCovT]):
    """"""
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

flow_context property

flow_context: IsNestedContext

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

task_templates property

task_templates: tuple[_TaskTemplateCovT, ...]

time_of_cur_toplevel_flow_run property

time_of_cur_toplevel_flow_run: datetime | None

time_of_last_run property

time_of_last_run: datetime | None

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

create_job classmethod

create_job(*args: object, **kwargs: object) -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

revise

revise() -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def revise(self) -> _JobTemplateT:
    ...

IsDagFlowTemplate

Bases: IsTaskTemplateArgsJobTemplate[IsTaskTemplate, 'IsDagFlowTemplate[_CallP, _RetCovT]', 'IsDagFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlowTemplate, Protocol[_CallP, _RetCovT]

METHOD	DESCRIPTION
__init__
apply
create_job_template
get_bound_args
has_coroutine_func
log
refine
regenerate_unique_name
run

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
task_templates	TYPE: tuple[_TaskTemplateCovT, ...]
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsDagFlowTemplate(IsTaskTemplateArgsJobTemplate[IsTaskTemplate,
                                                      'IsDagFlowTemplate[_CallP, _RetCovT]',
                                                      'IsDagFlow[_CallP, _RetCovT]',
                                                      _CallP,
                                                      _RetCovT],
                        IsFlowTemplate,
                        Protocol[_CallP, _RetCovT]):
    """"""
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

task_templates property

task_templates: tuple[_TaskTemplateCovT, ...]

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

apply

apply() -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

def apply(self) -> _JobT:
    ...

create_job_template classmethod

create_job_template(*args: object, **kwargs: object) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

refine

refine(
    *task_templates: _TaskTemplateT,
    update: bool = True,
    name: str | None = None,
    iterate_over_data_files: bool = False,
    output_dataset_param: str | None = None,
    output_dataset_cls: type[IsDataset] | None = None,
    auto_async: bool = True,
    result_key: str | None = None,
    fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
    param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
    persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
    restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
    **kwargs: object,
) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def refine(
        self,
        *task_templates: _TaskTemplateT,
        update: bool = True,
        name: str | None = None,
        iterate_over_data_files: bool = False,
        output_dataset_param: str | None = None,
        output_dataset_cls: type[IsDataset] | None = None,
        auto_async: bool = True,
        result_key: str | None = None,
        fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
        param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
        persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
        restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
        **kwargs: object) -> _JobTemplateT:
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

run

run(*args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT

Source code in src/omnipy/shared/protocols/compute/_job.py

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    ...

IsFlow

Bases: Protocol

ATTRIBUTE	DESCRIPTION
flow_context	TYPE: IsNestedContext
time_of_last_run	TYPE: datetime | None

Source code in src/omnipy/shared/protocols/compute/job.py

class IsFlow(Protocol):
    """"""
    @property
    def flow_context(self) -> IsNestedContext:
        ...

    @property
    def time_of_last_run(self) -> datetime | None:
        ...

flow_context property

flow_context: IsNestedContext

time_of_last_run property

time_of_last_run: datetime | None

IsFlowTemplate

Bases: Protocol

Source code in src/omnipy/shared/protocols/compute/job.py

class IsFlowTemplate(Protocol):
    """"""
    ...

IsFuncFlow

Bases: IsFuncArgJob['IsFuncFlowTemplate[_CallP, _RetCovT]', 'IsFuncFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlow, Protocol[_CallP, _RetCovT]

METHOD	DESCRIPTION
__init__
create_job
get_bound_args
has_coroutine_func
log
regenerate_unique_name
revise

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
flow_context	TYPE: IsNestedContext
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
time_of_cur_toplevel_flow_run	TYPE: datetime | None
time_of_last_run	TYPE: datetime | None
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsFuncFlow(IsFuncArgJob['IsFuncFlowTemplate[_CallP, _RetCovT]',
                              'IsFuncFlow[_CallP, _RetCovT]',
                              _CallP,
                              _RetCovT],
                 IsFlow,
                 Protocol[_CallP, _RetCovT]):
    """"""
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

flow_context property

flow_context: IsNestedContext

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

time_of_cur_toplevel_flow_run property

time_of_cur_toplevel_flow_run: datetime | None

time_of_last_run property

time_of_last_run: datetime | None

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

create_job classmethod

create_job(*args: object, **kwargs: object) -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

revise

revise() -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def revise(self) -> _JobTemplateT:
    ...

IsFuncFlowTemplate

Bases: IsFuncArgJobTemplate['IsFuncFlowTemplate[_CallP, _RetCovT]', 'IsFuncFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlowTemplate, Protocol[_CallP, _RetCovT]

METHOD	DESCRIPTION
__init__
apply
create_job_template
get_bound_args
has_coroutine_func
log
refine
regenerate_unique_name
run

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsFuncFlowTemplate(IsFuncArgJobTemplate['IsFuncFlowTemplate[_CallP, _RetCovT]',
                                              'IsFuncFlow[_CallP, _RetCovT]',
                                              _CallP,
                                              _RetCovT],
                         IsFlowTemplate,
                         Protocol[_CallP, _RetCovT]):
    """"""
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

apply

apply() -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

def apply(self) -> _JobT:
    ...

create_job_template classmethod

create_job_template(*args: object, **kwargs: object) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

refine

refine(
    *args: Any,
    update: bool = True,
    name: str | None = None,
    iterate_over_data_files: bool = False,
    output_dataset_param: str | None = None,
    output_dataset_cls: type[IsDataset] | None = None,
    auto_async: bool = True,
    result_key: str | None = None,
    fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
    param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
    persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
    restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
    **kwargs: object,
) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def refine(
        self,
        *args: Any,
        update: bool = True,
        name: str | None = None,
        iterate_over_data_files: bool = False,
        output_dataset_param: str | None = None,
        output_dataset_cls: type[IsDataset] | None = None,
        auto_async: bool = True,
        result_key: str | None = None,
        fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
        param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
        persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
        restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
        **kwargs: object) -> _JobTemplateT:
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

run

run(*args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT

Source code in src/omnipy/shared/protocols/compute/_job.py

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    ...

IsLinearFlow

Bases: IsTaskTemplateArgsJob[IsTaskTemplate, 'IsLinearFlowTemplate[_CallP, _RetCovT]', 'IsLinearFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlow, Protocol[_CallP, _RetCovT]

METHOD	DESCRIPTION
__init__
create_job
get_bound_args
has_coroutine_func
log
regenerate_unique_name
revise

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
flow_context	TYPE: IsNestedContext
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
task_templates	TYPE: tuple[_TaskTemplateCovT, ...]
time_of_cur_toplevel_flow_run	TYPE: datetime | None
time_of_last_run	TYPE: datetime | None
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsLinearFlow(IsTaskTemplateArgsJob[IsTaskTemplate,
                                         'IsLinearFlowTemplate[_CallP, _RetCovT]',
                                         'IsLinearFlow[_CallP, _RetCovT]',
                                         _CallP,
                                         _RetCovT],
                   IsFlow,
                   Protocol[_CallP, _RetCovT]):
    """"""
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

flow_context property

flow_context: IsNestedContext

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

task_templates property

task_templates: tuple[_TaskTemplateCovT, ...]

time_of_cur_toplevel_flow_run property

time_of_cur_toplevel_flow_run: datetime | None

time_of_last_run property

time_of_last_run: datetime | None

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

create_job classmethod

create_job(*args: object, **kwargs: object) -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

revise

revise() -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def revise(self) -> _JobTemplateT:
    ...

IsLinearFlowTemplate

Bases: IsTaskTemplateArgsJobTemplate[IsTaskTemplate, 'IsLinearFlowTemplate[_CallP, _RetCovT]', 'IsLinearFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlowTemplate, Protocol[_CallP, _RetCovT]

METHOD	DESCRIPTION
__init__
apply
create_job_template
get_bound_args
has_coroutine_func
log
refine
regenerate_unique_name
run

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
task_templates	TYPE: tuple[_TaskTemplateCovT, ...]
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsLinearFlowTemplate(IsTaskTemplateArgsJobTemplate[IsTaskTemplate,
                                                         'IsLinearFlowTemplate[_CallP, _RetCovT]',
                                                         'IsLinearFlow[_CallP, _RetCovT]',
                                                         _CallP,
                                                         _RetCovT],
                           IsFlowTemplate,
                           Protocol[_CallP, _RetCovT]):
    """"""
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

task_templates property

task_templates: tuple[_TaskTemplateCovT, ...]

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

apply

apply() -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

def apply(self) -> _JobT:
    ...

create_job_template classmethod

create_job_template(*args: object, **kwargs: object) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

refine

refine(
    *task_templates: _TaskTemplateT,
    update: bool = True,
    name: str | None = None,
    iterate_over_data_files: bool = False,
    output_dataset_param: str | None = None,
    output_dataset_cls: type[IsDataset] | None = None,
    auto_async: bool = True,
    result_key: str | None = None,
    fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
    param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
    persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
    restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
    **kwargs: object,
) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def refine(
        self,
        *task_templates: _TaskTemplateT,
        update: bool = True,
        name: str | None = None,
        iterate_over_data_files: bool = False,
        output_dataset_param: str | None = None,
        output_dataset_cls: type[IsDataset] | None = None,
        auto_async: bool = True,
        result_key: str | None = None,
        fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
        param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
        persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
        restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
        **kwargs: object) -> _JobTemplateT:
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

run

run(*args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT

Source code in src/omnipy/shared/protocols/compute/_job.py

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    ...

IsTask

Bases: IsFuncArgJob['IsTaskTemplate[_CallP, _RetT]', 'IsTask[_CallP, _RetT]', _CallP, _RetT], Protocol[_CallP, _RetT]

METHOD	DESCRIPTION
__init__
create_job
get_bound_args
has_coroutine_func
log
regenerate_unique_name
revise

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
time_of_cur_toplevel_flow_run	TYPE: datetime | None
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsTask(IsFuncArgJob['IsTaskTemplate[_CallP, _RetT]', 'IsTask[_CallP, _RetT]', _CallP, _RetT],
             Protocol[_CallP, _RetT]):
    """"""
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

time_of_cur_toplevel_flow_run property

time_of_cur_toplevel_flow_run: datetime | None

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

create_job classmethod

create_job(*args: object, **kwargs: object) -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

revise

revise() -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def revise(self) -> _JobTemplateT:
    ...

IsTaskTemplate

Bases: IsFuncArgJobTemplate['IsTaskTemplate[_CallP, _RetT]', 'IsTask[_CallP, _RetT]', _CallP, _RetT], Protocol[_CallP, _RetT]

Loosely coupled type replacement for the :py:class:~omnipy.compute.task.TaskTemplate class

METHOD	DESCRIPTION
__init__
apply
create_job_template
get_bound_args
has_coroutine_func
log
refine
regenerate_unique_name
run

ATTRIBUTE	DESCRIPTION
auto_async	TYPE: bool
config	TYPE: IsJobConfig
engine	TYPE: IsEngine | None
fixed_params	TYPE: MappingProxyType[str, object]
in_flow_context	TYPE: bool
iterate_over_data_files	TYPE: bool
logger	TYPE: Logger
name	TYPE: str
output_dataset_cls	TYPE: type[IsDataset] | None
output_dataset_param	TYPE: str | None
output_storage_protocol	TYPE: OutputStorageProtocolOptions.Literals
output_storage_protocol_to_use	TYPE: OutputStorageProtocolOptions.Literals
param_key_map	TYPE: MappingProxyType[str, str]
param_signatures	TYPE: MappingProxyType
persist_outputs	TYPE: PersistOutputsOptions.Literals
restore_outputs	TYPE: RestoreOutputsOptions.Literals
result_key	TYPE: str | None
return_type	TYPE: type
unique_name	TYPE: str
will_persist_outputs	TYPE: PersistOutputsOptions.Literals
will_restore_outputs	TYPE: RestoreOutputsOptions.Literals

Source code in src/omnipy/shared/protocols/compute/job.py

class IsTaskTemplate(IsFuncArgJobTemplate['IsTaskTemplate[_CallP, _RetT]',
                                          'IsTask[_CallP, _RetT]',
                                          _CallP,
                                          _RetT],
                     Protocol[_CallP, _RetT]):
    """
    Loosely coupled type replacement for the :py:class:`~omnipy.compute.task.TaskTemplate` class
    """
    ...

auto_async property

auto_async: bool

config property

config: IsJobConfig

engine property

engine: IsEngine | None

fixed_params property

fixed_params: MappingProxyType[str, object]

in_flow_context property

in_flow_context: bool

iterate_over_data_files property

iterate_over_data_files: bool

logger property

logger: Logger

name property

name: str

output_dataset_cls property

output_dataset_cls: type[IsDataset] | None

output_dataset_param property

output_dataset_param: str | None

output_storage_protocol property

output_storage_protocol: OutputStorageProtocolOptions.Literals

output_storage_protocol_to_use property

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

param_key_map property

param_key_map: MappingProxyType[str, str]

param_signatures property

param_signatures: MappingProxyType

persist_outputs property

persist_outputs: PersistOutputsOptions.Literals

restore_outputs property

restore_outputs: RestoreOutputsOptions.Literals

result_key property

result_key: str | None

return_type property

return_type: type

unique_name property

unique_name: str

will_persist_outputs property

will_persist_outputs: PersistOutputsOptions.Literals

will_restore_outputs property

will_restore_outputs: RestoreOutputsOptions.Literals

__init__

__init__(*, name: str | None = None)

Source code in src/omnipy/shared/protocols/compute/mixins.py

def __init__(self, *, name: str | None = None):
    ...

apply

apply() -> _JobT

Source code in src/omnipy/shared/protocols/compute/_job.py

def apply(self) -> _JobT:
    ...

create_job_template classmethod

create_job_template(*args: object, **kwargs: object) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    ...

get_bound_args

get_bound_args(*args: object, **kwargs: object) -> BoundArguments

Source code in src/omnipy/shared/protocols/compute/_job.py

def get_bound_args(self, *args: object, **kwargs: object) -> BoundArguments:
    ...

has_coroutine_func

has_coroutine_func() -> bool

Source code in src/omnipy/shared/protocols/compute/_job.py

def has_coroutine_func(self) -> bool:
    ...

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Source code in src/omnipy/shared/protocols/hub/log.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    ...

refine

refine(
    *args: Any,
    update: bool = True,
    name: str | None = None,
    iterate_over_data_files: bool = False,
    output_dataset_param: str | None = None,
    output_dataset_cls: type[IsDataset] | None = None,
    auto_async: bool = True,
    result_key: str | None = None,
    fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
    param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
    persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
    restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
    **kwargs: object,
) -> _JobTemplateT

Source code in src/omnipy/shared/protocols/compute/_job.py

def refine(
        self,
        *args: Any,
        update: bool = True,
        name: str | None = None,
        iterate_over_data_files: bool = False,
        output_dataset_param: str | None = None,
        output_dataset_cls: type[IsDataset] | None = None,
        auto_async: bool = True,
        result_key: str | None = None,
        fixed_params: Mapping[str, object] | Iterable[tuple[str, object]] | None = None,
        param_key_map: Mapping[str, str] | Iterable[tuple[str, str]] | None = None,
        persist_outputs: PersistOutputsOptions.Literals = PersistOutputsOptions.FOLLOW_CONFIG,
        restore_outputs: RestoreOutputsOptions.Literals = RestoreOutputsOptions.FOLLOW_CONFIG,
        **kwargs: object) -> _JobTemplateT:
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Source code in src/omnipy/shared/protocols/compute/mixins.py

def regenerate_unique_name(self) -> None:
    ...

run

run(*args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT

Source code in src/omnipy/shared/protocols/compute/_job.py

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    ...