Module: workflow_phase_task

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.tasks.task import Task
from cl.runtime.workflows.workflow_phase_key import WorkflowPhaseKey


@dataclass(slots=True, kw_only=True)
class WorkflowPhaseTask(Task):
    """Child of the workflow task and parent of tasks assigned to the specified workflow phase."""

    phase: WorkflowPhaseKey = missing()
    """Tasks run in parallel in the order of phases, however each phase waits until its prerequisites are completed."""

    def _execute(self) -> None:
        raise NotImplementedError()

Classes

class WorkflowPhaseTask (*, task_id: str = None, label: str | None = None, queue: TaskQueueKey = None, status: TaskStatusEnum = None, progress_pct: float = None, elapsed_sec: float | None = None, remaining_sec: float | None = None, error_message: str | None = None, phase: WorkflowPhaseKey = None)

Child of the workflow task and parent of tasks assigned to the specified workflow phase.

Expand source code

@dataclass(slots=True, kw_only=True)
class WorkflowPhaseTask(Task):
    """Child of the workflow task and parent of tasks assigned to the specified workflow phase."""

    phase: WorkflowPhaseKey = missing()
    """Tasks run in parallel in the order of phases, however each phase waits until its prerequisites are completed."""

    def _execute(self) -> None:
        raise NotImplementedError()

Ancestors

Task
TaskKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Static methods

def get_key_type() -> Type: Inherited from: Task.get_key_type

Return key type even when called from a record.
def wait_for_completion(task_key: TaskKey, timeout_sec: int = 10) -> None: Inherited from: Task.wait_for_completion

Wait for completion of the specified task run before exiting from this method (not async/await).

Fields

var elapsed_sec -> float | None: Inherited from: Task.elapsed_sec

Elapsed time in seconds if available.
var error_message -> str | None: Inherited from: Task.error_message

Error message for Failed status if available.
var label -> str | None: Inherited from: Task.label

Label for information purposes only (should not be used in processing).
var phase -> WorkflowPhaseKey: Tasks run in parallel in the order of phases, however each phase waits until its prerequisites are completed.
var progress_pct -> float: Inherited from: Task.progress_pct

Task progress in percent from 0 to 100.
var queue -> TaskQueueKey: Inherited from: Task.queue

The queue that will run the task once it is saved.
var remaining_sec -> float | None: Inherited from: Task.remaining_sec

Remaining time in seconds if available.
var status -> TaskStatusEnum: Inherited from: Task.status

Begins from Pending, continues to Running or Paused, and ends with Completed, Failed, or Cancelled.
var task_id -> str: Inherited from: Task.task_id

Unique task identifier.

Methods

def get_key(self) -> TaskKey: Inherited from: Task.get_key

Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None: Inherited from: Task.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.
def run_task(self) -> None: Inherited from: Task.run_task

Invoke execute with task status updates and exception handling.