Source code for codegrade.models.set_session_lockdown_data

"""The module that defines the ``SetSessionLockdownData`` 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 .entry_window import EntryWindow




@dataclass(kw_only=True)
class SetSessionLockdownData:
    """ """

    #: Discriminator
    tag: t.Literal["set"]
    #: Maximum number of entries per student
    max_entries: int
    #: Whether heartbeat enforcement is enabled
    heartbeat_enforced: bool = False
    #: The entry window: students may only enter the course between starts_at
    #: and ends_at. Omit to leave the window unset; both bounds are required
    #: when present.
    entry_window: Maybe[EntryWindow] = 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(
                "tag",
                rqa.StringEnum("set"),
                doc="Discriminator",
            ),
            rqa.RequiredArgument(
                "max_entries",
                rqa.SimpleValue.int,
                doc="Maximum number of entries per student",
            ),
            rqa.DefaultArgument(
                "heartbeat_enforced",
                rqa.SimpleValue.bool,
                doc="Whether heartbeat enforcement is enabled",
                default=lambda: False,
            ),
            rqa.OptionalArgument(
                "entry_window",
                parsers.ParserFor.make(EntryWindow),
                doc="The entry window: students may only enter the course between starts_at and ends_at. Omit to leave the window unset; both bounds are required when present.",
            ),
        )
    )

    def __post_init__(self) -> None:
        getattr(super(), "__post_init__", lambda: None)()
        self.entry_window = maybe_from_nullable(self.entry_window)

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "tag": to_dict(self.tag),
            "max_entries": to_dict(self.max_entries),
            "heartbeat_enforced": to_dict(self.heartbeat_enforced),
        }
        if self.entry_window.is_just:
            res["entry_window"] = to_dict(self.entry_window.value)
        return res

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

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