omnipy.shared.protocols.compute.job

Top-level task and flow protocol definitions.

CLASS	DESCRIPTION
`HasChildJobListArgJobTemplateInit`	Callable initializer protocol for flow templates with child job templates.
`HasFuncArgJobTemplateInit`	Callable initializer protocol for templates that wrap one Python callable.
`HasJobCreator`	Protocol for objects exposing a shared :class:`IsJobCreator` instance.
`IsAnyFlow`	Protocol covering any applied Omnipy flow variant.
`IsAnyFlowTemplate`
`IsChildJobListArgJob`
`IsChildJobListArgJobBase`	Protocol for flow-style jobs that own an ordered child-template list.
`IsChildJobListArgJobTemplate`	Template protocol for flows composed from an ordered child-template list.
`IsDagFlow`	Protocol for applied DAG flows.
`IsDagFlowTemplate`
`IsFlow`	Protocol for applied flows with run-state metadata.
`IsFlowTemplate`	Protocol for flow templates.
`IsFuncArgJob`	Applied-job protocol for callable-backed tasks and flows.
`IsFuncArgJobBase`	Protocol for jobs backed by a Python callable and callable-related options.
`IsFuncArgJobTemplate`	Template protocol for callable-backed tasks and function-style flows.
`IsFuncFlow`	Protocol for callable-backed applied flows.
`IsFuncFlowTemplate`	Protocol for callable-backed flow templates.
`IsJob`	Protocol for an applied job that is ready to execute.
`IsJobBase`	Common protocol shared by job templates and applied jobs.
`IsJobBaseCallable`	Protocol for job objects that expose a normal callable interface.
`IsJobTemplate`	Protocol for a reusable job template with immutable configuration.
`IsLinearFlow`	Protocol for applied linear flows.
`IsLinearFlowTemplate`	Protocol for linear flow templates.
`IsPlainFuncArgJobBase`	Minimal protocol for objects that store and decorate a wrapped callable.
`IsTask`	Protocol for an applied Omnipy task.
`IsTaskTemplate`	Loosely coupled type replacement for the :py:class:`~omnipy.compute.task.TaskTemplate` class

HasChildJobListArgJobTemplateInit

Bases: Protocol[_JobTemplateT, _CallP, _RetContraT]


              flowchart BT
              omnipy.shared.protocols.compute.job.HasChildJobListArgJobTemplateInit[HasChildJobListArgJobTemplateInit]

              

              click omnipy.shared.protocols.compute.job.HasChildJobListArgJobTemplateInit href "" "omnipy.shared.protocols.compute.job.HasChildJobListArgJobTemplateInit"

Callable initializer protocol for flow templates with child job templates.

The initializer receives both the coordinating callable and the ordered child templates that make up the flow body.

Returned by:

Reference Code reference omnipy compute flow
- to_dag_flow_template_init_protocol
- to_linear_flow_template_init_protocol

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

