"""The module that defines the ``AssignmentFeedback`` 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 ..utils import to_dict
[docs]@dataclass
class AssignmentFeedback:
"""The feedback of a single submission when getting all feedback through
the `/assignments/{assignmentId}/feedbacks/` route.
"""
#: The general feedback of the submission.
general: "str"
#: The inline comments as a list of strings.
user: "t.Sequence[str]"
#: The linter comments as a list of strings. This field is deprecated and
#: will always be empty.
linter: "t.Sequence[str]"
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(
"general",
rqa.SimpleValue.str,
doc="The general feedback of the submission.",
),
rqa.RequiredArgument(
"user",
rqa.List(rqa.SimpleValue.str),
doc="The inline comments as a list of strings.",
),
rqa.RequiredArgument(
"linter",
rqa.List(rqa.SimpleValue.str),
doc="The linter comments as a list of strings. This field is deprecated and will always be empty.",
),
).use_readable_describe(True)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"general": to_dict(self.general),
"user": to_dict(self.user),
"linter": to_dict(self.linter),
}
return res
@classmethod
def from_dict(
cls: t.Type["AssignmentFeedback"], d: t.Dict[str, t.Any]
) -> "AssignmentFeedback":
parsed = cls.data_parser.try_parse(d)
res = cls(
general=parsed.general,
user=parsed.user,
linter=parsed.linter,
)
res.raw_data = d
return res