Source code for codegrade.models.empty_step_log

"""The module that defines the ``EmptyStepLog`` 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(kw_only=True)
class EmptyStepLog:
    """The log of a step result without output to show.

    This is the log of a step that has not produced output yet, of a check
    points step, and of a step whose details the user may not see.
    """

    #: Marks the log as empty.
    type: t.Literal["empty"]

    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(
                "type",
                rqa.StringEnum("empty"),
                doc="Marks the log as empty.",
            ),
        )
    )

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

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

        res = cls(
            type=parsed.type,
        )
        res.raw_data = d
        return res