Source code for codegrade.models.extended_work

"""The module that defines the ``ExtendedWork`` 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 .. import parsers
from ..utils import to_dict
from .user import User
from .work import Work
from .work_rubric_result_as_json import WorkRubricResultAsJSON


[docs]@dataclass class ExtendedWork(Work): """A submission in CodeGrade with extended data. All data that might be `None` in this class might be `None` because of missing data or missing permissions. """ #: The general feedback comment for this submission. comment: "t.Optional[str]" #: The author of the general feedback comment (this field is deprecated). comment_author: "t.Optional[User]" #: The assignment id of this submission. assignment_id: "int" #: The rubric result of this submission. rubric_result: "t.Optional[WorkRubricResultAsJSON]" raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False) data_parser: t.ClassVar = rqa.Lazy( lambda: Work.data_parser.parser.combine( rqa.FixedMapping( rqa.RequiredArgument( "comment", rqa.Nullable(rqa.SimpleValue.str), doc="The general feedback comment for this submission.", ), rqa.RequiredArgument( "comment_author", rqa.Nullable(parsers.ParserFor.make(User)), doc="The author of the general feedback comment (this field is deprecated).", ), rqa.RequiredArgument( "assignment_id", rqa.SimpleValue.int, doc="The assignment id of this submission.", ), rqa.RequiredArgument( "rubric_result", rqa.Nullable( parsers.ParserFor.make(WorkRubricResultAsJSON) ), doc="The rubric result of this submission.", ), ) ).use_readable_describe(True) ) def to_dict(self) -> t.Dict[str, t.Any]: res: t.Dict[str, t.Any] = { "comment": to_dict(self.comment), "comment_author": to_dict(self.comment_author), "assignment_id": to_dict(self.assignment_id), "rubric_result": to_dict(self.rubric_result), "id": to_dict(self.id), "user": to_dict(self.user), "origin": to_dict(self.origin), "created_at": to_dict(self.created_at), "grade": to_dict(self.grade), "assignee": to_dict(self.assignee), "grade_overridden": to_dict(self.grade_overridden), "extra_info": to_dict(self.extra_info), "timeframe": to_dict(self.timeframe), } return res @classmethod def from_dict( cls: t.Type["ExtendedWork"], d: t.Dict[str, t.Any] ) -> "ExtendedWork": parsed = cls.data_parser.try_parse(d) res = cls( comment=parsed.comment, comment_author=parsed.comment_author, assignment_id=parsed.assignment_id, rubric_result=parsed.rubric_result, id=parsed.id, user=parsed.user, origin=parsed.origin, created_at=parsed.created_at, grade=parsed.grade, assignee=parsed.assignee, grade_overridden=parsed.grade_overridden, extra_info=parsed.extra_info, timeframe=parsed.timeframe, ) res.raw_data = d return res
import os if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"): import datetime from .timeframe_like import TimeframeLike from .work_origin import WorkOrigin