Source code for codegrade.models.create_otp_login_data
"""The module that defines the ``CreateOTPLoginData`` 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 .pow_solution import PowSolution
[docs]
@dataclass
class CreateOTPLoginData:
"""Input data required for the `OTP Login::Create` operation."""
#: The email address to log in with.
email: str
#: Proof-of-work solution (from GET /pow/challenge).
pow: PowSolution
#: Optional tenant filter.
tenant_id: Maybe[str] = 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(
"email",
rqa.SimpleValue.str,
doc="The email address to log in with.",
),
rqa.RequiredArgument(
"pow",
parsers.ParserFor.make(PowSolution),
doc="Proof-of-work solution (from GET /pow/challenge).",
),
rqa.OptionalArgument(
"tenant_id",
rqa.SimpleValue.str,
doc="Optional tenant filter.",
),
).use_readable_describe(True)
)
def __post_init__(self) -> None:
getattr(super(), "__post_init__", lambda: None)()
self.tenant_id = maybe_from_nullable(self.tenant_id)
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),
}
if self.tenant_id.is_just:
res["tenant_id"] = to_dict(self.tenant_id.value)
return res
@classmethod
def from_dict(
cls: t.Type[CreateOTPLoginData], d: t.Dict[str, t.Any]
) -> CreateOTPLoginData:
parsed = cls.data_parser.try_parse(d)
res = cls(
email=parsed.email,
pow=parsed.pow,
tenant_id=parsed.tenant_id,
)
res.raw_data = d
return res