codegrade 16.1.63__tar.gz → 16.1.65__tar.gz

{codegrade-16.1.63 → codegrade-16.1.65}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codegrade
-Version: 16.1.63
+Version: 16.1.65
 Summary: A client library for accessing CodeGrade
 License: AGPL-3.0-only OR BSD-3-Clause-Clear
 Requires-Python: >=3.8.0,<4.0

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/__init__.py

@@ -7,7 +7,7 @@ from functools import wraps
 from .client import AuthenticatedClient, Client
 
 __all__ = ("login", "AuthenticatedClient", "Client", "login_from_cli")
-__version__ = "16.1.63"
+__version__ = "16.1.65"
 
 
 @wraps(AuthenticatedClient.get)

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/client.py

@@ -538,7 +538,7 @@ class Client(_BaseClient):
         return httpx.Client(
             base_url=self.base_url,
             headers={
-                "User-Agent": "CodeGradeAPI/16.1.63",
+                "User-Agent": "CodeGradeAPI/16.1.65",
             },
             follow_redirects=True,
         )
@@ -558,7 +558,7 @@ class AuthenticatedClient(_BaseClient):
             base_url=self.base_url,
             headers={
                 "Authorization": f"Bearer {self.token}",
-                "User-Agent": "CodeGradeAPI/16.1.63",
+                "User-Agent": "CodeGradeAPI/16.1.65",
             },
             follow_redirects=True,
         )

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/__init__.py

