Source code for codegrade.models.base_auto_test_quality_comment

"""The module that defines the ``BaseAutoTestQualityComment`` 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 .. import parsers
from ..utils import to_dict
from .column_range import ColumnRange
from .line_range import LineRange
from .quality_comment_severity import QualityCommentSeverity


@dataclass
class BaseAutoTestQualityComment:
    """The base of the json input/output."""

    #: The severity of the comment. This determines how much points will be
    #: deducted.
    severity: QualityCommentSeverity
    #: The error code from the linter.
    code: t.Optional[str]
    #: The name of the linter that created this comment.
    origin: str
    #: The message of this comment.
    msg: str
    #: The lines to which this comment applies.
    line: LineRange
    #: The columns to which this comment applies.
    column: ColumnRange

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

    data_parser: t.ClassVar = rqa.Lazy(
        lambda: rqa.FixedMapping(
            rqa.RequiredArgument(
                "severity",
                rqa.EnumValue(QualityCommentSeverity),
                doc="The severity of the comment. This determines how much points will be deducted.",
            ),
            rqa.RequiredArgument(
                "code",
                rqa.Nullable(rqa.SimpleValue.str),
                doc="The error code from the linter.",
            ),
            rqa.RequiredArgument(
                "origin",
                rqa.SimpleValue.str,
                doc="The name of the linter that created this comment.",
            ),
            rqa.RequiredArgument(
                "msg",
                rqa.SimpleValue.str,
                doc="The message of this comment.",
            ),
            rqa.RequiredArgument(
                "line",
                parsers.ParserFor.make(LineRange),
                doc="The lines to which this comment applies.",
            ),
            rqa.RequiredArgument(
                "column",
                parsers.ParserFor.make(ColumnRange),
                doc="The columns to which this comment applies.",
            ),
        ).use_readable_describe(True)
    )

    def to_dict(self) -> t.Dict[str, t.Any]:
        res: t.Dict[str, t.Any] = {
            "severity": to_dict(self.severity),
            "code": to_dict(self.code),
            "origin": to_dict(self.origin),
            "msg": to_dict(self.msg),
            "line": to_dict(self.line),
            "column": to_dict(self.column),
        }
        return res

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

        res = cls(
            severity=parsed.severity,
            code=parsed.code,
            origin=parsed.origin,
            msg=parsed.msg,
            line=parsed.line,
            column=parsed.column,
        )
        res.raw_data = d
        return res