class HasChildJobListArgJobTemplateInit(Protocol[_JobTemplateT, _CallP, _RetContraT]):
    """Callable initializer protocol for flow templates with child job templates.

    The initializer receives both the coordinating callable and the ordered child
    templates that make up the flow body.
    """
    def __call__(
        self,
        job_func: Callable[_CallP, _RetContraT],
        /,
        *child_job_templates: IsFuncArgJobTemplate,
        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:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # Create a flow template around ``job_func`` and child jobs.
        #
        # Args:
        #     *child_job_templates: Ordered child-job templates owned by the flow template.
        #
        # {{JOB_TEMPLATE_INIT_CALL_COMMON_ARGS}}
        """Create a flow template around ``job_func`` and child jobs.

        Args:
            *child_job_templates: Ordered child-job templates owned by the flow template.

            job_func: Python callable to wrap as a job template.
            name: Optional replacement display name.
            iterate_over_data_files: Whether dataset inputs should be processed item-wise.
            output_dataset_param: Optional name of an explicit output-dataset parameter.
            output_dataset_cls: Optional dataset class to use for iterated outputs.
            auto_async: Whether coroutine jobs should auto-run outside flow contexts.
            result_key: Optional key used to wrap the returned result in a dictionary.
            fixed_params: Keyword arguments fixed onto every job invocation.
            param_key_map: Mapping from external keyword names to callable parameter names.
            persist_outputs: Per-job output-persistence preference.
            restore_outputs: Per-job output-restore preference.
            **kwargs: Additional constructor keyword overrides.

        Returns:
            _JobTemplateT: New job template instance wrapping ``job_func``.
        """
        ...

HasFuncArgJobTemplateInit

Bases: Protocol[_JobTemplateT, _CallP, _RetContraT]


              flowchart BT
              omnipy.shared.protocols.compute.job.HasFuncArgJobTemplateInit[HasFuncArgJobTemplateInit]

              

              click omnipy.shared.protocols.compute.job.HasFuncArgJobTemplateInit href "" "omnipy.shared.protocols.compute.job.HasFuncArgJobTemplateInit"

Callable initializer protocol for templates that wrap one Python callable.

This is the decorator-facing constructor shape used by task templates and callable-backed flow templates.

Returned by:

Reference Code reference omnipy compute
- flow to_func_flow_template_init_protocol
- task to_task_template_init_protocol

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

class HasFuncArgJobTemplateInit(Protocol[_JobTemplateT, _CallP, _RetContraT]):
    """Callable initializer protocol for templates that wrap one Python callable.

    This is the decorator-facing constructor shape used by task templates and
    callable-backed flow templates.
    """
    def __call__(
        self,
        job_func: Callable[_CallP, _RetContraT],
        *,
        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:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # Create a job template around ``job_func``.
        #
        # Args:
        # {{JOB_TEMPLATE_INIT_CALL_COMMON_ARGS}}
        """Create a job template around ``job_func``.

        Args:
            job_func: Python callable to wrap as a job template.
            name: Optional replacement display name.
            iterate_over_data_files: Whether dataset inputs should be processed item-wise.
            output_dataset_param: Optional name of an explicit output-dataset parameter.
            output_dataset_cls: Optional dataset class to use for iterated outputs.
            auto_async: Whether coroutine jobs should auto-run outside flow contexts.
            result_key: Optional key used to wrap the returned result in a dictionary.
            fixed_params: Keyword arguments fixed onto every job invocation.
            param_key_map: Mapping from external keyword names to callable parameter names.
            persist_outputs: Per-job output-persistence preference.
            restore_outputs: Per-job output-restore preference.
            **kwargs: Additional constructor keyword overrides.

        Returns:
            _JobTemplateT: New job template instance wrapping ``job_func``.
        """
        ...

HasJobCreator

Bases: Protocol


              flowchart BT
              omnipy.shared.protocols.compute.job.HasJobCreator[HasJobCreator]

              

              click omnipy.shared.protocols.compute.job.HasJobCreator href "" "omnipy.shared.protocols.compute.job.HasJobCreator"

Protocol for objects exposing a shared :class:IsJobCreator instance.

ATTRIBUTE	DESCRIPTION
`job_creator`	Return the shared creator object backing the job family. TYPE: `IsJobCreator`

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

class HasJobCreator(Protocol):
    """Protocol for objects exposing a shared :class:`IsJobCreator` instance."""
    @property
    def job_creator(self) -> IsJobCreator:
        """Return the shared creator object backing the job family.

        Returns:
            IsJobCreator: Shared holder for engine, config, and nested-context state.
        """
        ...

job_creator `property`

job_creator: IsJobCreator

Return the shared creator object backing the job family.

RETURNS	DESCRIPTION
`IsJobCreator`	Shared holder for engine, config, and nested-context state. TYPE: `IsJobCreator`

IsAnyFlow

Bases: IsFuncArgJob['IsAnyFlowTemplate[_CallP, _RetCovT]', 'IsAnyFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlow, Protocol[_CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsAnyFlow[IsAnyFlow]
              omnipy.shared.protocols.compute.job.IsFuncArgJob[IsFuncArgJob]
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlow[IsFlow]

                              omnipy.shared.protocols.compute.job.IsFuncArgJob --> omnipy.shared.protocols.compute.job.IsAnyFlow
                                omnipy.shared.protocols.compute.job.IsJob --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                

                omnipy.shared.protocols.compute.job.IsFlow --> omnipy.shared.protocols.compute.job.IsAnyFlow
                


              click omnipy.shared.protocols.compute.job.IsAnyFlow href "" "omnipy.shared.protocols.compute.job.IsAnyFlow"
              click omnipy.shared.protocols.compute.job.IsFuncArgJob href "" "omnipy.shared.protocols.compute.job.IsFuncArgJob"
              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlow href "" "omnipy.shared.protocols.compute.job.IsFlow"

Protocol covering any applied Omnipy flow variant.

This union-style flow contract is useful where task, linear-flow, DAG-flow, and function-flow implementations are all accepted.

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`flow_context`	Return a context manager that enters and exits the shared flow context. TYPE: `IsNestedContext`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`time_of_last_run`	Return the timestamp captured for the most recent top-level flow run. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsAnyFlow(IsFuncArgJob['IsAnyFlowTemplate[_CallP, _RetCovT]',
                             'IsAnyFlow[_CallP, _RetCovT]',
                             _CallP,
                             _RetCovT],
                IsFlow,
                Protocol[_CallP, _RetCovT]):
    """Protocol covering any applied Omnipy flow variant.

    This union-style flow contract is useful where task, linear-flow, DAG-flow,
    and function-flow implementations are all accepted.
    """
    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

flow_context `property`

flow_context: IsNestedContext

Return a context manager that enters and exits the shared flow context.

RETURNS	DESCRIPTION
`IsNestedContext`	Context manager that tracks top-level flow execution state. TYPE: `IsNestedContext`

Referenced by:

Reference Code reference omnipy engine run_spec

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

time_of_last_run `property`

time_of_last_run: datetime | None

Return the timestamp captured for the most recent top-level flow run.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp from the latest top-level flow run, or `None` if the flow has not completed one yet.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsAnyFlowTemplate

Bases: IsFuncArgJobTemplate['IsAnyFlowTemplate[_CallP, _RetCovT]', 'IsAnyFlow[_CallP, _RetCovT]', _CallP, _RetCovT], IsFlowTemplate, Protocol[_CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsAnyFlowTemplate[IsAnyFlowTemplate]
              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate[IsFuncArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlowTemplate[IsFlowTemplate]

                              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate --> omnipy.shared.protocols.compute.job.IsAnyFlowTemplate
                                omnipy.shared.protocols.compute.job.IsJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                

                omnipy.shared.protocols.compute.job.IsFlowTemplate --> omnipy.shared.protocols.compute.job.IsAnyFlowTemplate
                


              click omnipy.shared.protocols.compute.job.IsAnyFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsAnyFlowTemplate"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsFlowTemplate"

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`refine`	Return a template with updated callable-configuration settings.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsAnyFlowTemplate(IsFuncArgJobTemplate['IsAnyFlowTemplate[_CallP, _RetCovT]',
                                             'IsAnyFlow[_CallP, _RetCovT]',
                                             _CallP,
                                             _RetCovT],
                        IsFlowTemplate,
                        Protocol[_CallP, _RetCovT]):
    """"""
    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

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

Return a template with updated callable-configuration settings.

PARAMETER	DESCRIPTION
`*args`	Positional constructor overrides for the template. TYPE: `Any` DEFAULT: `()`
`update`	Whether omitted values should be inherited from the current template. TYPE: `bool` DEFAULT: `True`
`name`	Optional replacement display name. TYPE: `str \| None` DEFAULT: `None`
`iterate_over_data_files`	Whether dataset inputs should be processed item-wise. TYPE: `bool` DEFAULT: `False`
`output_dataset_param`	Optional name of an explicit output-dataset parameter. TYPE: `str \| None` DEFAULT: `None`
`output_dataset_cls`	Optional dataset class to use for iterated outputs. TYPE: `type[IsDataset] \| None` DEFAULT: `None`
`auto_async`	Whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool` DEFAULT: `True`
`result_key`	Optional key used to wrap the returned result in a dictionary. TYPE: `str \| None` DEFAULT: `None`
`fixed_params`	Keyword arguments fixed onto every job invocation. TYPE: `Mapping[str, object] \| Iterable[tuple[str, object]] \| None` DEFAULT: `None`
`param_key_map`	Mapping from external keyword names to callable parameter names. TYPE: `Mapping[str, str] \| Iterable[tuple[str, str]] \| None` DEFAULT: `None`
`persist_outputs`	Per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals` DEFAULT: `PersistOutputsOptions.FOLLOW_CONFIG`
`restore_outputs`	Per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals` DEFAULT: `RestoreOutputsOptions.FOLLOW_CONFIG`
`**kwargs`	Additional constructor keyword overrides. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	Refined template instance. TYPE: `_JobTemplateT`

Referenced by:

Reference Code reference omnipy compute
- flow
- task TaskTemplateCore refine

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:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # Return a template with updated callable-configuration settings.
    #
    # Args:
    #     *args: Positional constructor overrides for the template.
    #
    # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
    #
    """Return a template with updated callable-configuration settings.

    Args:
        *args: Positional constructor overrides for the template.

        update: Whether omitted values should be inherited from the current template.
        name: Optional replacement display name.
        iterate_over_data_files: Whether dataset inputs should be processed item-wise.
        output_dataset_param: Optional name of an explicit output-dataset parameter.
        output_dataset_cls: Optional dataset class to use for iterated outputs.
        auto_async: Whether coroutine jobs should auto-run outside flow contexts.
        result_key: Optional key used to wrap the returned result in a dictionary.
        fixed_params: Keyword arguments fixed onto every job invocation.
        param_key_map: Mapping from external keyword names to callable parameter names.
        persist_outputs: Per-job output-persistence preference.
        restore_outputs: Per-job output-restore preference.
        **kwargs: Additional constructor keyword overrides.

    Returns:
        _JobTemplateT: Refined template instance.

    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

IsChildJobListArgJob

Bases: IsChildJobListArgJobBase, IsFuncArgJob[_JobTemplateT, _JobT, _CallP, _RetCovT], Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsChildJobListArgJob[IsChildJobListArgJob]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase[IsChildJobListArgJobBase]
              omnipy.shared.protocols.compute.job.IsFuncArgJob[IsFuncArgJob]
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

                              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJob
                                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase
                

                omnipy.shared.protocols.compute.job.IsFuncArgJob --> omnipy.shared.protocols.compute.job.IsChildJobListArgJob
                                omnipy.shared.protocols.compute.job.IsJob --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                



              click omnipy.shared.protocols.compute.job.IsChildJobListArgJob href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJob"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFuncArgJob href "" "omnipy.shared.protocols.compute.job.IsFuncArgJob"
              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

Subclassed by:

Reference Code reference omnipy shared protocols compute job
- IsDagFlow
- IsLinearFlow

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`child_job_templates`	Return the child-job templates owned by the flow template. TYPE: `tuple[IsFuncArgJobTemplate, ...]`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsChildJobListArgJob(IsChildJobListArgJobBase,
                           IsFuncArgJob[_JobTemplateT, _JobT, _CallP, _RetCovT],
                           Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """"""

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

child_job_templates `property`

child_job_templates: tuple[IsFuncArgJobTemplate, ...]

Return the child-job templates owned by the flow template.

RETURNS	DESCRIPTION
`tuple[IsFuncArgJobTemplate, ...]`	tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsChildJobListArgJobBase

Bases: IsFuncArgJobBase, Protocol


              flowchart BT
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase[IsChildJobListArgJobBase]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

                              omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase
                


              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

Protocol for flow-style jobs that own an ordered child-template list.

The child templates define the nested jobs a flow applies or orchestrates in addition to its own callable-backed configuration.

Subclassed by:

Reference Code reference omnipy shared protocols compute job
- IsChildJobListArgJob
- IsChildJobListArgJobTemplate

METHOD	DESCRIPTION
`get_bound_args`	Bind arguments to the job callable signature.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`child_job_templates`	Return the child-job templates owned by the flow template. TYPE: `tuple[IsFuncArgJobTemplate, ...]`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsChildJobListArgJobBase(IsFuncArgJobBase, Protocol):
    """Protocol for flow-style jobs that own an ordered child-template list.

    The child templates define the nested jobs a flow applies or orchestrates in
    addition to its own callable-backed configuration.
    """
    @property
    def child_job_templates(self) -> tuple[IsFuncArgJobTemplate, ...]:
        """Return the child-job templates owned by the flow template.

        Returns:
            tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.
        """
        ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

child_job_templates `property`

child_job_templates: tuple[IsFuncArgJobTemplate, ...]

Return the child-job templates owned by the flow template.

RETURNS	DESCRIPTION
`tuple[IsFuncArgJobTemplate, ...]`	tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.

Referenced by:

Reference Code reference omnipy engine run_spec

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

IsChildJobListArgJobTemplate

Bases: IsFuncArgJobTemplate[_JobTemplateT, _JobT, _CallP, _RetCovT], IsChildJobListArgJobBase, Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate[IsChildJobListArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate[IsFuncArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase[IsChildJobListArgJobBase]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

                              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                

                omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase
                



              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

Template protocol for flows composed from an ordered child-template list.

Refinement can replace the owned child templates while keeping the shared callable-backed configuration contract from :class:IsFuncArgJobTemplate.

Subclassed by:

Reference Code reference omnipy shared protocols compute job
- IsDagFlowTemplate
- IsLinearFlowTemplate

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`refine`	Return a flow template with updated child jobs or callable configuration.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`child_job_templates`	Return the child-job templates owned by the flow template. TYPE: `tuple[IsFuncArgJobTemplate, ...]`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsChildJobListArgJobTemplate(IsFuncArgJobTemplate[_JobTemplateT, _JobT, _CallP, _RetCovT],
                                   IsChildJobListArgJobBase,
                                   Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """Template protocol for flows composed from an ordered child-template list.

    Refinement can replace the owned child templates while keeping the shared
    callable-backed configuration contract from :class:`IsFuncArgJobTemplate`.
    """
    def refine(
            self,
            *child_job_templates: IsFuncArgJobTemplate,
            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:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # Return a flow template with updated child jobs or callable configuration.
        #
        # Args:
        #     *child_job_templates: Replacement ordered child-job templates.
        #
        # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
        #
        """Return a flow template with updated child jobs or callable configuration.

        Args:
            *child_job_templates: Replacement ordered child-job templates.

            update: Whether omitted values should be inherited from the current template.
            name: Optional replacement display name.
            iterate_over_data_files: Whether dataset inputs should be processed item-wise.
            output_dataset_param: Optional name of an explicit output-dataset parameter.
            output_dataset_cls: Optional dataset class to use for iterated outputs.
            auto_async: Whether coroutine jobs should auto-run outside flow contexts.
            result_key: Optional key used to wrap the returned result in a dictionary.
            fixed_params: Keyword arguments fixed onto every job invocation.
            param_key_map: Mapping from external keyword names to callable parameter names.
            persist_outputs: Per-job output-persistence preference.
            restore_outputs: Per-job output-restore preference.
            **kwargs: Additional constructor keyword overrides.

        Returns:
            _JobTemplateT: Refined template instance.

        """
        ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

child_job_templates `property`

child_job_templates: tuple[IsFuncArgJobTemplate, ...]

Return the child-job templates owned by the flow template.

RETURNS	DESCRIPTION
`tuple[IsFuncArgJobTemplate, ...]`	tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

refine

refine(
    *child_job_templates: IsFuncArgJobTemplate,
    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

Return a flow template with updated child jobs or callable configuration.

PARAMETER	DESCRIPTION
`*child_job_templates`	Replacement ordered child-job templates. TYPE: `IsFuncArgJobTemplate` DEFAULT: `()`
`update`	Whether omitted values should be inherited from the current template. TYPE: `bool` DEFAULT: `True`
`name`	Optional replacement display name. TYPE: `str \| None` DEFAULT: `None`
`iterate_over_data_files`	Whether dataset inputs should be processed item-wise. TYPE: `bool` DEFAULT: `False`
`output_dataset_param`	Optional name of an explicit output-dataset parameter. TYPE: `str \| None` DEFAULT: `None`
`output_dataset_cls`	Optional dataset class to use for iterated outputs. TYPE: `type[IsDataset] \| None` DEFAULT: `None`
`auto_async`	Whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool` DEFAULT: `True`
`result_key`	Optional key used to wrap the returned result in a dictionary. TYPE: `str \| None` DEFAULT: `None`
`fixed_params`	Keyword arguments fixed onto every job invocation. TYPE: `Mapping[str, object] \| Iterable[tuple[str, object]] \| None` DEFAULT: `None`
`param_key_map`	Mapping from external keyword names to callable parameter names. TYPE: `Mapping[str, str] \| Iterable[tuple[str, str]] \| None` DEFAULT: `None`
`persist_outputs`	Per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals` DEFAULT: `PersistOutputsOptions.FOLLOW_CONFIG`
`restore_outputs`	Per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals` DEFAULT: `RestoreOutputsOptions.FOLLOW_CONFIG`
`**kwargs`	Additional constructor keyword overrides. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	Refined template instance. TYPE: `_JobTemplateT`

Referenced by:

Reference Code reference omnipy compute
- flow
- task TaskTemplateCore refine

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

def refine(
        self,
        *child_job_templates: IsFuncArgJobTemplate,
        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:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # Return a flow template with updated child jobs or callable configuration.
    #
    # Args:
    #     *child_job_templates: Replacement ordered child-job templates.
    #
    # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
    #
    """Return a flow template with updated child jobs or callable configuration.

    Args:
        *child_job_templates: Replacement ordered child-job templates.

        update: Whether omitted values should be inherited from the current template.
        name: Optional replacement display name.
        iterate_over_data_files: Whether dataset inputs should be processed item-wise.
        output_dataset_param: Optional name of an explicit output-dataset parameter.
        output_dataset_cls: Optional dataset class to use for iterated outputs.
        auto_async: Whether coroutine jobs should auto-run outside flow contexts.
        result_key: Optional key used to wrap the returned result in a dictionary.
        fixed_params: Keyword arguments fixed onto every job invocation.
        param_key_map: Mapping from external keyword names to callable parameter names.
        persist_outputs: Per-job output-persistence preference.
        restore_outputs: Per-job output-restore preference.
        **kwargs: Additional constructor keyword overrides.

    Returns:
        _JobTemplateT: Refined template instance.

    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

IsDagFlow

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsDagFlow[IsDagFlow]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJob[IsChildJobListArgJob]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase[IsChildJobListArgJobBase]
              omnipy.shared.protocols.compute.job.IsFuncArgJob[IsFuncArgJob]
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlow[IsFlow]

                              omnipy.shared.protocols.compute.job.IsChildJobListArgJob --> omnipy.shared.protocols.compute.job.IsDagFlow
                                omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJob
                                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase
                

                omnipy.shared.protocols.compute.job.IsFuncArgJob --> omnipy.shared.protocols.compute.job.IsChildJobListArgJob
                                omnipy.shared.protocols.compute.job.IsJob --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                


                omnipy.shared.protocols.compute.job.IsFlow --> omnipy.shared.protocols.compute.job.IsDagFlow
                


              click omnipy.shared.protocols.compute.job.IsDagFlow href "" "omnipy.shared.protocols.compute.job.IsDagFlow"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJob href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJob"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFuncArgJob href "" "omnipy.shared.protocols.compute.job.IsFuncArgJob"
              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlow href "" "omnipy.shared.protocols.compute.job.IsFlow"

Protocol for applied DAG flows.

Subclassed by:

Reference Code reference
- omnipy DagFlow
- omnipy compute flow
  - DagFlow
  - DagFlowTemplateCore

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`child_job_templates`	Return the child-job templates owned by the flow template. TYPE: `tuple[IsFuncArgJobTemplate, ...]`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`flow_context`	Return a context manager that enters and exits the shared flow context. TYPE: `IsNestedContext`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`time_of_last_run`	Return the timestamp captured for the most recent top-level flow run. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsDagFlow(IsChildJobListArgJob['IsDagFlowTemplate[_CallP, _RetCovT]',
                                     'IsDagFlow[_CallP, _RetCovT]',
                                     _CallP,
                                     _RetCovT],
                IsFlow,
                Protocol[_CallP, _RetCovT]):
    """Protocol for applied DAG flows."""

    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

child_job_templates `property`

child_job_templates: tuple[IsFuncArgJobTemplate, ...]

Return the child-job templates owned by the flow template.

RETURNS	DESCRIPTION
`tuple[IsFuncArgJobTemplate, ...]`	tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

flow_context `property`

flow_context: IsNestedContext

Return a context manager that enters and exits the shared flow context.

RETURNS	DESCRIPTION
`IsNestedContext`	Context manager that tracks top-level flow execution state. TYPE: `IsNestedContext`

Referenced by:

Reference Code reference omnipy engine run_spec

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

time_of_last_run `property`

time_of_last_run: datetime | None

Return the timestamp captured for the most recent top-level flow run.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp from the latest top-level flow run, or `None` if the flow has not completed one yet.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsDagFlowTemplate

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsDagFlowTemplate[IsDagFlowTemplate]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate[IsChildJobListArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate[IsFuncArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase[IsChildJobListArgJobBase]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlowTemplate[IsFlowTemplate]

                              omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate --> omnipy.shared.protocols.compute.job.IsDagFlowTemplate
                                omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                

                omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase
                


                omnipy.shared.protocols.compute.job.IsFlowTemplate --> omnipy.shared.protocols.compute.job.IsDagFlowTemplate
                


              click omnipy.shared.protocols.compute.job.IsDagFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsDagFlowTemplate"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsFlowTemplate"

Returned by:

Reference Code reference omnipy compute flow
- dag_flow_template_as_callable_decorator
- to_dag_flow_template_init_protocol

Subclassed by:

Reference Code reference
- omnipy DagFlow
- omnipy compute flow
  - DagFlow
  - DagFlowTemplateCore

Used by:

Reference Code reference omnipy compute flow dag_flow_template_as_callable_decorator

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`refine`	Return a flow template with updated child jobs or callable configuration.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`child_job_templates`	Return the child-job templates owned by the flow template. TYPE: `tuple[IsFuncArgJobTemplate, ...]`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

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

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

child_job_templates `property`

child_job_templates: tuple[IsFuncArgJobTemplate, ...]

Return the child-job templates owned by the flow template.

RETURNS	DESCRIPTION
`tuple[IsFuncArgJobTemplate, ...]`	tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

refine

refine(
    *child_job_templates: IsFuncArgJobTemplate,
    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

Return a flow template with updated child jobs or callable configuration.

PARAMETER	DESCRIPTION
`*child_job_templates`	Replacement ordered child-job templates. TYPE: `IsFuncArgJobTemplate` DEFAULT: `()`
`update`	Whether omitted values should be inherited from the current template. TYPE: `bool` DEFAULT: `True`
`name`	Optional replacement display name. TYPE: `str \| None` DEFAULT: `None`
`iterate_over_data_files`	Whether dataset inputs should be processed item-wise. TYPE: `bool` DEFAULT: `False`
`output_dataset_param`	Optional name of an explicit output-dataset parameter. TYPE: `str \| None` DEFAULT: `None`
`output_dataset_cls`	Optional dataset class to use for iterated outputs. TYPE: `type[IsDataset] \| None` DEFAULT: `None`
`auto_async`	Whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool` DEFAULT: `True`
`result_key`	Optional key used to wrap the returned result in a dictionary. TYPE: `str \| None` DEFAULT: `None`
`fixed_params`	Keyword arguments fixed onto every job invocation. TYPE: `Mapping[str, object] \| Iterable[tuple[str, object]] \| None` DEFAULT: `None`
`param_key_map`	Mapping from external keyword names to callable parameter names. TYPE: `Mapping[str, str] \| Iterable[tuple[str, str]] \| None` DEFAULT: `None`
`persist_outputs`	Per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals` DEFAULT: `PersistOutputsOptions.FOLLOW_CONFIG`
`restore_outputs`	Per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals` DEFAULT: `RestoreOutputsOptions.FOLLOW_CONFIG`
`**kwargs`	Additional constructor keyword overrides. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	Refined template instance. TYPE: `_JobTemplateT`

Referenced by:

Reference Code reference omnipy compute
- flow
- task TaskTemplateCore refine

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

def refine(
        self,
        *child_job_templates: IsFuncArgJobTemplate,
        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:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # Return a flow template with updated child jobs or callable configuration.
    #
    # Args:
    #     *child_job_templates: Replacement ordered child-job templates.
    #
    # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
    #
    """Return a flow template with updated child jobs or callable configuration.

    Args:
        *child_job_templates: Replacement ordered child-job templates.

        update: Whether omitted values should be inherited from the current template.
        name: Optional replacement display name.
        iterate_over_data_files: Whether dataset inputs should be processed item-wise.
        output_dataset_param: Optional name of an explicit output-dataset parameter.
        output_dataset_cls: Optional dataset class to use for iterated outputs.
        auto_async: Whether coroutine jobs should auto-run outside flow contexts.
        result_key: Optional key used to wrap the returned result in a dictionary.
        fixed_params: Keyword arguments fixed onto every job invocation.
        param_key_map: Mapping from external keyword names to callable parameter names.
        persist_outputs: Per-job output-persistence preference.
        restore_outputs: Per-job output-restore preference.
        **kwargs: Additional constructor keyword overrides.

    Returns:
        _JobTemplateT: Refined template instance.

    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

IsFlow

Bases: Protocol


              flowchart BT
              omnipy.shared.protocols.compute.job.IsFlow[IsFlow]

              

              click omnipy.shared.protocols.compute.job.IsFlow href "" "omnipy.shared.protocols.compute.job.IsFlow"

Protocol for applied flows with run-state metadata.

Subclassed by:

Reference Code reference omnipy shared protocols compute job

ATTRIBUTE	DESCRIPTION
`flow_context`	Return a context manager that enters and exits the shared flow context. TYPE: `IsNestedContext`
`time_of_last_run`	Return the timestamp captured for the most recent top-level flow run. TYPE: `datetime \| None`

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

class IsFlow(Protocol):
    """Protocol for applied flows with run-state metadata."""
    @property
    def flow_context(self) -> IsNestedContext:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFLOW_FLOW_CONTEXT_SUMMARY}}
        #
        # {{ISFLOW_FLOW_CONTEXT_DETAILS}}
        """Return a context manager that enters and exits the shared flow context.

        Returns:
            IsNestedContext: Context manager that tracks top-level flow execution state.
        """
        ...

    @property
    def time_of_last_run(self) -> datetime | None:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFLOW_TIME_OF_LAST_RUN_SUMMARY}}
        #
        # {{ISFLOW_TIME_OF_LAST_RUN_DETAILS}}
        """Return the timestamp captured for the most recent top-level flow run.

        Returns:
            datetime | None: Timestamp from the latest top-level flow run, or ``None`` if the
                flow has not completed one yet.
        """
        ...

flow_context `property`

flow_context: IsNestedContext

Return a context manager that enters and exits the shared flow context.

RETURNS	DESCRIPTION
`IsNestedContext`	Context manager that tracks top-level flow execution state. TYPE: `IsNestedContext`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_last_run `property`

time_of_last_run: datetime | None

Return the timestamp captured for the most recent top-level flow run.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp from the latest top-level flow run, or `None` if the flow has not completed one yet.

IsFlowTemplate

Bases: Protocol


              flowchart BT
              omnipy.shared.protocols.compute.job.IsFlowTemplate[IsFlowTemplate]

              

              click omnipy.shared.protocols.compute.job.IsFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsFlowTemplate"

Protocol for flow templates.

Subclassed by:

Reference Code reference omnipy shared protocols compute job

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

class IsFlowTemplate(Protocol):
    """Protocol for flow templates."""

    ...

IsFuncArgJob

Bases: IsJob[_JobTemplateT, _JobT, _CallP, _RetCovT], IsFuncArgJobBase, Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsFuncArgJob[IsFuncArgJob]
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

                              omnipy.shared.protocols.compute.job.IsJob --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                


              click omnipy.shared.protocols.compute.job.IsFuncArgJob href "" "omnipy.shared.protocols.compute.job.IsFuncArgJob"
              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

Applied-job protocol for callable-backed tasks and flows.

Subclassed by:

Reference Code reference omnipy shared protocols compute job

Used by:

Reference Code reference omnipy
- engine
- shared protocols engine job_runner IsJobRunnerEngine apply_job_decorator

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsFuncArgJob(IsJob[_JobTemplateT, _JobT, _CallP, _RetCovT],
                   IsFuncArgJobBase,
                   Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """Applied-job protocol for callable-backed tasks and flows."""

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsFuncArgJobBase

Bases: Protocol


              flowchart BT
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

              

              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

Protocol for jobs backed by a Python callable and callable-related options.

This contract adds signature inspection, dataset-iteration controls, result shaping, and persisted-output settings on top of the base job lifecycle.

Subclassed by:

Reference Code reference omnipy shared protocols compute job

METHOD	DESCRIPTION
`get_bound_args`	Bind arguments to the job callable signature.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsFuncArgJobBase(Protocol):
    """Protocol for jobs backed by a Python callable and callable-related options.

    This contract adds signature inspection, dataset-iteration controls, result
    shaping, and persisted-output settings on top of the base job lifecycle.
    """
    @property
    def param_signatures(self) -> MappingProxyType[str, inspect.Parameter]:
        """Return the inspected parameter signature of the job callable.

        Returns:
            MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to
                signature entries.
        """
        ...

    @property
    def return_type(self) -> type:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_RETURN_TYPE_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_RETURN_TYPE_DETAILS}}
        """Return the annotated return type of the job callable.

        Returns:
            type: Return annotation for the callable.
        """
        ...

    @property
    def iterate_over_data_files(self) -> bool:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_ITERATE_OVER_DATA_FILES_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_ITERATE_OVER_DATA_FILES_DETAILS}}
        """Return whether the job should iterate over dataset items automatically.

        Returns:
            bool: ``True`` when the first dataset argument is expanded item-by-item.
        """
        ...

    @property
    def output_dataset_param(self) -> str | None:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_OUTPUT_DATASET_PARAM_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_OUTPUT_DATASET_PARAM_DETAILS}}
        """Return the parameter name used for an explicit output dataset, if any.

        Returns:
            str | None: Output-dataset parameter name, or ``None`` when not configured.
        """
        ...

    @property
    def output_dataset_cls(self) -> type[IsDataset] | None:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_OUTPUT_DATASET_CLS_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_OUTPUT_DATASET_CLS_DETAILS}}
        """Return the dataset class used for iterated outputs, if configured.

        Returns:
            type[IsDataset] | None: Output dataset type, or ``None`` when inferred.
        """
        ...

    @property
    def auto_async(self) -> bool:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_AUTO_ASYNC_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_AUTO_ASYNC_DETAILS}}
        """Return whether coroutine jobs should auto-run outside flow contexts.

        Returns:
            bool: ``True`` when coroutine jobs are automatically awaited or scheduled.
        """
        ...

    @property
    def persist_outputs(self) -> PersistOutputsOptions.Literals:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_PERSIST_OUTPUTS_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_PERSIST_OUTPUTS_DETAILS}}
        """Return the configured per-job output-persistence preference.

        Returns:
            PersistOutputsOptions.Literals: Persistence setting before config fallback.
        """
        ...

    @property
    def restore_outputs(self) -> RestoreOutputsOptions.Literals:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_RESTORE_OUTPUTS_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_RESTORE_OUTPUTS_DETAILS}}
        """Return the configured per-job output-restore preference.

        Returns:
            RestoreOutputsOptions.Literals: Restore setting before config fallback.
        """
        ...

    @property
    def output_storage_protocol(self) -> OutputStorageProtocolOptions.Literals:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_OUTPUT_STORAGE_PROTOCOL_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_OUTPUT_STORAGE_PROTOCOL_DETAILS}}
        """Return the configured output-storage protocol preference.

        Returns:
            OutputStorageProtocolOptions.Literals: Storage-protocol setting before
                config fallback.
        """
        ...

    @property
    def will_persist_outputs(self) -> PersistOutputsOptions.Literals:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_WILL_PERSIST_OUTPUTS_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_WILL_PERSIST_OUTPUTS_DETAILS}}
        """Return the resolved output-persistence behavior for this run.

        Returns:
            PersistOutputsOptions.Literals: Effective persistence behavior after
                applying config-following rules.
        """
        ...

    @property
    def will_restore_outputs(self) -> RestoreOutputsOptions.Literals:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_WILL_RESTORE_OUTPUTS_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_WILL_RESTORE_OUTPUTS_DETAILS}}
        """Return the resolved output-restore behavior for this run.

        Returns:
            RestoreOutputsOptions.Literals: Effective restore behavior after applying
                config-following rules.
        """
        ...

    @property
    def output_storage_protocol_to_use(self) -> OutputStorageProtocolOptions.Literals:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_OUTPUT_STORAGE_PROTOCOL_TO_USE_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_OUTPUT_STORAGE_PROTOCOL_TO_USE_DETAILS}}
        """Return the resolved storage protocol used for persisted outputs.

        Returns:
            OutputStorageProtocolOptions.Literals: Effective storage protocol for this
                run.
        """
        ...

    @property
    def result_key(self) -> str | None:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_RESULT_KEY_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_RESULT_KEY_DETAILS}}
        """Return the dictionary key used to wrap results, if configured.

        Returns:
            str | None: Result wrapper key, or ``None`` when results are returned raw.
        """
        ...

    @property
    def fixed_params(self) -> MappingProxyType[str, object]:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_FIXED_PARAMS_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_FIXED_PARAMS_DETAILS}}
        """Return parameters that are always supplied when the job callable runs.

        Returns:
            MappingProxyType[str, object]: Read-only mapping of fixed keyword values.
        """
        ...

    @property
    def param_key_map(self) -> MappingProxyType[str, str]:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_PARAM_KEY_MAP_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_PARAM_KEY_MAP_DETAILS}}
        """Return keyword-name remappings applied before calling the job callable.

        Returns:
            MappingProxyType[str, str]: Mapping from external keyword names to callable
                parameter names.
        """
        ...

    @property
    def callable_type(self) -> CallableType.Literals:
        """
        The effective callable type of the job function.

        The callable type captures both the synchronous/asynchronous and
        plain/generator dimensions of the wrapped callable.

        Returns:
            CallableType.Literals: The effective callable type of the job
                function.
        """
        ...

    def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
        #
        # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
        """Bind arguments to the job callable signature.

        Args:
            *args: Positional call arguments.
            **kwargs: Keyword call arguments.

        Returns:
            inspect.BoundArguments: Bound arguments with defaults applied.
        """
        ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

