Source code for codegrade.models.patch_role_data
"""The module that defines the ``PatchRoleData`` 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 .. import parsers
from ..utils import to_dict
from .global_permission import GlobalPermission
[docs]@dataclass
class PatchRoleData:
"""Input data required for the `Role::Patch` operation."""
#: The name of the permission to change.
permission: "GlobalPermission"
#: The value to set the permission to (`True` means the specified role has
#: the specified permission).
value: "bool"
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(
"permission",
rqa.EnumValue(GlobalPermission),
doc="The name of the permission to change.",
),
rqa.RequiredArgument(
"value",
rqa.SimpleValue.bool,
doc="The value to set the permission to (`True` means the specified role has the specified permission).",
),
).use_readable_describe(True)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"permission": to_dict(self.permission),
"value": to_dict(self.value),
}
return res
@classmethod
def from_dict(
cls: t.Type["PatchRoleData"], d: t.Dict[str, t.Any]
) -> "PatchRoleData":
parsed = cls.data_parser.try_parse(d)
res = cls(
permission=parsed.permission,
value=parsed.value,
)
res.raw_data = d
return res