Source code for codegrade.models.teacher_ui_url_response

"""The module that defines the ``TeacherUIUrlResponse`` 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 TeacherUIUrlResponse:
    """A deep link into the provider-hosted teacher UI."""

    #: The URL to open. It carries temporary authorization and is never
    #: reusable, so fetch a fresh one for every open.
    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(
                "url",
                rqa.SimpleValue.str,
                doc="The URL to open. It carries temporary authorization and is never reusable, so fetch a fresh one for every open.",
            ),
        )
    )

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

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

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