IsFuncArgJobTemplate

Bases: IsJobTemplate[_JobTemplateT, _JobT, _CallP, _RetCovT], IsFuncArgJobBase, Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate[IsFuncArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

                              omnipy.shared.protocols.compute.job.IsJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                


              click omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

Template protocol for callable-backed tasks and function-style flows.

Implementations refine the wrapped callable's execution options without changing the public callable contract seen by template consumers.

Returned by:

Reference Code reference omnipy

Subclassed by:

Reference Code reference omnipy shared protocols compute job

Used by:

Reference Code reference omnipy
- compute flow
  - DagFlowTemplateCore __init__
  - LinearFlowTemplateCore __init__
- shared protocols compute job

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`refine`	Return a template with updated callable-configuration settings.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsFuncArgJobTemplate(IsJobTemplate[_JobTemplateT, _JobT, _CallP, _RetCovT],
                           IsFuncArgJobBase,
                           Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """Template protocol for callable-backed tasks and function-style flows.

    Implementations refine the wrapped callable's execution options without
    changing the public callable contract seen by template consumers.
    """
    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:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # Return a template with updated callable-configuration settings.
        #
        # Args:
        #     *args: Positional constructor overrides for the template.
        #
        # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
        #
        """Return a template with updated callable-configuration settings.

        Args:
            *args: Positional constructor overrides for the template.

            update: Whether omitted values should be inherited from the current template.
            name: Optional replacement display name.
            iterate_over_data_files: Whether dataset inputs should be processed item-wise.
            output_dataset_param: Optional name of an explicit output-dataset parameter.
            output_dataset_cls: Optional dataset class to use for iterated outputs.
            auto_async: Whether coroutine jobs should auto-run outside flow contexts.
            result_key: Optional key used to wrap the returned result in a dictionary.
            fixed_params: Keyword arguments fixed onto every job invocation.
            param_key_map: Mapping from external keyword names to callable parameter names.
            persist_outputs: Per-job output-persistence preference.
            restore_outputs: Per-job output-restore preference.
            **kwargs: Additional constructor keyword overrides.

        Returns:
            _JobTemplateT: Refined template instance.

        """
        ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

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

Return a template with updated callable-configuration settings.

PARAMETER	DESCRIPTION
`*args`	Positional constructor overrides for the template. TYPE: `Any` DEFAULT: `()`
`update`	Whether omitted values should be inherited from the current template. TYPE: `bool` DEFAULT: `True`
`name`	Optional replacement display name. TYPE: `str \| None` DEFAULT: `None`
`iterate_over_data_files`	Whether dataset inputs should be processed item-wise. TYPE: `bool` DEFAULT: `False`
`output_dataset_param`	Optional name of an explicit output-dataset parameter. TYPE: `str \| None` DEFAULT: `None`
`output_dataset_cls`	Optional dataset class to use for iterated outputs. TYPE: `type[IsDataset] \| None` DEFAULT: `None`
`auto_async`	Whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool` DEFAULT: `True`
`result_key`	Optional key used to wrap the returned result in a dictionary. TYPE: `str \| None` DEFAULT: `None`
`fixed_params`	Keyword arguments fixed onto every job invocation. TYPE: `Mapping[str, object] \| Iterable[tuple[str, object]] \| None` DEFAULT: `None`
`param_key_map`	Mapping from external keyword names to callable parameter names. TYPE: `Mapping[str, str] \| Iterable[tuple[str, str]] \| None` DEFAULT: `None`
`persist_outputs`	Per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals` DEFAULT: `PersistOutputsOptions.FOLLOW_CONFIG`
`restore_outputs`	Per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals` DEFAULT: `RestoreOutputsOptions.FOLLOW_CONFIG`
`**kwargs`	Additional constructor keyword overrides. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	Refined template instance. TYPE: `_JobTemplateT`

Referenced by:

Reference Code reference omnipy compute
- flow
- task TaskTemplateCore refine

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:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # Return a template with updated callable-configuration settings.
    #
    # Args:
    #     *args: Positional constructor overrides for the template.
    #
    # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
    #
    """Return a template with updated callable-configuration settings.

    Args:
        *args: Positional constructor overrides for the template.

        update: Whether omitted values should be inherited from the current template.
        name: Optional replacement display name.
        iterate_over_data_files: Whether dataset inputs should be processed item-wise.
        output_dataset_param: Optional name of an explicit output-dataset parameter.
        output_dataset_cls: Optional dataset class to use for iterated outputs.
        auto_async: Whether coroutine jobs should auto-run outside flow contexts.
        result_key: Optional key used to wrap the returned result in a dictionary.
        fixed_params: Keyword arguments fixed onto every job invocation.
        param_key_map: Mapping from external keyword names to callable parameter names.
        persist_outputs: Per-job output-persistence preference.
        restore_outputs: Per-job output-restore preference.
        **kwargs: Additional constructor keyword overrides.

    Returns:
        _JobTemplateT: Refined template instance.

    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

IsFuncFlow

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsFuncFlow[IsFuncFlow]
              omnipy.shared.protocols.compute.job.IsFuncArgJob[IsFuncArgJob]
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlow[IsFlow]

                              omnipy.shared.protocols.compute.job.IsFuncArgJob --> omnipy.shared.protocols.compute.job.IsFuncFlow
                                omnipy.shared.protocols.compute.job.IsJob --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                

                omnipy.shared.protocols.compute.job.IsFlow --> omnipy.shared.protocols.compute.job.IsFuncFlow
                


              click omnipy.shared.protocols.compute.job.IsFuncFlow href "" "omnipy.shared.protocols.compute.job.IsFuncFlow"
              click omnipy.shared.protocols.compute.job.IsFuncArgJob href "" "omnipy.shared.protocols.compute.job.IsFuncArgJob"
              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlow href "" "omnipy.shared.protocols.compute.job.IsFlow"

Protocol for callable-backed applied flows.

Subclassed by:

Reference Code reference
- omnipy FuncFlow
- omnipy compute flow
  - FuncFlow
  - FuncFlowTemplateCore

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`flow_context`	Return a context manager that enters and exits the shared flow context. TYPE: `IsNestedContext`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`time_of_last_run`	Return the timestamp captured for the most recent top-level flow run. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. 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]):
    """Protocol for callable-backed applied flows."""

    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

flow_context `property`

flow_context: IsNestedContext

Return a context manager that enters and exits the shared flow context.

RETURNS	DESCRIPTION
`IsNestedContext`	Context manager that tracks top-level flow execution state. TYPE: `IsNestedContext`

Referenced by:

Reference Code reference omnipy engine run_spec

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

time_of_last_run `property`

time_of_last_run: datetime | None

Return the timestamp captured for the most recent top-level flow run.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp from the latest top-level flow run, or `None` if the flow has not completed one yet.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsFuncFlowTemplate

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsFuncFlowTemplate[IsFuncFlowTemplate]
              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate[IsFuncArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlowTemplate[IsFlowTemplate]

                              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncFlowTemplate
                                omnipy.shared.protocols.compute.job.IsJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                

                omnipy.shared.protocols.compute.job.IsFlowTemplate --> omnipy.shared.protocols.compute.job.IsFuncFlowTemplate
                


              click omnipy.shared.protocols.compute.job.IsFuncFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncFlowTemplate"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsFlowTemplate"

Protocol for callable-backed flow templates.

Returned by:

Reference Code reference omnipy compute flow
- func_flow_template_as_callable_decorator
- to_func_flow_template_init_protocol

Subclassed by:

Reference Code reference
- omnipy FuncFlow
- omnipy compute flow
  - FuncFlow
  - FuncFlowTemplateCore

Used by:

Reference Code reference omnipy compute flow func_flow_template_as_callable_decorator

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`refine`	Return a template with updated callable-configuration settings.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. 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]):
    """Protocol for callable-backed flow templates."""

    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

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

Return a template with updated callable-configuration settings.

PARAMETER	DESCRIPTION
`*args`	Positional constructor overrides for the template. TYPE: `Any` DEFAULT: `()`
`update`	Whether omitted values should be inherited from the current template. TYPE: `bool` DEFAULT: `True`
`name`	Optional replacement display name. TYPE: `str \| None` DEFAULT: `None`
`iterate_over_data_files`	Whether dataset inputs should be processed item-wise. TYPE: `bool` DEFAULT: `False`
`output_dataset_param`	Optional name of an explicit output-dataset parameter. TYPE: `str \| None` DEFAULT: `None`
`output_dataset_cls`	Optional dataset class to use for iterated outputs. TYPE: `type[IsDataset] \| None` DEFAULT: `None`
`auto_async`	Whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool` DEFAULT: `True`
`result_key`	Optional key used to wrap the returned result in a dictionary. TYPE: `str \| None` DEFAULT: `None`
`fixed_params`	Keyword arguments fixed onto every job invocation. TYPE: `Mapping[str, object] \| Iterable[tuple[str, object]] \| None` DEFAULT: `None`
`param_key_map`	Mapping from external keyword names to callable parameter names. TYPE: `Mapping[str, str] \| Iterable[tuple[str, str]] \| None` DEFAULT: `None`
`persist_outputs`	Per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals` DEFAULT: `PersistOutputsOptions.FOLLOW_CONFIG`
`restore_outputs`	Per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals` DEFAULT: `RestoreOutputsOptions.FOLLOW_CONFIG`
`**kwargs`	Additional constructor keyword overrides. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	Refined template instance. TYPE: `_JobTemplateT`

Referenced by:

Reference Code reference omnipy compute
- flow
- task TaskTemplateCore refine

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:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # Return a template with updated callable-configuration settings.
    #
    # Args:
    #     *args: Positional constructor overrides for the template.
    #
    # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
    #
    """Return a template with updated callable-configuration settings.

    Args:
        *args: Positional constructor overrides for the template.

        update: Whether omitted values should be inherited from the current template.
        name: Optional replacement display name.
        iterate_over_data_files: Whether dataset inputs should be processed item-wise.
        output_dataset_param: Optional name of an explicit output-dataset parameter.
        output_dataset_cls: Optional dataset class to use for iterated outputs.
        auto_async: Whether coroutine jobs should auto-run outside flow contexts.
        result_key: Optional key used to wrap the returned result in a dictionary.
        fixed_params: Keyword arguments fixed onto every job invocation.
        param_key_map: Mapping from external keyword names to callable parameter names.
        persist_outputs: Per-job output-persistence preference.
        restore_outputs: Per-job output-restore preference.
        **kwargs: Additional constructor keyword overrides.

    Returns:
        _JobTemplateT: Refined template instance.

    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

IsJob

Bases: IsJobBaseCallable[_JobTemplateT, _JobT, _CallP, _RetCovT], Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]

                              omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                




              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"

Protocol for an applied job that is ready to execute.

Applied jobs carry runtime state such as engine decoration and flow-run timing, and they can be revised back into templates when needed.

Subclassed by:

Reference Code reference omnipy shared protocols compute job IsFuncArgJob

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`

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

@runtime_checkable
class IsJob(IsJobBaseCallable[_JobTemplateT, _JobT, _CallP, _RetCovT],
            Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """Protocol for an applied job that is ready to execute.

    Applied jobs carry runtime state such as engine decoration and flow-run
    timing, and they can be revised back into templates when needed.
    """
    @property
    def time_of_cur_toplevel_flow_run(self) -> datetime | None:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOB_TIME_OF_CUR_TOPLEVEL_FLOW_RUN_SUMMARY}}
        #
        # {{ISJOB_TIME_OF_CUR_TOPLEVEL_FLOW_RUN_DETAILS}}
        """Return the start time of the active top-level flow run, if any.

        Returns:
            datetime | None: Timestamp for the current outermost flow run, or ``None``.
        """
        ...

    @classmethod
    def create_job(cls, *args: object, **kwargs: object) -> _JobT:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOB_CREATE_JOB_SUMMARY}}
        #
        # {{ISJOB_CREATE_JOB_DETAILS}}
        """Create an applied job instance from the concrete job class.

        Args:
            *args: Positional constructor arguments.
            **kwargs: Keyword constructor arguments.

        Returns:
            _JobT: New applied job instance.
        """
        ...

    def revise(self) -> _JobTemplateT:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOB_REVISE_SUMMARY}}
        #
        # {{ISJOB_REVISE_DETAILS}}
        """Return a template reconstructed from this applied job.

        Returns:
            _JobTemplateT: Template carrying the current job configuration.
        """
        ...

    def _apply_engine_decorator(self, engine: IsEngine) -> None:
        ...

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsJobBase

Bases: CanLog, IsUniquelyNamedJob, Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]

                              omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                


              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"

Common protocol shared by job templates and applied jobs.

Implementations expose stable naming, logging, configuration, and the lifecycle hooks used to move between template, applied-job, and run states.

Subclassed by:

Reference Code reference omnipy shared protocols compute job IsJobBaseCallable

METHOD	DESCRIPTION
`__init__`
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.

ATTRIBUTE	DESCRIPTION
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`

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

class IsJobBase(CanLog, IsUniquelyNamedJob, Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """Common protocol shared by job templates and applied jobs.

    Implementations expose stable naming, logging, configuration, and the
    lifecycle hooks used to move between template, applied-job, and run states.
    """
    @property
    def _job_creator(self) -> IsJobCreator:
        ...

    @property
    def config(self) -> IsJobConfig:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOBBASE_CONFIG_SUMMARY}}
        #
        # {{ISJOBBASE_CONFIG_DETAILS}}
        """Return the job configuration visible to this instance.

        Returns:
            IsJobConfig: Active job configuration used for runtime behavior.
        """
        ...

    @property
    def engine(self) -> IsEngine | None:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOBBASE_ENGINE_SUMMARY}}
        #
        # {{ISJOBBASE_ENGINE_DETAILS}}
        """Return the engine associated with this job, if any.

        Returns:
            IsEngine | None: Engine used for decoration and execution, or ``None``.
        """
        ...

    @property
    def in_flow_context(self) -> bool:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOBBASE_IN_FLOW_CONTEXT_SUMMARY}}
        #
        # {{ISJOBBASE_IN_FLOW_CONTEXT_DETAILS}}
        """Return whether the job is currently executing inside a flow context.

        Returns:
            bool: ``True`` when a surrounding flow context is active.
        """
        ...

    def __eq__(self, other: object) -> bool:
        ...

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

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

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

    def _refine(self, *args: Any, update: bool = True, **kwargs: object) -> _JobTemplateT:
        ...

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

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

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

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

init

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

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

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

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

IsJobBaseCallable

Bases: IsJobBase[_JobTemplateT, _JobT, _CallP, _RetCovT], Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]

                              omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"

Protocol for job objects that expose a normal callable interface.

Templates and applied jobs both satisfy this contract, but they may route calls differently depending on whether they are inside a flow context.

Subclassed by:

Reference Code reference omnipy shared protocols compute job
- IsJob
- IsJobTemplate

METHOD	DESCRIPTION
`__init__`
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.

ATTRIBUTE	DESCRIPTION
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`

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

class IsJobBaseCallable(IsJobBase[_JobTemplateT, _JobT, _CallP, _RetCovT],
                        Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """Protocol for job objects that expose a normal callable interface.

    Templates and applied jobs both satisfy this contract, but they may route
    calls differently depending on whether they are inside a flow context.
    """
    def __call__(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
        ...

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

init

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

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

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

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

IsJobTemplate

Bases: IsJobBaseCallable[_JobTemplateT, _JobT, _CallP, _RetCovT], Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]


              flowchart BT
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]

                              omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                




              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"

Protocol for a reusable job template with immutable configuration.

Templates can be created, refined, applied to produce runnable jobs, or run directly through the apply-and-execute convenience path.

Subclassed by:

Reference Code reference omnipy shared protocols compute job IsFuncArgJobTemplate

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`

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

@runtime_checkable
class IsJobTemplate(IsJobBaseCallable[_JobTemplateT, _JobT, _CallP, _RetCovT],
                    Protocol[_JobTemplateT, _JobT, _CallP, _RetCovT]):
    """Protocol for a reusable job template with immutable configuration.

    Templates can be created, refined, applied to produce runnable jobs, or run
    directly through the apply-and-execute convenience path.
    """
    @classmethod
    def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
        #
        # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
        """Create a job template instance from the concrete template class.

        Args:
            *args: Positional constructor arguments.
            **kwargs: Keyword constructor arguments.

        Returns:
            _JobTemplateT: New job template instance.
        """
        ...

    def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOBTEMPLATE_RUN_SUMMARY}}
        #
        # {{ISJOBTEMPLATE_RUN_DETAILS}}
        """Apply the template and execute the resulting job immediately.

        Args:
            *args: Positional arguments passed to the applied job.
            **kwargs: Keyword arguments passed to the applied job.

        Returns:
            _RetCovT: Result returned by the applied job.
        """
        ...

    def apply(self) -> _JobT:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
        #
        # {{ISJOBTEMPLATE_APPLY_DETAILS}}
        """Create an applied job from this template without executing it.

        Returns:
            _JobT: Applied job instance ready to be called.
        """
        ...

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

IsLinearFlow

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsLinearFlow[IsLinearFlow]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJob[IsChildJobListArgJob]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase[IsChildJobListArgJobBase]
              omnipy.shared.protocols.compute.job.IsFuncArgJob[IsFuncArgJob]
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlow[IsFlow]

                              omnipy.shared.protocols.compute.job.IsChildJobListArgJob --> omnipy.shared.protocols.compute.job.IsLinearFlow
                                omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJob
                                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase
                

                omnipy.shared.protocols.compute.job.IsFuncArgJob --> omnipy.shared.protocols.compute.job.IsChildJobListArgJob
                                omnipy.shared.protocols.compute.job.IsJob --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                


                omnipy.shared.protocols.compute.job.IsFlow --> omnipy.shared.protocols.compute.job.IsLinearFlow
                


              click omnipy.shared.protocols.compute.job.IsLinearFlow href "" "omnipy.shared.protocols.compute.job.IsLinearFlow"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJob href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJob"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFuncArgJob href "" "omnipy.shared.protocols.compute.job.IsFuncArgJob"
              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlow href "" "omnipy.shared.protocols.compute.job.IsFlow"

Protocol for applied linear flows.

Subclassed by:

Reference Code reference
- omnipy LinearFlow
- omnipy compute flow
  - LinearFlow
  - LinearFlowTemplateCore

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`child_job_templates`	Return the child-job templates owned by the flow template. TYPE: `tuple[IsFuncArgJobTemplate, ...]`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`flow_context`	Return a context manager that enters and exits the shared flow context. TYPE: `IsNestedContext`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`time_of_last_run`	Return the timestamp captured for the most recent top-level flow run. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsLinearFlow(IsChildJobListArgJob['IsLinearFlowTemplate[_CallP, _RetCovT]',
                                        'IsLinearFlow[_CallP, _RetCovT]',
                                        _CallP,
                                        _RetCovT],
                   IsFlow,
                   Protocol[_CallP, _RetCovT]):
    """Protocol for applied linear flows."""

    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

child_job_templates `property`

child_job_templates: tuple[IsFuncArgJobTemplate, ...]

Return the child-job templates owned by the flow template.

RETURNS	DESCRIPTION
`tuple[IsFuncArgJobTemplate, ...]`	tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

flow_context `property`

flow_context: IsNestedContext

Return a context manager that enters and exits the shared flow context.

RETURNS	DESCRIPTION
`IsNestedContext`	Context manager that tracks top-level flow execution state. TYPE: `IsNestedContext`

Referenced by:

Reference Code reference omnipy engine run_spec

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

time_of_last_run `property`

time_of_last_run: datetime | None

Return the timestamp captured for the most recent top-level flow run.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp from the latest top-level flow run, or `None` if the flow has not completed one yet.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsLinearFlowTemplate

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsLinearFlowTemplate[IsLinearFlowTemplate]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate[IsChildJobListArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate[IsFuncArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase[IsChildJobListArgJobBase]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]
              omnipy.shared.protocols.compute.job.IsFlowTemplate[IsFlowTemplate]

                              omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate --> omnipy.shared.protocols.compute.job.IsLinearFlowTemplate
                                omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                

                omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase
                


                omnipy.shared.protocols.compute.job.IsFlowTemplate --> omnipy.shared.protocols.compute.job.IsLinearFlowTemplate
                


              click omnipy.shared.protocols.compute.job.IsLinearFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsLinearFlowTemplate"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase href "" "omnipy.shared.protocols.compute.job.IsChildJobListArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"
              click omnipy.shared.protocols.compute.job.IsFlowTemplate href "" "omnipy.shared.protocols.compute.job.IsFlowTemplate"

Protocol for linear flow templates.

Returned by:

Reference Code reference omnipy compute flow
- linear_flow_template_as_callable_decorator
- to_linear_flow_template_init_protocol

Subclassed by:

Reference Code reference
- omnipy LinearFlow
- omnipy compute flow
  - LinearFlow
  - LinearFlowTemplateCore

Used by:

Reference Code reference omnipy compute flow linear_flow_template_as_callable_decorator

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`refine`	Return a flow template with updated child jobs or callable configuration.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`child_job_templates`	Return the child-job templates owned by the flow template. TYPE: `tuple[IsFuncArgJobTemplate, ...]`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. TYPE: `RestoreOutputsOptions.Literals`

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

class IsLinearFlowTemplate(IsChildJobListArgJobTemplate['IsLinearFlowTemplate[_CallP, _RetCovT]',
                                                        'IsLinearFlow[_CallP, _RetCovT]',
                                                        _CallP,
                                                        _RetCovT],
                           IsFlowTemplate,
                           Protocol[_CallP, _RetCovT]):
    """Protocol for linear flow templates."""

    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

child_job_templates `property`

child_job_templates: tuple[IsFuncArgJobTemplate, ...]

Return the child-job templates owned by the flow template.

RETURNS	DESCRIPTION
`tuple[IsFuncArgJobTemplate, ...]`	tuple[IsFuncArgJobTemplate, ...]: Ordered child-job templates.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

refine

refine(
    *child_job_templates: IsFuncArgJobTemplate,
    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

Return a flow template with updated child jobs or callable configuration.

PARAMETER	DESCRIPTION
`*child_job_templates`	Replacement ordered child-job templates. TYPE: `IsFuncArgJobTemplate` DEFAULT: `()`
`update`	Whether omitted values should be inherited from the current template. TYPE: `bool` DEFAULT: `True`
`name`	Optional replacement display name. TYPE: `str \| None` DEFAULT: `None`
`iterate_over_data_files`	Whether dataset inputs should be processed item-wise. TYPE: `bool` DEFAULT: `False`
`output_dataset_param`	Optional name of an explicit output-dataset parameter. TYPE: `str \| None` DEFAULT: `None`
`output_dataset_cls`	Optional dataset class to use for iterated outputs. TYPE: `type[IsDataset] \| None` DEFAULT: `None`
`auto_async`	Whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool` DEFAULT: `True`
`result_key`	Optional key used to wrap the returned result in a dictionary. TYPE: `str \| None` DEFAULT: `None`
`fixed_params`	Keyword arguments fixed onto every job invocation. TYPE: `Mapping[str, object] \| Iterable[tuple[str, object]] \| None` DEFAULT: `None`
`param_key_map`	Mapping from external keyword names to callable parameter names. TYPE: `Mapping[str, str] \| Iterable[tuple[str, str]] \| None` DEFAULT: `None`
`persist_outputs`	Per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals` DEFAULT: `PersistOutputsOptions.FOLLOW_CONFIG`
`restore_outputs`	Per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals` DEFAULT: `RestoreOutputsOptions.FOLLOW_CONFIG`
`**kwargs`	Additional constructor keyword overrides. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	Refined template instance. TYPE: `_JobTemplateT`

Referenced by:

Reference Code reference omnipy compute
- flow
- task TaskTemplateCore refine

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

def refine(
        self,
        *child_job_templates: IsFuncArgJobTemplate,
        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:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # Return a flow template with updated child jobs or callable configuration.
    #
    # Args:
    #     *child_job_templates: Replacement ordered child-job templates.
    #
    # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
    #
    """Return a flow template with updated child jobs or callable configuration.

    Args:
        *child_job_templates: Replacement ordered child-job templates.

        update: Whether omitted values should be inherited from the current template.
        name: Optional replacement display name.
        iterate_over_data_files: Whether dataset inputs should be processed item-wise.
        output_dataset_param: Optional name of an explicit output-dataset parameter.
        output_dataset_cls: Optional dataset class to use for iterated outputs.
        auto_async: Whether coroutine jobs should auto-run outside flow contexts.
        result_key: Optional key used to wrap the returned result in a dictionary.
        fixed_params: Keyword arguments fixed onto every job invocation.
        param_key_map: Mapping from external keyword names to callable parameter names.
        persist_outputs: Per-job output-persistence preference.
        restore_outputs: Per-job output-restore preference.
        **kwargs: Additional constructor keyword overrides.

    Returns:
        _JobTemplateT: Refined template instance.

    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

IsPlainFuncArgJobBase

Bases: Protocol


              flowchart BT
              omnipy.shared.protocols.compute.job.IsPlainFuncArgJobBase[IsPlainFuncArgJobBase]

              

              click omnipy.shared.protocols.compute.job.IsPlainFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsPlainFuncArgJobBase"

Minimal protocol for objects that store and decorate a wrapped callable.

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

class IsPlainFuncArgJobBase(Protocol):
    """Minimal protocol for objects that store and decorate a wrapped callable."""

    _job_func: Callable

    def _accept_call_func_decorator(self, call_func_decorator: GeneralDecorator) -> None:
        ...

IsTask

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsTask[IsTask]
              omnipy.shared.protocols.compute.job.IsFuncArgJob[IsFuncArgJob]
              omnipy.shared.protocols.compute.job.IsJob[IsJob]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

                              omnipy.shared.protocols.compute.job.IsFuncArgJob --> omnipy.shared.protocols.compute.job.IsTask
                                omnipy.shared.protocols.compute.job.IsJob --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJob
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJob
                



              click omnipy.shared.protocols.compute.job.IsTask href "" "omnipy.shared.protocols.compute.job.IsTask"
              click omnipy.shared.protocols.compute.job.IsFuncArgJob href "" "omnipy.shared.protocols.compute.job.IsFuncArgJob"
              click omnipy.shared.protocols.compute.job.IsJob href "" "omnipy.shared.protocols.compute.job.IsJob"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

Protocol for an applied Omnipy task.

A task represents one runnable callable-backed compute step with no owned child job templates.

Subclassed by:

Reference Code reference
- omnipy Task
- omnipy compute task
  - Task
  - TaskTemplateCore

METHOD	DESCRIPTION
`__init__`
`create_job`	Create an applied job instance from the concrete job class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`revise`	Return a template reconstructed from this applied job.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`time_of_cur_toplevel_flow_run`	Return the start time of the active top-level flow run, if any. TYPE: `datetime \| None`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. 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]):
    """Protocol for an applied Omnipy task.

    A task represents one runnable callable-backed compute step with no owned
    child job templates.
    """

    ...

