codegrade 18.0.13__tar.gz → 18.0.14__tar.gz

{codegrade-18.0.13 → codegrade-18.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: codegrade
-Version: 18.0.13
+Version: 18.0.14
 Summary: A client library for accessing CodeGrade
 Project-URL: Documentation, https://python.api.codegrade.com
 License-Expression: AGPL-3.0-only OR BSD-3-Clause-Clear

{codegrade-18.0.13 → codegrade-18.0.14}/docs/conf.py

@@ -7,6 +7,7 @@
 # -- Path setup --------------------------------------------------------------
 
 import json
+import logging
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -17,6 +18,7 @@ import sys
 from datetime import date
 from typing import Any
 
+import requests
 from sphinx.application import Sphinx
 from sphinx.ext.autodoc import Options
 
@@ -43,7 +45,7 @@ author = "CodeGrade Team"
 # built documents.
 #
 # The short X.Y version.
-version = "18.0.13"
+version = "18.0.14"
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -107,7 +109,7 @@ html_js_files = ["toggle.js"]
 
 html_favicon = "_static/favicon/favicon.ico"
 html_logo = "_static/images/logo.svg"
-html_title = "CodeGrade 18.0.13"
+html_title = "CodeGrade 18.0.14"
 
 # -- Extension configuration -------------------------------------------------
 
@@ -131,10 +133,29 @@ typehints_document_rtype = False
 
 # -- Options for intersphinx extension ---------------------------------------
 
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {
-    "python": ("https://docs.python.org/3", None),
-}
+_PYTHON_DOCS_URL = "https://docs.python.org/3"
+
+
+def _python_intersphinx_mapping() -> dict[str, tuple[str, None]]:
+    """Link to the Python standard library docs, if they are reachable.
+
+    Sphinx runs with ``-W``, so an unreachable inventory would fail the build.
+    Without the inventory the docs build without links to the standard library.
+    """
+    try:
+        requests.get(
+            f"{_PYTHON_DOCS_URL}/objects.inv", timeout=10
+        ).raise_for_status()
+    except requests.RequestException:
+        logging.getLogger(__name__).warning(
+            "Could not fetch the Python intersphinx inventory, building without it",
+            exc_info=True,
+        )
+        return {}
+    return {"python": (_PYTHON_DOCS_URL, None)}
+
+
+intersphinx_mapping = _python_intersphinx_mapping()
 
 os.environ["CG_EAGERIMPORT"] = "True"
 os.environ["CG_GENERATING_DOCS"] = "True"

{codegrade-18.0.13 → codegrade-18.0.14}/docs/models/CustomOutputLog.rst

@@ -4,6 +4,6 @@ CustomOutputLog
 .. currentmodule:: codegrade.models.custom_output_log
 
 .. autoclass:: CustomOutputLog
-   :members: points, haystack
+   :members: type
    :inherited-members:
    :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-18.0.14/docs/models/EmptyStepLog.rst

@@ -0,0 +1,9 @@
+EmptyStepLog
+============
+
+.. currentmodule:: codegrade.models.empty_step_log
+
+.. autoclass:: EmptyStepLog
+   :members: type
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-18.0.13 → codegrade-18.0.14}/docs/models/IOTestLog.rst

@@ -4,6 +4,6 @@ IOTestLog
 .. currentmodule:: codegrade.models.io_test_log
 
 .. autoclass:: IOTestLog
-   :members: steps
+   :members: type
    :inherited-members:
    :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-18.0.13 → codegrade-18.0.14}/docs/models/JunitTestLog.rst

@@ -4,6 +4,6 @@ JunitTestLog
 .. currentmodule:: codegrade.models.junit_test_log
 
 .. autoclass:: JunitTestLog
-   :members: points
+   :members: type
    :inherited-members:
    :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-18.0.14/docs/models/MalformedStepLog.rst

@@ -0,0 +1,9 @@
+MalformedStepLog
+================
+
+.. currentmodule:: codegrade.models.malformed_step_log
+
+.. autoclass:: MalformedStepLog
+   :members: type
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-18.0.13 → codegrade-18.0.14}/docs/models/QualityTestLog.rst

@@ -4,6 +4,6 @@ QualityTestLog
 .. currentmodule:: codegrade.models.quality_test_log
 
 .. autoclass:: QualityTestLog
-   :members: points
+   :members: type
    :inherited-members:
    :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-18.0.13 → codegrade-18.0.14}/docs/models/RunProgramLog.rst

@@ -4,6 +4,6 @@ RunProgramLog
 .. currentmodule:: codegrade.models.run_program_log
 
 .. autoclass:: RunProgramLog