@@ -11,6 +11,7 @@ from ._submission_rubric_item_data_parser import (
 from .about import About
 from .abstract_role import AbstractRole
 from .add_users_section_data import AddUsersSectionData
+from .ai_assistant_enabled_setting import AiAssistantEnabledSetting
 from .all_auto_test_results import AllAutoTestResults
 from .all_site_settings import AllSiteSettings
 from .always_update_pii_with_lti_setting import AlwaysUpdatePiiWithLtiSetting
@@ -399,7 +400,6 @@ from .junit_test_log_base import JunitTestLogBase
 from .jwt_access_token_expires_setting import JwtAccessTokenExpiresSetting
 from .legacy_features import LegacyFeatures
 from .line_range import LineRange
-from .linter_comment import LinterComment
 from .linters_enabled_setting import LintersEnabledSetting
 from .lms_capabilities import LMSCapabilities
 from .login_token_before_time_setting import LoginTokenBeforeTimeSetting

codegrade-16.1.65/codegrade/models/ai_assistant_enabled_setting.py

@@ -0,0 +1,56 @@
+"""The module that defines the ``AiAssistantEnabledSetting`` 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
+
+
+@dataclass
+class AiAssistantEnabledSetting:
+    """ """
+
+    name: "t.Literal['AI_ASSISTANT_ENABLED']"
+    value: "t.Optional[bool]"
+
+    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(
+                "name",
+                rqa.StringEnum("AI_ASSISTANT_ENABLED"),
+                doc="",
+            ),
+            rqa.RequiredArgument(
+                "value",
+                rqa.Nullable(rqa.SimpleValue.bool),
+                doc="",
+            ),
+        ).use_readable_describe(True)
+    )
+
+    def to_dict(self) -> t.Dict[str, t.Any]:
+        res: t.Dict[str, t.Any] = {
+            "name": to_dict(self.name),
+            "value": to_dict(self.value),
+        }
+        return res
+
+    @classmethod
+    def from_dict(
+        cls: t.Type["AiAssistantEnabledSetting"], d: t.Dict[str, t.Any]
+    ) -> "AiAssistantEnabledSetting":
+        parsed = cls.data_parser.try_parse(d)
+
+        res = cls(
+            name=parsed.name,
+            value=parsed.value,
+        )
+        res.raw_data = d
+        return res

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/all_site_settings.py

@@ -1000,6 +1000,10 @@ class AllSiteSettings(FrontendSiteSettings):
             res["CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION"] = to_dict(
                 self.code_editor_start_on_assignment_description.value
             )
+        if self.ai_assistant_enabled.is_just:
+            res["AI_ASSISTANT_ENABLED"] = to_dict(
+                self.ai_assistant_enabled.value
+            )
         if self.auto_test_heartbeat_interval.is_just:
             res["AUTO_TEST_HEARTBEAT_INTERVAL"] = to_dict(
                 self.auto_test_heartbeat_interval.value
@@ -1257,6 +1261,7 @@ class AllSiteSettings(FrontendSiteSettings):
             retry_group_submission_grade_passback_enabled=parsed.RETRY_GROUP_SUBMISSION_GRADE_PASSBACK_ENABLED,
             student_view_enabled=parsed.STUDENT_VIEW_ENABLED,
             code_editor_start_on_assignment_description=parsed.CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION,
+            ai_assistant_enabled=parsed.AI_ASSISTANT_ENABLED,
             auto_test_heartbeat_interval=parsed.AUTO_TEST_HEARTBEAT_INTERVAL,
             auto_test_heartbeat_max_missed=parsed.AUTO_TEST_HEARTBEAT_MAX_MISSED,
             auto_test_max_jobs_per_runner=parsed.AUTO_TEST_MAX_JOBS_PER_RUNNER,

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/assignment_feedback.py

@@ -21,7 +21,8 @@ class AssignmentFeedback:
     general: "str"
     #: The inline comments as a list of strings.
     user: "t.Sequence[str]"
-    #: The linter comments as a list of strings.
+    #: 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)
@@ -41,7 +42,10 @@ class AssignmentFeedback:
             rqa.RequiredArgument(
                 "linter",
                 rqa.List(rqa.SimpleValue.str),
-                doc="The linter comments as a list of strings.",
+                doc=(
+                    "The linter comments as a list of strings.  This field is"
+                    " deprecated and will always be empty."
+                ),
             ),
         ).use_readable_describe(True)
     )

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/feedback_base.py

@@ -8,9 +8,7 @@ from dataclasses import dataclass, field
 
 import cg_request_args as rqa
 
-from .. import parsers
 from ..utils import to_dict
-from .linter_comment import LinterComment
 
 
 @dataclass
@@ -22,8 +20,8 @@ class FeedbackBase:
     #: A mapping that is almost the same the user feedback mapping for feedback
     #: without replies, only the final key is not a string but a list of tuples
     #: where the first item is the linter code and the second item is linter
-    #: comments.
-    linter: "t.Mapping[str, t.Mapping[str, t.Sequence[t.Sequence[t.Union[LinterComment, str]]]]]"
+    #: comments.  This field is deprecated and will always be empty.
+    linter: "t.Mapping[str, t.Any]"
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -36,24 +34,14 @@ class FeedbackBase:
             ),
             rqa.RequiredArgument(
                 "linter",
-                rqa.LookupMapping(
-                    rqa.LookupMapping(
-                        rqa.List(
-                            rqa.List(
-                                parsers.make_union(
-                                    parsers.ParserFor.make(LinterComment),
-                                    rqa.SimpleValue.str,
-                                )
-                            )
-                        )
-                    )
-                ),
+                rqa.LookupMapping(rqa.AnyValue),
                 doc=(
                     "A mapping that is almost the same the user feedback"
                     " mapping for feedback without replies, only the final key"
                     " is not a string but a list of tuples where the first"
                     " item is the linter code and the second item is linter"
-                    " comments."
+                    " comments.  This field is deprecated and will always be"
+                    " empty."
                 ),
             ),
         ).use_readable_describe(True)

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/feedback_with_replies.py

@@ -103,6 +103,5 @@ import os
 
 if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
     # fmt: off
-    from .linter_comment import LinterComment
-
+    pass
     # fmt: on

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/feedback_without_replies.py

@@ -102,6 +102,5 @@ import os
 
 if os.getenv("CG_GENERATING_DOCS", "False").lower() in ("", "true"):
     # fmt: off
-    from .linter_comment import LinterComment
-
+    pass
     # fmt: on

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/frontend_site_settings.py

@@ -323,6 +323,9 @@ class FrontendSiteSettings:
     #: Whether to open the assignment description as the first file in the Code
     #: Editor, if the assignment has one, or the first file in the file tree.
     code_editor_start_on_assignment_description: Maybe["bool"] = Nothing
+    #: The main feature flag for all the AI assistant capabilities in
+    #: codegrade, whether we enable the ai assistant to be inside the app.
+    ai_assistant_enabled: Maybe["bool"] = Nothing
 
     raw_data: t.Optional[t.Dict[str, t.Any]] = field(init=False, repr=False)
 
@@ -1085,6 +1088,15 @@ class FrontendSiteSettings:
                     " the first file in the file tree."
                 ),
             ),
+            rqa.OptionalArgument(
+                "AI_ASSISTANT_ENABLED",
+                rqa.SimpleValue.bool,
+                doc=(
+                    "The main feature flag for all the AI assistant"
+                    " capabilities in codegrade, whether we enable the ai"
+                    " assistant to be inside the app."
+                ),
+            ),
         ).use_readable_describe(True)
     )
 
@@ -1356,6 +1368,9 @@ class FrontendSiteSettings:
         self.code_editor_start_on_assignment_description = maybe_from_nullable(
             self.code_editor_start_on_assignment_description
         )
+        self.ai_assistant_enabled = maybe_from_nullable(
+            self.ai_assistant_enabled
+        )
 
     def to_dict(self) -> t.Dict[str, t.Any]:
         res: t.Dict[str, t.Any] = {}
@@ -1713,6 +1728,10 @@ class FrontendSiteSettings:
             res["CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION"] = to_dict(
                 self.code_editor_start_on_assignment_description.value
             )
+        if self.ai_assistant_enabled.is_just:
+            res["AI_ASSISTANT_ENABLED"] = to_dict(
+                self.ai_assistant_enabled.value
+            )
         return res
 
     @classmethod
@@ -1814,6 +1833,7 @@ class FrontendSiteSettings:
             retry_group_submission_grade_passback_enabled=parsed.RETRY_GROUP_SUBMISSION_GRADE_PASSBACK_ENABLED,
             student_view_enabled=parsed.STUDENT_VIEW_ENABLED,
             code_editor_start_on_assignment_description=parsed.CODE_EDITOR_START_ON_ASSIGNMENT_DESCRIPTION,
+            ai_assistant_enabled=parsed.AI_ASSISTANT_ENABLED,
         )
         res.raw_data = d
         return res

{codegrade-16.1.63 → codegrade-16.1.65}/codegrade/models/site_setting_input.py

@@ -10,6 +10,7 @@ import cg_request_args as rqa
 
 from ..parsers import ParserFor, make_union
 from ..utils import to_dict
+from .ai_assistant_enabled_setting import AiAssistantEnabledSetting
 from .always_update_pii_with_lti_setting import AlwaysUpdatePiiWithLtiSetting
 from .analytics_enabled_setting import AnalyticsEnabledSetting
 from .assignment_default_grading_scale_points_setting import (
@@ -432,6 +433,7 @@ SiteSettingInput = t.Union[
     RetryGroupSubmissionGradePassbackEnabledSetting,
     StudentViewEnabledSetting,
     CodeEditorStartOnAssignmentDescriptionSetting,
+    AiAssistantEnabledSetting,
 ]
 SiteSettingInputParser = rqa.Lazy(
     lambda: make_union(
@@ -568,5 +570,6 @@ SiteSettingInputParser = rqa.Lazy(
         ParserFor.make(RetryGroupSubmissionGradePassbackEnabledSetting),
         ParserFor.make(StudentViewEnabledSetting),
         ParserFor.make(CodeEditorStartOnAssignmentDescriptionSetting),
+        ParserFor.make(AiAssistantEnabledSetting),
     ),
 )

{codegrade-16.1.63 → codegrade-16.1.65}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codegrade"
-version = "16.1.63"
+version = "16.1.65"
 description = "A client library for accessing CodeGrade"
 license = "AGPL-3.0-only OR BSD-3-Clause-Clear"
 authors = []

{codegrade-16.1.63 → codegrade-16.1.65}/setup.py

@@ -21,7 +21,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'codegrade',
-    'version': '16.1.63',
+    'version': '16.1.65',
     'description': 'A client library for accessing CodeGrade',
     'long_description': '# CodeGrade API\n\nThis library makes it easier to use the CodeGrade API. Its API allows you to\nautomate your usage of CodeGrade. We are currently still busy documenting the\nentire API, but everything that is possible in the UI of CodeGrade is also\npossible through the API.\n## Installation\nYou can install the library through [pypi](https://pypi.org/), simply run\n`python3 -m pip install codegrade`. If you want to get a dev version with support\nfor the latest features, simply email [support@codegrade.com](mailto:support@codegrade.com)\nand we\'ll provide you with a dev version.\n## Usage\nFirst, create a client:\n\n```python\nimport codegrade\n\n# Don\'t store your password in your code!\nwith codegrade.login(\n    username=\'my-username\',\n    password=os.getenv(\'CG_PASSWORD\'),\n    tenant=\'My University\',\n) as client:\n    pass\n\n# Or supply information interactively.\nwith codegrade.login_from_cli() as client:\n    pass\n```\n\nNow call your endpoint and use your models:\n\n```python\nfrom codegrade.models import PatchCourseData\n\ncourses = client.course.get_all()\nfor course in courses:\n    client.course.patch(\n        PatchCourseData(name=course.name + \' (NEW)\'),\n        course_id=course.id,\n    )\n\n# Or, simply use dictionaries.\nfor course in courses:\n    client.course.patch(\n        {"name": course.name + \' (NEW)\'},\n        course_id=course.id,\n    )\n```\n\nFor the complete documentation go to\nhttps://python.api.codegrade.com.\n## Backwards compatibility\nCodeGrade is constantly upgrading its API, but we try to minimize backwards\nincompatible changes. We\'ll announce every backwards incompatible change in the\n[changelog](http://codegrade.com/changelog). A new version of the API\nclient is released with every release of CodeGrade, which is approximately every\nmonth. To upgrade simply run `pip install --upgrade codegrade`.\n## Supported python versions\nWe support python 3.6 and above, `pypy` is currently not tested but should work\njust fine.\n## License\nThe library is licensed under AGPL-3.0-only or BSD-3-Clause-Clear.',
     'author': 'None',

codegrade-16.1.63/codegrade/models/linter_comment.py

@@ -1,70 +0,0 @@
-"""The module that defines the ``LinterComment`` 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
-
-
-@dataclass
-class LinterComment:
-    """A old style linter comment."""
-
-    #: The code produced by the linter. The meaning depends on the linter used.
-    code: "str"
-    #: The line the comment was placed on.
-    line: "int"
-    #: The message of the comment.
-    msg: "t.Optional[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(
-                "code",
-                rqa.SimpleValue.str,
-                doc=(
-                    "The code produced by the linter. The meaning depends on"
-                    " the linter used."
-                ),
-            ),
-            rqa.RequiredArgument(
-                "line",
-                rqa.SimpleValue.int,
-                doc="The line the comment was placed on.",
-            ),
-            rqa.RequiredArgument(
-                "msg",
-                rqa.Nullable(rqa.SimpleValue.str),
-                doc="The message of the comment.",
-            ),
-        ).use_readable_describe(True)
-    )
-
-    def to_dict(self) -> t.Dict[str, t.Any]:
-        res: t.Dict[str, t.Any] = {
-            "code": to_dict(self.code),
-            "line": to_dict(self.line),
-            "msg": to_dict(self.msg),
-        }
-        return res
-
-    @classmethod
-    def from_dict(
-        cls: t.Type["LinterComment"], d: t.Dict[str, t.Any]
-    ) -> "LinterComment":
-        parsed = cls.data_parser.try_parse(d)
-
-        res = cls(
-            code=parsed.code,
-            line=parsed.line,
-            msg=parsed.msg,
-        )
-        res.raw_data = d
-        return res