Source code for codegrade.models.payment_not_needed_status

"""The module that defines the ``PaymentNotNeededStatus`` 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 ..utils import to_dict


@dataclass
class PaymentNotNeededStatus:
    """The status when payment is not required for a course.

    This is also returned if the user is not enrolled in the course.
    """

    #: A literal string to identify this payment status type.
    tag: t.Literal["not-needed"]

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

    data_parser: t.ClassVar = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "tag",
                rqa.StringEnum("not-needed"),
                doc="A literal string to identify this payment status type.",
            ),
        ).use_readable_describe(True)
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "tag": to_dict(self.tag),
        }
        return res

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

        res = cls(
            tag=parsed.tag,
        )
        res.raw_data = d
        return res