Source code for codegrade.models.login_by_username_data
"""The module that defines the ``LoginByUsernameData`` 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
from .user_input_by_username import UserInputByUsername
[docs]
@dataclass(kw_only=True)
class LoginByUsernameData(UserInputByUsername, BaseLoginData):
"""Payload for the self-login flow."""
#: Your password.
password: str
#: Discriminator selecting the self-login (vs. impersonation) flow.
#: Defaults server-side; existing clients that omit it keep working.
mode: t.Literal["login"] = "login"
raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
data_parser: t.ClassVar[t.Any] = rqa.Lazy(
lambda: UserInputByUsername.data_parser.parser.combine(
BaseLoginData.data_parser.parser
).combine(
rqa.FixedMapping(
rqa.RequiredArgument(
"password",
rqa.SimpleValue.str,
doc="Your password.",
),
rqa.DefaultArgument(
"mode",
rqa.StringEnum("login"),
doc="Discriminator selecting the self-login (vs. impersonation) flow. Defaults server-side; existing clients that omit it keep working.",
default=lambda: "login",
),
)
)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"password": to_dict(self.password),
"username": to_dict(self.username),
"tenant_id": to_dict(self.tenant_id),
"by": to_dict(self.by),
"confirm_session_termination": to_dict(
self.confirm_session_termination
),
"mode": to_dict(self.mode),
}
return res
@classmethod
def from_dict(
cls: t.Type[LoginByUsernameData], d: t.Dict[str, t.Any]
) -> LoginByUsernameData:
parsed = cls.data_parser.try_parse(d)
res = cls(
password=parsed.password,
username=parsed.username,
tenant_id=parsed.tenant_id,
by=parsed.by,
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