Source code for codegrade.models.restriction_mixin_set_password

"""The module that defines the ``RestrictionMixinSetPassword`` 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 RestrictionMixinSetPassword:
    """The value for the password when there is one set."""

    #: A password is set.
    tag: t.Literal["set"]
    #: The password, will be None if you don't have permission to view it.
    password: t.Optional[str]

    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "tag",
                rqa.StringEnum("set"),
                doc="A password is set.",
            ),
            rqa.RequiredArgument(
                "password",
                rqa.Nullable(rqa.SimpleValue.str),
                doc="The password, will be None if you don't have permission to view it.",
            ),
        ).use_readable_describe(True)
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "tag": to_dict(self.tag),
            "password": to_dict(self.password),
        }
        return res

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

        res = cls(
            tag=parsed.tag,
            password=parsed.password,
        )
        res.raw_data = d
        return res