Source code for codegrade.models.otp_loginable_user

"""The module that defines the ``OTPLoginableUser`` 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 .normal_user import NormalUser
from .tenant import Tenant




@dataclass
class OTPLoginableUser(NormalUser):
    """A user entry in the multi-user selection response."""

    #: The tenant.
    tenant: t.Optional[Tenant]
    #: Whether the user can login outside their LMS/SSO.
    can_login: bool

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

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: NormalUser.data_parser.parser.combine(
            rqa.FixedMapping(
                rqa.RequiredArgument(
                    "tenant",
                    rqa.Nullable(parsers.ParserFor.make(Tenant)),
                    doc="The tenant.",
                ),
                rqa.RequiredArgument(
                    "can_login",
                    rqa.SimpleValue.bool,
                    doc="Whether the user can login outside their LMS/SSO.",
                ),
            )
        ).use_readable_describe(True)
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "tenant": to_dict(self.tenant),
            "can_login": to_dict(self.can_login),
            "type": to_dict(self.type),
            "name": to_dict(self.name),
            "is_test_student": to_dict(self.is_test_student),
            "id": to_dict(self.id),
            "username": to_dict(self.username),
            "tenant_id": to_dict(self.tenant_id),
        }
        return res

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

        res = cls(
            tenant=parsed.tenant,
            can_login=parsed.can_login,
            type=parsed.type,
            name=parsed.name,
            is_test_student=parsed.is_test_student,
            id=parsed.id,
            username=parsed.username,
            tenant_id=parsed.tenant_id,
        )
        res.raw_data = d
        return res



import os

if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
    from .base_user import BaseUser