auto_async `property`

auto_async: bool

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

time_of_cur_toplevel_flow_run `property`

time_of_cur_toplevel_flow_run: datetime | None

Return the start time of the active top-level flow run, if any.

RETURNS	DESCRIPTION
`datetime \| None`	datetime \| None: Timestamp for the current outermost flow run, or `None`.

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

create_job `classmethod`

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

Create an applied job instance from the concrete job class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobT`	New applied job instance. TYPE: `_JobT`

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

@classmethod
def create_job(cls, *args: object, **kwargs: object) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_CREATE_JOB_SUMMARY}}
    #
    # {{ISJOB_CREATE_JOB_DETAILS}}
    """Create an applied job instance from the concrete job class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobT: New applied job instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

revise

revise() -> _JobTemplateT

Return a template reconstructed from this applied job.

RETURNS	DESCRIPTION
`_JobTemplateT`	Template carrying the current job configuration. TYPE: `_JobTemplateT`

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

def revise(self) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOB_REVISE_SUMMARY}}
    #
    # {{ISJOB_REVISE_DETAILS}}
    """Return a template reconstructed from this applied job.

    Returns:
        _JobTemplateT: Template carrying the current job configuration.
    """
    ...

IsTaskTemplate

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


              flowchart BT
              omnipy.shared.protocols.compute.job.IsTaskTemplate[IsTaskTemplate]
              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate[IsFuncArgJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobTemplate[IsJobTemplate]
              omnipy.shared.protocols.compute.job.IsJobBaseCallable[IsJobBaseCallable]
              omnipy.shared.protocols.compute.job.IsJobBase[IsJobBase]
              omnipy.shared.protocols.hub.log.CanLog[CanLog]
              omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob[IsUniquelyNamedJob]
              omnipy.shared.protocols.compute.job.IsFuncArgJobBase[IsFuncArgJobBase]

                              omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate --> omnipy.shared.protocols.compute.job.IsTaskTemplate
                                omnipy.shared.protocols.compute.job.IsJobTemplate --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBaseCallable --> omnipy.shared.protocols.compute.job.IsJobTemplate
                                omnipy.shared.protocols.compute.job.IsJobBase --> omnipy.shared.protocols.compute.job.IsJobBaseCallable
                                omnipy.shared.protocols.hub.log.CanLog --> omnipy.shared.protocols.compute.job.IsJobBase
                
                omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob --> omnipy.shared.protocols.compute.job.IsJobBase
                



                omnipy.shared.protocols.compute.job.IsFuncArgJobBase --> omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate
                



              click omnipy.shared.protocols.compute.job.IsTaskTemplate href "" "omnipy.shared.protocols.compute.job.IsTaskTemplate"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobTemplate href "" "omnipy.shared.protocols.compute.job.IsJobTemplate"
              click omnipy.shared.protocols.compute.job.IsJobBaseCallable href "" "omnipy.shared.protocols.compute.job.IsJobBaseCallable"
              click omnipy.shared.protocols.compute.job.IsJobBase href "" "omnipy.shared.protocols.compute.job.IsJobBase"
              click omnipy.shared.protocols.hub.log.CanLog href "" "omnipy.shared.protocols.hub.log.CanLog"
              click omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob href "" "omnipy.shared.protocols.compute.mixins.IsUniquelyNamedJob"
              click omnipy.shared.protocols.compute.job.IsFuncArgJobBase href "" "omnipy.shared.protocols.compute.job.IsFuncArgJobBase"

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

Returned by:

Reference Code reference omnipy compute task
- task_template_as_callable_decorator
- to_task_template_init_protocol

Subclassed by:

Reference Code reference
- omnipy Task
- omnipy compute task
  - Task
  - TaskTemplateCore

Used by:

Reference Code reference omnipy compute task task_template_as_callable_decorator

METHOD	DESCRIPTION
`__init__`
`apply`	Create an applied job from this template without executing it.
`create_job_template`	Create a job template instance from the concrete template class.
`get_bound_args`	Bind arguments to the job callable signature.
`log`	Emit a log message, optionally using an explicit event timestamp.
`refine`	Return a template with updated callable-configuration settings.
`regenerate_unique_name`	Regenerate the unique job name from the current base name.
`run`	Apply the template and execute the resulting job immediately.

ATTRIBUTE	DESCRIPTION
`auto_async`	Return whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool`
`callable_type`	The effective callable type of the job function. TYPE: `CallableType.Literals`
`config`	Return the job configuration visible to this instance. TYPE: `IsJobConfig`
`engine`	Return the engine associated with this job, if any. TYPE: `IsEngine \| None`
`fixed_params`	Return parameters that are always supplied when the job callable runs. TYPE: `MappingProxyType[str, object]`
`in_flow_context`	Return whether the job is currently executing inside a flow context. TYPE: `bool`
`iterate_over_data_files`	Return whether the job should iterate over dataset items automatically. TYPE: `bool`
`logger`	Return the logger bound to the concrete instance type. TYPE: `Logger`
`name`	Return the configured base name for the job. TYPE: `str`
`output_dataset_cls`	Return the dataset class used for iterated outputs, if configured. TYPE: `type[IsDataset] \| None`
`output_dataset_param`	Return the parameter name used for an explicit output dataset, if any. TYPE: `str \| None`
`output_storage_protocol`	Return the configured output-storage protocol preference. TYPE: `OutputStorageProtocolOptions.Literals`
`output_storage_protocol_to_use`	Return the resolved storage protocol used for persisted outputs. TYPE: `OutputStorageProtocolOptions.Literals`
`param_key_map`	Return keyword-name remappings applied before calling the job callable. TYPE: `MappingProxyType[str, str]`
`param_signatures`	Return the inspected parameter signature of the job callable. TYPE: `MappingProxyType[str, inspect.Parameter]`
`persist_outputs`	Return the configured per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals`
`restore_outputs`	Return the configured per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals`
`result_key`	Return the dictionary key used to wrap results, if configured. TYPE: `str \| None`
`return_type`	Return the annotated return type of the job callable. TYPE: `type`
`unique_name`	Return the generated unique name used to identify the job instance. TYPE: `str`
`unique_run_slug`	Return the run-specific slug generated for this job instance. TYPE: `str`
`will_persist_outputs`	Return the resolved output-persistence behavior for this run. TYPE: `PersistOutputsOptions.Literals`
`will_restore_outputs`	Return the resolved output-restore behavior for this run. 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

