"""The module that defines the ``Group`` model.
SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""
from __future__ import annotations
import datetime
import typing as t
from dataclasses import dataclass, field
import cg_request_args as rqa
from .. import parsers
from ..utils import to_dict
from .normal_user import NormalUser
[docs]@dataclass
class Group:
"""The group as JSON."""
#: The id of this group.
id: int
#: The members of this group.
members: t.Sequence[NormalUser]
#: The name of this group.
name: str
#: The id of the group set that this group is connected to.
group_set_id: int
#: The datetime this group was created.
created_at: datetime.datetime
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 this group.",
),
rqa.RequiredArgument(
"members",
rqa.List(parsers.ParserFor.make(NormalUser)),
doc="The members of this group.",
),
rqa.RequiredArgument(
"name",
rqa.SimpleValue.str,
doc="The name of this group.",
),
rqa.RequiredArgument(
"group_set_id",
rqa.SimpleValue.int,
doc="The id of the group set that this group is connected to.",
),
rqa.RequiredArgument(
"created_at",
rqa.RichValue.DateTime,
doc="The datetime this group was created.",
),
).use_readable_describe(True)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"id": to_dict(self.id),
"members": to_dict(self.members),
"name": to_dict(self.name),
"group_set_id": to_dict(self.group_set_id),
"created_at": to_dict(self.created_at),
}
return res
@classmethod
def from_dict(cls: t.Type[Group], d: t.Dict[str, t.Any]) -> Group:
parsed = cls.data_parser.try_parse(d)
res = cls(
id=parsed.id,
members=parsed.members,
name=parsed.name,
group_set_id=parsed.group_set_id,
created_at=parsed.created_at,
)
res.raw_data = d
return res