Source code for codegrade.models.create_course_data

"""The module that defines the ``CreateCourseData`` model.

SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""

from __future__ import annotations

import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa
from cg_maybe import Maybe, Nothing
from cg_maybe.utils import maybe_from_nullable

from .. import parsers
from ..utils import to_dict
from .course_tier import CourseTier




@dataclass
class CreateCourseData:
    """Input data required for the `Course::Create` operation."""

    #: The name of the new course
    name: str
    #: The id of the tenant for which this course is. If not provided this will
    #: default to your own tenant.
    tenant_id: Maybe[str] = Nothing
    #: The tier of the new course. If not provided this will default to the
    #: tenant's default course tier. Requires the `can_manage_site_settings`
    #: permission.
    tier: Maybe[CourseTier] = Nothing

    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "name",
                rqa.SimpleValue.str,
                doc="The name of the new course",
            ),
            rqa.OptionalArgument(
                "tenant_id",
                rqa.SimpleValue.str,
                doc="The id of the tenant for which this course is. If not provided this will default to your own tenant.",
            ),
            rqa.OptionalArgument(
                "tier",
                rqa.EnumValue(CourseTier),
                doc="The tier of the new course. If not provided this will default to the tenant's default course tier. Requires the `can_manage_site_settings` permission.",
            ),
        ).use_readable_describe(True)
    )

    def __post_init__(self) -> None:
        getattr(super(), "__post_init__", lambda: None)()
        self.tenant_id = maybe_from_nullable(self.tenant_id)
        self.tier = maybe_from_nullable(self.tier)

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "name": to_dict(self.name),
        }
        if self.tenant_id.is_just:
            res["tenant_id"] = to_dict(self.tenant_id.value)
        if self.tier.is_just:
            res["tier"] = to_dict(self.tier.value)
        return res

    @classmethod
    def from_dict(
        cls: t.Type[CreateCourseData], d: t.Dict[str, t.Any]
    ) -> CreateCourseData:
        parsed = cls.data_parser.try_parse(d)

        res = cls(
            name=parsed.name,
            tenant_id=parsed.tenant_id,
            tier=parsed.tier,
        )
        res.raw_data = d
        return res