-   :members: stdout, stderr, exit_code, time_spend
+   :members: type
    :inherited-members:
    :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-18.0.14/docs/models/UntaggedCustomOutputLog.rst

@@ -0,0 +1,9 @@
+UntaggedCustomOutputLog
+=======================
+
+.. currentmodule:: codegrade.models.untagged_custom_output_log
+
+.. autoclass:: UntaggedCustomOutputLog
+   :members: points, haystack
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-18.0.14/docs/models/UntaggedIOTestLog.rst

@@ -0,0 +1,9 @@
+UntaggedIOTestLog
+=================
+
+.. currentmodule:: codegrade.models.untagged_io_test_log
+
+.. autoclass:: UntaggedIOTestLog
+   :members: steps
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-18.0.14/docs/models/UntaggedJunitTestLog.rst

@@ -0,0 +1,9 @@
+UntaggedJunitTestLog
+====================
+
+.. currentmodule:: codegrade.models.untagged_junit_test_log
+
+.. autoclass:: UntaggedJunitTestLog
+   :members: points
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-18.0.14/docs/models/UntaggedQualityTestLog.rst

@@ -0,0 +1,9 @@
+UntaggedQualityTestLog
+======================
+
+.. currentmodule:: codegrade.models.untagged_quality_test_log
+
+.. autoclass:: UntaggedQualityTestLog
+   :members: points
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

codegrade-18.0.14/docs/models/UntaggedRunProgramLog.rst

@@ -0,0 +1,9 @@
+UntaggedRunProgramLog
+=====================
+
+.. currentmodule:: codegrade.models.untagged_run_program_log
+
+.. autoclass:: UntaggedRunProgramLog
+   :members: stdout, stderr, exit_code, time_spend
+   :inherited-members:
+   :exclude-members: raw_data, data_parser, to_dict, from_dict, __init__, __new__

{codegrade-18.0.13 → codegrade-18.0.14}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "codegrade"
-version = "18.0.13"
+version = "18.0.14"
 description = "A client library for accessing CodeGrade"
 authors = []
 requires-python = ">=3.12,<4.0"

{codegrade-18.0.13 → codegrade-18.0.14}/src/codegrade/__init__.py

@@ -17,7 +17,7 @@ except ImportError:
     )
 
 __all__ = ("login", "AuthenticatedClient", "Client", "login_from_cli")
-__version__ = "18.0.13"
+__version__ = "18.0.14"
 
 _P = _ParamSpec("_P")
 _T = _t.TypeVar("_T")

{codegrade-18.0.13 → codegrade-18.0.14}/src/codegrade/client.py

