Module: dataset_response

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 List
from pydantic import BaseModel
from cl.runtime.primitive.case_util import CaseUtil
from cl.runtime.routers.user_request import UserRequest


class DatasetResponse(BaseModel):
    """Response data type for the /storage/get_datasets route."""

    name: str | None
    """Name of the dataset."""

    parent: str | None = None
    """Name of the parent dataset."""

    class Config:
        alias_generator = CaseUtil.snake_to_pascal_case
        populate_by_name = True

    @classmethod
    def get_datasets(cls, request: UserRequest) -> List[DatasetResponse]:
        """Implements /storage/get_datasets route."""

        # Default response when running locally without authorization
        result_dict = {
            "name": None,
        }

        return [DatasetResponse(**result_dict)]

Classes

class DatasetResponse (**data: Any)

Response data type for the /storage/get_datasets 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 DatasetResponse(BaseModel):
    """Response data type for the /storage/get_datasets route."""

    name: str | None
    """Name of the dataset."""

    parent: str | None = None
    """Name of the parent dataset."""

    class Config:
        alias_generator = CaseUtil.snake_to_pascal_case
        populate_by_name = True

    @classmethod
    def get_datasets(cls, request: UserRequest) -> List[DatasetResponse]:
        """Implements /storage/get_datasets route."""

        # Default response when running locally without authorization
        result_dict = {
            "name": None,
        }

        return [DatasetResponse(**result_dict)]

Ancestors

pydantic.main.BaseModel

Class variables

var Config
var model_computed_fields
var model_config
var model_fields
var name: Name of the dataset.
var parent: Name of the parent dataset.

Static methods

def get_datasets(request: UserRequest) -> List[DatasetResponse]: Implements /storage/get_datasets route.