Source code for codegrade.models.abstract_role

"""The module that defines the ``AbstractRole`` model.

SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""

import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa

from ..utils import to_dict


[docs]@dataclass class AbstractRole: """The JSON representation of a role.""" #: The id of the role id: "int" #: The name of the role name: "str" 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.int, doc="The id of the role", ), rqa.RequiredArgument( "name", rqa.SimpleValue.str, doc="The name of the role", ), ).use_readable_describe(True) ) def to_dict(self) -> t.Dict[str, t.Any]: res: t.Dict[str, t.Any] = { "id": to_dict(self.id), "name": to_dict(self.name), } return res @classmethod def from_dict( cls: t.Type["AbstractRole"], d: t.Dict[str, t.Any] ) -> "AbstractRole": parsed = cls.data_parser.try_parse(d) res = cls( id=parsed.id, name=parsed.name, ) res.raw_data = d return res