"""The module that defines the ``AssignmentLoginLink`` 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 .assignment import Assignment
from .user import User, UserParser
[docs]@dataclass
class AssignmentLoginLink:
"""The way this class will be represented in JSON."""
#: The id of this link.
id: str
#: The assignment connected to this login link.
assignment: Assignment
user: User
#: The amount of seconds until the exam starts.
time_to_start: t.Optional[float]
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(
"id",
rqa.SimpleValue.str,
doc="The id of this link.",
),
rqa.RequiredArgument(
"assignment",
parsers.ParserFor.make(Assignment),
doc="The assignment connected to this login link.",
),
rqa.RequiredArgument(
"user",
UserParser,
doc="",
),
rqa.RequiredArgument(
"time_to_start",
rqa.Nullable(rqa.SimpleValue.float),
doc="The amount of seconds until the exam starts.",
),
).use_readable_describe(True)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"id": to_dict(self.id),
"assignment": to_dict(self.assignment),
"user": to_dict(self.user),
"time_to_start": to_dict(self.time_to_start),
}
return res
@classmethod
def from_dict(
cls: t.Type[AssignmentLoginLink], d: t.Dict[str, t.Any]
) -> AssignmentLoginLink:
parsed = cls.data_parser.try_parse(d)
res = cls(
id=parsed.id,
assignment=parsed.assignment,
user=parsed.user,
time_to_start=parsed.time_to_start,
)
res.raw_data = d
return res