Source code for codegrade.models.auto_test_step_validation_exception

"""The module that defines the ``AutoTestStepValidationException`` model.

SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""

import typing as t
from dataclasses import dataclass, field

import cg_request_args as rqa
from httpx import Response

from ..utils import to_dict
from .base_error import BaseError


[docs]@dataclass class AutoTestStepValidationException(BaseError): """The exception raised when an IO test contained invalid data.""" #: The index of this step. step_idx: "int" raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False) data_parser: t.ClassVar = rqa.Lazy( lambda: BaseError.data_parser.parser.combine( rqa.FixedMapping( rqa.RequiredArgument( "step_idx", rqa.SimpleValue.int, doc="The index of this step.", ), ) ).use_readable_describe(True) ) def to_dict(self) -> t.Dict[str, t.Any]: res: t.Dict[str, t.Any] = { "step_idx": to_dict(self.step_idx), "message": to_dict(self.message), "description": to_dict(self.description), "code": to_dict(self.code), "request_id": to_dict(self.request_id), } return res @classmethod def from_dict( cls: t.Type["AutoTestStepValidationException"], d: t.Dict[str, t.Any], response: t.Optional[Response] = None, ) -> "AutoTestStepValidationException": parsed = cls.data_parser.try_parse(d) res = cls( step_idx=parsed.step_idx, message=parsed.message, description=parsed.description, code=parsed.code, 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"): from .api_codes import APICodes