"""The module that defines the ``Work`` model.
SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
"""
import datetime
import typing as t
from dataclasses import dataclass, field
import cg_request_args as rqa
from .. import parsers
from ..utils import to_dict
from .timeframe_like import TimeframeLike
from .user import User
from .work_origin import WorkOrigin
[docs]@dataclass
class Work:
"""A submission in CodeGrade."""
#: The id of the submission
id: "int"
#: The author of the submission. If submission was created by a group this
#: will be the virtual user of the group.
user: "User"
#: The way this submission was created.
origin: "WorkOrigin"
#: The moment the submission was created.
created_at: "datetime.datetime"
#: The grade of the submission, or `None` if the submission hasn't been
#: graded of you cannot see the grade.
grade: "t.Optional[float]"
#: The user assigned to this submission. Or `None` if not assigned or if
#: you may not see the assignee.
assignee: "t.Optional[User]"
#: Does this submission have a rubric grade which has been overridden.
grade_overridden: "bool"
#: Some extra info that might be available. Currently only used for git
#: submissions.
extra_info: "t.Any"
#: The timeframe that was used to hand-in this submission. Note that this
#: is a combined timeframe that might be more lenient than any timeframe
#: that existed.
timeframe: "TimeframeLike"
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(
"id",
rqa.SimpleValue.int,
doc="The id of the submission",
),
rqa.RequiredArgument(
"user",
parsers.ParserFor.make(User),
doc="The author of the submission. If submission was created by a group this will be the virtual user of the group.",
),
rqa.RequiredArgument(
"origin",
rqa.EnumValue(WorkOrigin),
doc="The way this submission was created.",
),
rqa.RequiredArgument(
"created_at",
rqa.RichValue.DateTime,
doc="The moment the submission was created.",
),
rqa.RequiredArgument(
"grade",
rqa.Nullable(rqa.SimpleValue.float),
doc="The grade of the submission, or `None` if the submission hasn't been graded of you cannot see the grade.",
),
rqa.RequiredArgument(
"assignee",
rqa.Nullable(parsers.ParserFor.make(User)),
doc="The user assigned to this submission. Or `None` if not assigned or if you may not see the assignee.",
),
rqa.RequiredArgument(
"grade_overridden",
rqa.SimpleValue.bool,
doc="Does this submission have a rubric grade which has been overridden.",
),
rqa.RequiredArgument(
"extra_info",
rqa.AnyValue,
doc="Some extra info that might be available. Currently only used for git submissions.",
),
rqa.RequiredArgument(
"timeframe",
parsers.ParserFor.make(TimeframeLike),
doc="The timeframe that was used to hand-in this submission. Note that this is a combined timeframe that might be more lenient than any timeframe that existed.",
),
).use_readable_describe(True)
)
def to_dict(self) -> t.Dict[str, t.Any]:
res: t.Dict[str, t.Any] = {
"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["Work"], d: t.Dict[str, t.Any]) -> "Work":
parsed = cls.data_parser.try_parse(d)
res = cls(
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