Return whether coroutine jobs should auto-run outside flow contexts.

RETURNS	DESCRIPTION
`bool`	`True` when coroutine jobs are automatically awaited or scheduled. TYPE: `bool`

callable_type `property`

callable_type: CallableType.Literals

The effective callable type of the job function.

The callable type captures both the synchronous/asynchronous and plain/generator dimensions of the wrapped callable.

RETURNS	DESCRIPTION
`CallableType.Literals`	CallableType.Literals: The effective callable type of the job function.

Referenced by:

Reference Code reference omnipy engine run_spec

config `property`

config: IsJobConfig

Return the job configuration visible to this instance.

RETURNS	DESCRIPTION
`IsJobConfig`	Active job configuration used for runtime behavior. TYPE: `IsJobConfig`

engine `property`

engine: IsEngine | None

Return the engine associated with this job, if any.

RETURNS	DESCRIPTION
`IsEngine \| None`	IsEngine \| None: Engine used for decoration and execution, or `None`.

fixed_params `property`

fixed_params: MappingProxyType[str, object]

Return parameters that are always supplied when the job callable runs.

RETURNS	DESCRIPTION
`MappingProxyType[str, object]`	MappingProxyType[str, object]: Read-only mapping of fixed keyword values.

in_flow_context `property`

in_flow_context: bool

