Source code for codegrade.models.git_user_info

"""The module that defines the ``GitUserInfo`` 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


@dataclass
class GitUserInfo:
    """Information about the owner of a git account."""

    #: The username of the user on the platform.
    username: str
    #: The real name of the user.
    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(
                "username",
                rqa.SimpleValue.str,
                doc="The username of the user on the platform.",
            ),
            rqa.RequiredArgument(
                "name",
                rqa.SimpleValue.str,
                doc="The real name 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),
            "name": to_dict(self.name),
        }
        return res

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

        res = cls(
            username=parsed.username,
            name=parsed.name,
        )
        res.raw_data = d
        return res