@@ -653,7 +653,7 @@ class Client(_BaseClient):
         return httpx.Client(
             base_url=self.base_url,
             headers={
-                "User-Agent": "CodeGradeAPI/18.0.13",
+                "User-Agent": "CodeGradeAPI/18.0.14",
             },
             follow_redirects=True,
             transport=RetryingTransport(httpx.HTTPTransport()),
@@ -674,7 +674,7 @@ class AuthenticatedClient(_BaseClient):
             base_url=self.base_url,
             headers={
                 "Authorization": f"Bearer {self.token}",
-                "User-Agent": "CodeGradeAPI/18.0.13",
+                "User-Agent": "CodeGradeAPI/18.0.14",
             },
             follow_redirects=True,
             transport=RetryingTransport(httpx.HTTPTransport()),

{codegrade-18.0.13 → codegrade-18.0.14}/src/codegrade/models/__init__.py

@@ -335,6 +335,7 @@ from .email_notification_types import (
     EmailNotificationTypes as EmailNotificationTypes,
 )
 from .email_users_course_data import EmailUsersCourseData
+from .empty_step_log import EmptyStepLog
 from .enroll_data_by_id import EnrollDataById
 from .enroll_data_by_username import EnrollDataByUsername
 from .enter_restriction_data import EnterRestrictionData
@@ -533,6 +534,7 @@ from .lti_standalone_login_max_age_setting import (
 from .lti_template_preview_launch_data import LTITemplatePreviewLaunchData
 from .lti_version import LTIVersion as LTIVersion
 from .malformed_community_library_item import MalformedCommunityLibraryItem
+from .malformed_step_log import MalformedStepLog
 from .max_file_size_setting import MaxFileSizeSetting
 from .max_large_upload_size_setting import MaxLargeUploadSizeSetting
 from .max_normal_upload_size_setting import MaxNormalUploadSizeSetting
@@ -873,6 +875,11 @@ from .types import *
 from .unknown_error_exception import UnknownErrorException
 from .unsafe_archive_exception import UnsafeArchiveException
 from .unsupported_exception import UnsupportedException
+from .untagged_custom_output_log import UntaggedCustomOutputLog
+from .untagged_io_test_log import UntaggedIOTestLog
+from .untagged_junit_test_log import UntaggedJunitTestLog
+from .untagged_quality_test_log import UntaggedQualityTestLog
+from .untagged_run_program_log import UntaggedRunProgramLog
 from .update_access_plan_data import UpdateAccessPlanData
 from .update_peer_feedback_settings_assignment_data import (
     UpdatePeerFeedbackSettingsAssignmentData,

{codegrade-18.0.13 → codegrade-18.0.14}/src/codegrade/models/auto_test_step_result.py

@@ -14,11 +14,12 @@ import cg_request_args as rqa
 from .. import parsers
 from ..utils import to_dict
 from .auto_test_step_base import AutoTestStepBase, AutoTestStepBaseParser
-from .auto_test_step_log_base import AutoTestStepLogBase
 from .auto_test_step_result_state import AutoTestStepResultState
 from .custom_output_log import CustomOutputLog
+from .empty_step_log import EmptyStepLog
 from .io_test_log import IOTestLog
 from .junit_test_log import JunitTestLog
+from .malformed_step_log import MalformedStepLog
 from .quality_test_log import QualityTestLog
 from .run_program_log import RunProgramLog
 
@@ -34,8 +35,8 @@ class AutoTestStepResult:
     state: AutoTestStepResultState
     #: The amount of points achieved by the student in this step.
     achieved_points: float
-    #: The log produced by this result. The format of this log depends on the
-    #: step result.
+    #: The log produced by this result, tagged with the type of its step.
+    #: `None` when no stored log can be found for this result.
     log: t.Optional[
         t.Union[
             CustomOutputLog,
@@ -43,7 +44,8 @@ class AutoTestStepResult:
             QualityTestLog,
             RunProgramLog,
             IOTestLog,
-            AutoTestStepLogBase,
+            EmptyStepLog,
+            MalformedStepLog,
         ]
     ]
     #: The time this result was started, if `null` the result hasn't started
@@ -86,10 +88,11 @@ class AutoTestStepResult:
                         parsers.ParserFor.make(QualityTestLog),
                         parsers.ParserFor.make(RunProgramLog),
                         parsers.ParserFor.make(IOTestLog),
-                        parsers.ParserFor.make(AutoTestStepLogBase),
+                        parsers.ParserFor.make(EmptyStepLog),
+                        parsers.ParserFor.make(MalformedStepLog),
                     )
                 ),
-                doc="The log produced by this result. The format of this log depends on the step result.",
+                doc="The log produced by this result, tagged with the type of its step. `None` when no stored log can be found for this result.",
             ),
             rqa.RequiredArgument(
                 "started_at",

codegrade-18.0.14/src/codegrade/models/custom_output_log.py

@@ -0,0 +1,80 @@
+"""The module that defines the ``CustomOutputLog`` 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
+from .untagged_custom_output_log import UntaggedCustomOutputLog
+
+
+@dataclass(kw_only=True)
+class CustomOutputLog(UntaggedCustomOutputLog):
+    """The log of a custom output step."""
+
+    #: The type of the step that produced this log.
+    type: t.Literal["custom_output"]
+
+    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
+
+    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
+        lambda: UntaggedCustomOutputLog.data_parser.parser.combine(
+            rqa.FixedMapping(
+                rqa.RequiredArgument(
+                    "type",
+                    rqa.StringEnum("custom_output"),
+                    doc="The type of the step that produced this log.",
+                ),
+            )
+        )
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "type": to_dict(self.type),
+            "stdout": to_dict(self.stdout),
+            "stderr": to_dict(self.stderr),
+            "exit_code": to_dict(self.exit_code),
+            "time_spend": to_dict(self.time_spend),
+        }
+        if self.points.is_just:
+            res["points"] = to_dict(self.points.value)
+        if self.haystack.is_just:
+            res["haystack"] = to_dict(self.haystack.value)
+        return res
+
+    @classmethod
+    def from_dict(
+        cls: t.Type[CustomOutputLog], d: t.Dict[str, t.Any]
+    ) -> CustomOutputLog:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            type=parsed.type,
+            stdout=parsed.stdout,
+            stderr=parsed.stderr,
+            exit_code=parsed.exit_code,
+            time_spend=parsed.time_spend,
+            points=parsed.points,
+            haystack=parsed.haystack,
+        )
+        res.raw_data = d
+        return res
+
+
+import os
+
+if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
+    import datetime
+
+    from cg_maybe import Maybe, Nothing
+    from cg_maybe.utils import maybe_from_nullable
+
+    from .auto_test_step_log_base import AutoTestStepLogBase
+    from .custom_output_log_base import CustomOutputLogBase

codegrade-18.0.14/src/codegrade/models/empty_step_log.py

@@ -0,0 +1,55 @@
+"""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
+
+
+@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

codegrade-18.0.14/src/codegrade/models/io_test_log.py

@@ -0,0 +1,61 @@
+"""The module that defines the ``IOTestLog`` 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
+from .untagged_io_test_log import UntaggedIOTestLog
+
+
+@dataclass(kw_only=True)
+class IOTestLog(UntaggedIOTestLog):
+    """The log of an IO test step."""
+
+    #: The type of the step that produced this log.
+    type: t.Literal["io_test"]
+
+    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
+
+    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
+        lambda: UntaggedIOTestLog.data_parser.parser.combine(
+            rqa.FixedMapping(
+                rqa.RequiredArgument(
+                    "type",
+                    rqa.StringEnum("io_test"),
+                    doc="The type of the step that produced this log.",
+                ),
+            )
+        )
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "type": to_dict(self.type),
+            "steps": to_dict(self.steps),
+        }
+        return res
+
+    @classmethod
+    def from_dict(cls: t.Type[IOTestLog], d: t.Dict[str, t.Any]) -> IOTestLog:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            type=parsed.type,
+            steps=parsed.steps,
+        )
+        res.raw_data = d
+        return res
+
+
+import os
+
+if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
+    from .auto_test_step_log_base import AutoTestStepLogBase
+    from .io_test_step_log import IOTestStepLog

codegrade-18.0.14/src/codegrade/models/junit_test_log.py

@@ -0,0 +1,77 @@
+"""The module that defines the ``JunitTestLog`` 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
+from .untagged_junit_test_log import UntaggedJunitTestLog
+
+
+@dataclass(kw_only=True)
+class JunitTestLog(UntaggedJunitTestLog):
+    """The log of a JUnit test step."""
+
+    #: The type of the step that produced this log.
+    type: t.Literal["junit_test"]
+
+    raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
+
+    data_parser: t.ClassVar[t.Any] = rqa.Lazy(
+        lambda: UntaggedJunitTestLog.data_parser.parser.combine(
+            rqa.FixedMapping(
+                rqa.RequiredArgument(
+                    "type",
+                    rqa.StringEnum("junit_test"),
+                    doc="The type of the step that produced this log.",
+                ),
+            )
+        )
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "type": to_dict(self.type),
+            "stdout": to_dict(self.stdout),
+            "stderr": to_dict(self.stderr),
+            "exit_code": to_dict(self.exit_code),
+            "time_spend": to_dict(self.time_spend),
+        }
+        if self.points.is_just:
+            res["points"] = to_dict(self.points.value)
+        return res
+
+    @classmethod
+    def from_dict(
+        cls: t.Type[JunitTestLog], d: t.Dict[str, t.Any]
+    ) -> JunitTestLog:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            type=parsed.type,
+            stdout=parsed.stdout,
+            stderr=parsed.stderr,
+            exit_code=parsed.exit_code,
+            time_spend=parsed.time_spend,
+            points=parsed.points,
+        )
+        res.raw_data = d
+        return res
+
+
+import os
+
+if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
+    import datetime
+
+    from cg_maybe import Maybe, Nothing
+    from cg_maybe.utils import maybe_from_nullable
+
+    from .auto_test_step_log_base import AutoTestStepLogBase
+    from .junit_test_log_base import JunitTestLogBase

codegrade-18.0.14/src/codegrade/models/malformed_step_log.py

@@ -0,0 +1,55 @@
+"""The module that defines the ``MalformedStepLog`` 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
+
+
+@dataclass(kw_only=True)
+class MalformedStepLog:
+    """The log of a step result whose stored log does not have the shape of the
+    type of its step.
+
+    Its output cannot be shown.
+    """
+
+    #: Marks the log as malformed.
+    type: t.Literal["malformed"]
+
+    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("malformed"),
+                doc="Marks the log as malformed.",
+            ),
+        )
+    )
+
+    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[MalformedStepLog], d: t.Dict[str, t.Any]
+    ) -> MalformedStepLog:
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            type=parsed.type,
+        )
+        res.raw_data = d
+        return res