Return whether the job is currently executing inside a flow context.

RETURNS	DESCRIPTION
`bool`	`True` when a surrounding flow context is active. TYPE: `bool`

Referenced by:

Reference Code reference omnipy engine run_spec TaskRunSpec in_flow_context

iterate_over_data_files `property`

iterate_over_data_files: bool

Return whether the job should iterate over dataset items automatically.

RETURNS	DESCRIPTION
`bool`	`True` when the first dataset argument is expanded item-by-item. TYPE: `bool`

logger `property`

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
`Logger`	Logger used by the object for Omnipy log messages. TYPE: `Logger`

name `property`

name: str

Return the configured base name for the job.

RETURNS	DESCRIPTION
`str`	Human-readable name used as the basis for display and registration. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

output_dataset_cls `property`

output_dataset_cls: type[IsDataset] | None

Return the dataset class used for iterated outputs, if configured.

RETURNS	DESCRIPTION
`type[IsDataset] \| None`	type[IsDataset] \| None: Output dataset type, or `None` when inferred.

output_dataset_param `property`

output_dataset_param: str | None

Return the parameter name used for an explicit output dataset, if any.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Output-dataset parameter name, or `None` when not configured.

output_storage_protocol `property`

output_storage_protocol: OutputStorageProtocolOptions.Literals

