Source code for codegrade.models.removed_permissions

"""The module that defines the ``RemovedPermissions`` 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 .course_permission import CoursePermission




@dataclass
class RemovedPermissions:
    """The removed permissions for this session."""

    #: The course permissions which are removed in this session. DO NOT assume
    #: that the user has these permissions normally.
    course: t.Sequence[CoursePermission]
    #: The global permissions which are removed in this session.
    global_: Maybe[t.Sequence[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(
                "course",
                rqa.List(rqa.EnumValue(CoursePermission)),
                doc="The course permissions which are removed in this session. DO NOT assume that the user has these permissions normally.",
            ),
            rqa.OptionalArgument(
                "global",
                rqa.List(rqa.SimpleValue.str),
                doc="The global permissions which are removed in this session.",
            ),
        ).use_readable_describe(True)
    )

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

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "course": to_dict(self.course),
        }
        if self.global_.is_just:
            res["global"] = to_dict(self.global_.value)
        return res

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

        res = cls(
            course=parsed.course,
            global_=getattr(parsed, "global"),
        )
        res.raw_data = d
        return res