Source code for codegrade.models.kiosk_launch

"""The module that defines the ``KioskLaunch`` 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 ..utils import to_dict



[docs]
@dataclass(kw_only=True)
class KioskLaunch:
    """The payload that sends a student's browser into the exam kiosk.

    This is the frontend-facing part of a kiosk launch only: server-side state
    that must be persisted (e.g. the provisioned :class:`Workspace`) is
    returned separately and never included here.
    """

    #: The URL the student's browser should be redirected to.
    redirect_url: str

    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(
                "redirect_url",
                rqa.SimpleValue.str,
                doc="The URL the student's browser should be redirected to.",
            ),
        )
    )

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

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

        res = cls(
            redirect_url=parsed.redirect_url,
        )
        res.raw_data = d
        return res