Return the configured output-storage protocol preference.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Storage-protocol setting before config fallback.

output_storage_protocol_to_use `property`

output_storage_protocol_to_use: OutputStorageProtocolOptions.Literals

Return the resolved storage protocol used for persisted outputs.

RETURNS	DESCRIPTION
`OutputStorageProtocolOptions.Literals`	OutputStorageProtocolOptions.Literals: Effective storage protocol for this run.

param_key_map `property`

param_key_map: MappingProxyType[str, str]

Return keyword-name remappings applied before calling the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, str]`	MappingProxyType[str, str]: Mapping from external keyword names to callable parameter names.

param_signatures `property`

param_signatures: MappingProxyType[str, inspect.Parameter]

Return the inspected parameter signature of the job callable.

RETURNS	DESCRIPTION
`MappingProxyType[str, inspect.Parameter]`	MappingProxyType[str, inspect.Parameter]: Mapping from parameter names to signature entries.

Referenced by:

Reference Code reference omnipy engine run_spec

persist_outputs `property`

persist_outputs: PersistOutputsOptions.Literals

Return the configured per-job output-persistence preference.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Persistence setting before config fallback.

restore_outputs `property`

restore_outputs: RestoreOutputsOptions.Literals

Return the configured per-job output-restore preference.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Restore setting before config fallback.

result_key `property`

result_key: str | None

Return the dictionary key used to wrap results, if configured.

RETURNS	DESCRIPTION
`str \| None`	str \| None: Result wrapper key, or `None` when results are returned raw.

return_type `property`

return_type: type

Return the annotated return type of the job callable.

RETURNS	DESCRIPTION
`type`	Return annotation for the callable. TYPE: `type`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_name `property`

unique_name: str

Return the generated unique name used to identify the job instance.

RETURNS	DESCRIPTION
`str`	Unique job identifier suitable for registry lookups and logging. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

unique_run_slug `property`

unique_run_slug: str

Return the run-specific slug generated for this job instance.

RETURNS	DESCRIPTION
`str`	Short slug used in per-run names and identifiers. TYPE: `str`

Referenced by:

Reference Code reference omnipy engine run_spec

will_persist_outputs `property`

will_persist_outputs: PersistOutputsOptions.Literals

Return the resolved output-persistence behavior for this run.

RETURNS	DESCRIPTION
`PersistOutputsOptions.Literals`	PersistOutputsOptions.Literals: Effective persistence behavior after applying config-following rules.

will_restore_outputs `property`

will_restore_outputs: RestoreOutputsOptions.Literals

Return the resolved output-restore behavior for this run.

RETURNS	DESCRIPTION
`RestoreOutputsOptions.Literals`	RestoreOutputsOptions.Literals: Effective restore behavior after applying config-following rules.

init

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

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

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

apply

apply() -> _JobT

Create an applied job from this template without executing it.

RETURNS	DESCRIPTION
`_JobT`	Applied job instance ready to be called. TYPE: `_JobT`

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

def apply(self) -> _JobT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_APPLY_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_APPLY_DETAILS}}
    """Create an applied job from this template without executing it.

    Returns:
        _JobT: Applied job instance ready to be called.
    """
    ...

create_job_template `classmethod`

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

Create a job template instance from the concrete template class.

PARAMETER	DESCRIPTION
`*args`	Positional constructor arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword constructor arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	New job template instance. TYPE: `_JobTemplateT`

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

@classmethod
def create_job_template(cls, *args: object, **kwargs: object) -> _JobTemplateT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_CREATE_JOB_TEMPLATE_DETAILS}}
    """Create a job template instance from the concrete template class.

    Args:
        *args: Positional constructor arguments.
        **kwargs: Keyword constructor arguments.

    Returns:
        _JobTemplateT: New job template instance.
    """
    ...

get_bound_args

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

Bind arguments to the job callable signature.

PARAMETER	DESCRIPTION
`*args`	Positional call arguments. TYPE: `object` DEFAULT: `()`
`**kwargs`	Keyword call arguments. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`inspect.BoundArguments`	inspect.BoundArguments: Bound arguments with defaults applied.

Referenced by:

Reference Code reference omnipy engine run_spec

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

def get_bound_args(self, *args: object, **kwargs: object) -> inspect.BoundArguments:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_SUMMARY}}
    #
    # {{ISFUNCARGJOBBASE_GET_BOUND_ARGS_DETAILS}}
    """Bind arguments to the job callable signature.

    Args:
        *args: Positional call arguments.
        **kwargs: Keyword call arguments.

    Returns:
        inspect.BoundArguments: Bound arguments with defaults applied.
    """
    ...

log

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

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
`log_msg`	Message text to send to the logger. TYPE: `str`
`level`	Standard library logging level. TYPE: `int` DEFAULT: `INFO`
`datetime_obj`	Timestamp to attach to the record instead of wall-clock time. TYPE: `datetime \| None` DEFAULT: `None`

Referenced by:

Reference Code reference omnipy engine run_spec

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

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    ...

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

Return a template with updated callable-configuration settings.

PARAMETER	DESCRIPTION
`*args`	Positional constructor overrides for the template. TYPE: `Any` DEFAULT: `()`
`update`	Whether omitted values should be inherited from the current template. TYPE: `bool` DEFAULT: `True`
`name`	Optional replacement display name. TYPE: `str \| None` DEFAULT: `None`
`iterate_over_data_files`	Whether dataset inputs should be processed item-wise. TYPE: `bool` DEFAULT: `False`
`output_dataset_param`	Optional name of an explicit output-dataset parameter. TYPE: `str \| None` DEFAULT: `None`
`output_dataset_cls`	Optional dataset class to use for iterated outputs. TYPE: `type[IsDataset] \| None` DEFAULT: `None`
`auto_async`	Whether coroutine jobs should auto-run outside flow contexts. TYPE: `bool` DEFAULT: `True`
`result_key`	Optional key used to wrap the returned result in a dictionary. TYPE: `str \| None` DEFAULT: `None`
`fixed_params`	Keyword arguments fixed onto every job invocation. TYPE: `Mapping[str, object] \| Iterable[tuple[str, object]] \| None` DEFAULT: `None`
`param_key_map`	Mapping from external keyword names to callable parameter names. TYPE: `Mapping[str, str] \| Iterable[tuple[str, str]] \| None` DEFAULT: `None`
`persist_outputs`	Per-job output-persistence preference. TYPE: `PersistOutputsOptions.Literals` DEFAULT: `PersistOutputsOptions.FOLLOW_CONFIG`
`restore_outputs`	Per-job output-restore preference. TYPE: `RestoreOutputsOptions.Literals` DEFAULT: `RestoreOutputsOptions.FOLLOW_CONFIG`
`**kwargs`	Additional constructor keyword overrides. TYPE: `object` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_JobTemplateT`	Refined template instance. TYPE: `_JobTemplateT`

