Module: task_result_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 Any
from typing import Iterable
from typing import List
from typing import cast
from pydantic import BaseModel
from cl.runtime import Context
from cl.runtime.primitive.case_util import CaseUtil
from cl.runtime.routers.tasks.task_result_request import TaskResultRequest
from cl.runtime.tasks.task import Task
from cl.runtime.tasks.task_key import TaskKey


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

    # TODO: Decide on permitted result formats
    result: Any
    """Result of the task run."""

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

    key: str | None
    """Key of the record."""

    class Config:
        alias_generator = CaseUtil.snake_to_pascal_case
        populate_by_name = True

    @classmethod
    def get_task_results(cls, request: TaskResultRequest) -> List[TaskResultResponseItem]:
        """Get results for tasks in request."""

        # Get current context
        context = Context.current()

        task_keys = [TaskKey(task_id=x) for x in request.task_run_ids]
        tasks = cast(Iterable[Task], context.load_many(Task, task_keys))
        context.save_many(tasks)

        response_items = []
        for task in tasks:
            response_items.append(
                TaskResultResponseItem(
                    result=task.status,
                    task_run_id=str(task.task_id),
                    key=str(task.task_id),
                ),
            )

        return response_items

Classes

class TaskResultResponseItem (**data: Any)

Data type for a single item in the response list for the /tasks/run/result 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 TaskResultResponseItem(BaseModel):
    """Data type for a single item in the response list for the /tasks/run/result route."""

    # TODO: Decide on permitted result formats
    result: Any
    """Result of the task run."""

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

    key: str | None
    """Key of the record."""

    class Config:
        alias_generator = CaseUtil.snake_to_pascal_case
        populate_by_name = True

    @classmethod
    def get_task_results(cls, request: TaskResultRequest) -> List[TaskResultResponseItem]:
        """Get results for tasks in request."""

        # Get current context
        context = Context.current()

        task_keys = [TaskKey(task_id=x) for x in request.task_run_ids]
        tasks = cast(Iterable[Task], context.load_many(Task, task_keys))
        context.save_many(tasks)

        response_items = []
        for task in tasks:
            response_items.append(
                TaskResultResponseItem(
                    result=task.status,
                    task_run_id=str(task.task_id),
                    key=str(task.task_id),
                ),
            )

        return response_items

Ancestors

pydantic.main.BaseModel

Class variables

var Config
var key: Key of the record.
var model_computed_fields
var model_config
var model_fields
var result: Result of the task run.
var task_run_id: Task run id.

Static methods

def get_task_results(request: TaskResultRequest) -> List[TaskResultResponseItem]: Get results for tasks in request.