Module: task_status_response_item

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 __future__ import annotations
from typing import Dict
from typing import Iterable
from typing import List
from typing import cast
from pydantic import BaseModel
from cl.runtime import Context
from cl.runtime.log.log_entry import LogEntry
from cl.runtime.log.log_entry_level_enum import LogEntryLevelEnum
from cl.runtime.primitive.case_util import CaseUtil
from cl.runtime.routers.tasks.task_status_request import TaskStatusRequest
from cl.runtime.tasks.task import Task
from cl.runtime.tasks.task_key import TaskKey

LEGACY_TASK_STATUS_NAMES_MAP: Dict[str, str] = {  # TODO: Update UI to sync the status list
    "PENDING": "Submitted",
    "RUNNING": "Running",
    "AWAITING": "Paused",
    "COMPLETED": "Completed",
    "FAILED": "Failed",
    "CANCELLED": "Cancelled",
}
"""Status name to legacy status name map according to UI convention."""


class TaskStatusResponseItem(BaseModel):
    """Data type for a single item in the response list for the /tasks/run/status route."""

    status_code: str
    """Task status code."""

    task_run_id: str
    """Task run unique id."""

    key: str | None  # TODO: Rename to task_id in REST API for clarity
    """Task key."""

    user_message: str | None
    """Optional user message."""

    class Config:
        alias_generator = CaseUtil.snake_to_pascal_case
        populate_by_name = True

    @classmethod
    def get_task_statuses(cls, request: TaskStatusRequest) -> List[TaskStatusResponseItem]:
        """Get status for tasks in request."""

        # Get current context
        context = Context.current()

        task_keys = [TaskKey(task_id=x) for x in request.task_run_ids]  # TODO: Update if task_run_id is UUID
        tasks = cast(Iterable[Task], context.load_many(Task, task_keys))

        response_items = []
        for task in tasks:
            # TODO: Add support message depending on exception type
            user_message = task.error_message

            response_items.append(
                TaskStatusResponseItem(
                    status_code=LEGACY_TASK_STATUS_NAMES_MAP.get(task.status.name),
                    task_run_id=str(task.task_id),
                    key=str(task.task_id),
                    user_message=user_message,
                ),
            )

        return response_items

Global variables

var LEGACY_TASK_STATUS_NAMES_MAP: Status name to legacy status name map according to UI convention.

Classes

class TaskStatusResponseItem (**data: Any)

Data type for a single item in the response list for the /tasks/run/status route.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class TaskStatusResponseItem(BaseModel):
    """Data type for a single item in the response list for the /tasks/run/status route."""

    status_code: str
    """Task status code."""

    task_run_id: str
    """Task run unique id."""

    key: str | None  # TODO: Rename to task_id in REST API for clarity
    """Task key."""

    user_message: str | None
    """Optional user message."""

    class Config:
        alias_generator = CaseUtil.snake_to_pascal_case
        populate_by_name = True

    @classmethod
    def get_task_statuses(cls, request: TaskStatusRequest) -> List[TaskStatusResponseItem]:
        """Get status for tasks in request."""

        # Get current context
        context = Context.current()

        task_keys = [TaskKey(task_id=x) for x in request.task_run_ids]  # TODO: Update if task_run_id is UUID
        tasks = cast(Iterable[Task], context.load_many(Task, task_keys))

        response_items = []
        for task in tasks:
            # TODO: Add support message depending on exception type
            user_message = task.error_message

            response_items.append(
                TaskStatusResponseItem(
                    status_code=LEGACY_TASK_STATUS_NAMES_MAP.get(task.status.name),
                    task_run_id=str(task.task_id),
                    key=str(task.task_id),
                    user_message=user_message,
                ),
            )

        return response_items

Ancestors

pydantic.main.BaseModel

Class variables

var Config
var key: Task key.
var model_computed_fields
var model_config
var model_fields
var status_code: Task status code.
var task_run_id: Task run unique id.
var user_message: Optional user message.

Static methods

def get_task_statuses(request: TaskStatusRequest) -> List[TaskStatusResponseItem]: Get status for tasks in request.