Source code for codegrade.models.base_impersonate_data
"""The module that defines the ``BaseImpersonateData`` 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
from .base_login_data import BaseLoginData
[docs]
@dataclass(kw_only=True)
class BaseImpersonateData(BaseLoginData):
"""Fields shared by the impersonation payloads, regardless of how the
target user is referenced.
"""
#: Your own password.
own_password: str
#: Discriminator selecting the impersonation flow.
mode: t.Literal["impersonate"] = "impersonate"
raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
data_parser: t.ClassVar[t.Any] = rqa.Lazy(
lambda: BaseLoginData.data_parser.parser.combine(
rqa.FixedMapping(
rqa.RequiredArgument(
"own_password",
rqa.SimpleValue.str,
doc="Your own password.",
),
rqa.DefaultArgument(
"mode",
rqa.StringEnum("impersonate"),
doc="Discriminator selecting the impersonation flow.",
default=lambda: "impersonate",
),
)
)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"own_password": to_dict(self.own_password),
"confirm_session_termination": to_dict(
self.confirm_session_termination
),
"mode": to_dict(self.mode),
}
return res
@classmethod
def from_dict(
cls: t.Type[BaseImpersonateData], d: t.Dict[str, t.Any]
) -> BaseImpersonateData:
parsed = cls.data_parser.try_parse(d)
res = cls(
own_password=parsed.own_password,
confirm_session_termination=parsed.confirm_session_termination,
mode=parsed.mode,
)
res.raw_data = d
return res
import os
if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
pass