Source code for codegrade.models.create_pending_registration_course_data

"""The module that defines the ``CreatePendingRegistrationCourseData`` 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 .. import parsers
from ..utils import to_dict
from .pow_solution import PowSolution




@dataclass
class CreatePendingRegistrationCourseData:
    """Input data required for the `Course::CreatePendingRegistration`
    operation.
    """

    #: Email address of the new user.
    email: str
    #: Proof-of-work solution (from GET /pow/challenge).
    pow: PowSolution
    #: Whether the new user has read and agrees with CodeGrade's privacy
    #: policy.
    privacy_policy_accepted: t.Literal[True]

    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(
                "email",
                rqa.SimpleValue.str,
                doc="Email address of the new user.",
            ),
            rqa.RequiredArgument(
                "pow",
                parsers.ParserFor.make(PowSolution),
                doc="Proof-of-work solution (from GET /pow/challenge).",
            ),
            rqa.RequiredArgument(
                "privacy_policy_accepted",
                rqa.LiteralBoolean(True),
                doc="Whether the new user has read and agrees with CodeGrade's privacy policy.",
            ),
        ).use_readable_describe(True)
    )

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

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

        res = cls(
            email=parsed.email,
            pow=parsed.pow,
            privacy_policy_accepted=parsed.privacy_policy_accepted,
        )
        res.raw_data = d
        return res