Referenced by:

Reference Code reference omnipy compute
- flow
- task TaskTemplateCore refine

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:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # Return a template with updated callable-configuration settings.
    #
    # Args:
    #     *args: Positional constructor overrides for the template.
    #
    # {{JOB_TEMPLATE_REFINE_COMMON_ARGS}}
    #
    """Return a template with updated callable-configuration settings.

    Args:
        *args: Positional constructor overrides for the template.

        update: Whether omitted values should be inherited from the current template.
        name: Optional replacement display name.
        iterate_over_data_files: Whether dataset inputs should be processed item-wise.
        output_dataset_param: Optional name of an explicit output-dataset parameter.
        output_dataset_cls: Optional dataset class to use for iterated outputs.
        auto_async: Whether coroutine jobs should auto-run outside flow contexts.
        result_key: Optional key used to wrap the returned result in a dictionary.
        fixed_params: Keyword arguments fixed onto every job invocation.
        param_key_map: Mapping from external keyword names to callable parameter names.
        persist_outputs: Per-job output-persistence preference.
        restore_outputs: Per-job output-restore preference.
        **kwargs: Additional constructor keyword overrides.

    Returns:
        _JobTemplateT: Refined template instance.

    """
    ...

regenerate_unique_name

regenerate_unique_name() -> None

Regenerate the unique job name from the current base name.

Updates the stored unique identifier so later registry entries and log messages use a fresh value.

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

def regenerate_unique_name(self) -> None:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_SUMMARY}}
    #
    # {{ISUNIQUELYNAMEDJOB_REGENERATE_UNIQUE_NAME_DETAILS}}
    """Regenerate the unique job name from the current base name.

    Updates the stored unique identifier so later registry entries and log messages use a
    fresh value.
    """
    ...

run

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

Apply the template and execute the resulting job immediately.

PARAMETER	DESCRIPTION
`*args`	Positional arguments passed to the applied job. TYPE: `_CallP.args` DEFAULT: `()`
`**kwargs`	Keyword arguments passed to the applied job. TYPE: `_CallP.kwargs` DEFAULT: `{}`

RETURNS	DESCRIPTION
`_RetCovT`	Result returned by the applied job. TYPE: `_RetCovT`

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

def run(self, *args: _CallP.args, **kwargs: _CallP.kwargs) -> _RetCovT:
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{ISJOBTEMPLATE_RUN_SUMMARY}}
    #
    # {{ISJOBTEMPLATE_RUN_DETAILS}}
    """Apply the template and execute the resulting job immediately.

    Args:
        *args: Positional arguments passed to the applied job.
        **kwargs: Keyword arguments passed to the applied job.

    Returns:
        _RetCovT: Result returned by the applied job.
    """
    ...

omnipy.shared.protocols.compute.job

HasChildJobListArgJobTemplateInit

HasFuncArgJobTemplateInit

HasJobCreator

job_creator property

IsAnyFlow

auto_async property

callable_type property

config property

engine property

fixed_params property

flow_context property

in_flow_context property

iterate_over_data_files property

logger property

name property

output_dataset_cls property

output_dataset_param property

output_storage_protocol property

output_storage_protocol_to_use property

param_key_map property

param_signatures property

persist_outputs property

restore_outputs property

result_key property

return_type property

time_of_cur_toplevel_flow_run property

time_of_last_run property

unique_name property

unique_run_slug property

will_persist_outputs property

will_restore_outputs property

__init__

create_job classmethod

get_bound_args

log

regenerate_unique_name

revise

IsAnyFlowTemplate

auto_async property

callable_type property

config property

engine property

fixed_params property

in_flow_context property

iterate_over_data_files property

logger property

name property

output_dataset_cls property

output_dataset_param property

output_storage_protocol property

output_storage_protocol_to_use property

param_key_map property

param_signatures property

persist_outputs property

restore_outputs property

result_key property

return_type property

unique_name property

unique_run_slug property

will_persist_outputs property

will_restore_outputs property

__init__

apply

create_job_template classmethod

get_bound_args

log

refine

regenerate_unique_name

run

IsChildJobListArgJob

auto_async property

callable_type property

child_job_templates property

config property

engine property

fixed_params property

in_flow_context property

iterate_over_data_files property

logger property

job_creator `property`

auto_async `property`

callable_type `property`

config `property`

engine `property`

fixed_params `property`

flow_context `property`

in_flow_context `property`

iterate_over_data_files `property`

logger `property`

name `property`

output_dataset_cls `property`

output_dataset_param `property`

output_storage_protocol `property`

output_storage_protocol_to_use `property`

param_key_map `property`

param_signatures `property`

persist_outputs `property`

restore_outputs `property`

result_key `property`

return_type `property`

time_of_cur_toplevel_flow_run `property`

time_of_last_run `property`

unique_name `property`

unique_run_slug `property`

will_persist_outputs `property`

will_restore_outputs `property`

init

create_job `classmethod`

auto_async `property`

callable_type `property`

config `property`

engine `property`

fixed_params `property`

in_flow_context `property`

iterate_over_data_files `property`

logger `property`

name `property`

output_dataset_cls `property`

output_dataset_param `property`

output_storage_protocol `property`

output_storage_protocol_to_use `property`

param_key_map `property`

param_signatures `property`

persist_outputs `property`

restore_outputs `property`

result_key `property`

return_type `property`

unique_name `property`

unique_run_slug `property`

will_persist_outputs `property`

will_restore_outputs `property`

init

create_job_template `classmethod`

auto_async `property`

callable_type `property`

child_job_templates `property`

config `property`

engine `property`

fixed_params `property`

in_flow_context `property`

iterate_over_data_files `property`

logger `property`

name `property`

output_dataset_cls `property`

output_dataset_param `property`

output_storage_protocol `property`

output_storage_protocol_to_use `property`

param_key_map `property`

param_signatures `property`

persist_outputs `property`

restore_outputs `property`

result_key `property`

return_type `property`

time_of_cur_toplevel_flow_run `property`

unique_name `property`

unique_run_slug `property`

will_persist_outputs `property`

will_restore_outputs `property`

init