Source code for codegrade.models.first_phase_lti_launch_exception

"""The module that defines the ``FirstPhaseLTILaunchException`` 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 httpx import Response

from .. import parsers
from ..utils import to_dict
from .base_error import BaseError
from .base_error_with_code import BaseErrorWithCode




@dataclass(kw_only=True)
class FirstPhaseLTILaunchException(BaseError):
    """The LTI launch went wrong."""

    #: A unique code identifying the kind of error that occurred.
    code: t.Literal["LTI_FIRST_PHASE_FAILED"]
    #: The exception that occurred during the first launch phase, `None` when
    #: that phase failed with an error that is not an API error.
    original_exception: t.Optional[BaseErrorWithCode]

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

    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
        lambda: BaseError.data_parser.parser.combine(
            rqa.FixedMapping(
                rqa.RequiredArgument(
                    "code",
                    rqa.StringEnum("LTI_FIRST_PHASE_FAILED"),
                    doc="A unique code identifying the kind of error that occurred.",
                ),
                rqa.RequiredArgument(
                    "original_exception",
                    rqa.Nullable(parsers.ParserFor.make(BaseErrorWithCode)),
                    doc="The exception that occurred during the first launch phase, `None` when that phase failed with an error that is not an API error.",
                ),
            )
        )
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "code": to_dict(self.code),
            "original_exception": to_dict(self.original_exception),
            "message": to_dict(self.message),
            "description": to_dict(self.description),
            "request_id": to_dict(self.request_id),
        }
        return res

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

        res = cls(
            code=parsed.code,
            original_exception=parsed.original_exception,
            message=parsed.message,
            description=parsed.description,
            request_id=parsed.request_id,
            response=response,
        )
        res.raw_data = d
        return res



import os

if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
    pass