Source code for codegrade.models.user_input
"""The module that defines the ``UserInput`` 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
class UserInput:
"""Data to provide a user by username and tenant."""
#: The username of the user.
username: str
#: The id of the tenant of the user.
tenant_id: 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(
"username",
rqa.SimpleValue.str,
doc="The username of the user.",
),
rqa.RequiredArgument(
"tenant_id",
rqa.SimpleValue.str,
doc="The id of the tenant of the user.",
),
).use_readable_describe(True)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"username": to_dict(self.username),
"tenant_id": to_dict(self.tenant_id),
}
return res
@classmethod
def from_dict(cls: t.Type[UserInput], d: t.Dict[str, t.Any]) -> UserInput:
parsed = cls.data_parser.try_parse(d)
res = cls(
username=parsed.username,
tenant_id=parsed.tenant_id,
)
res.raw_data = d
return res