codegrade 16.1.9__tar.gz → 16.1.14__tar.gz

{codegrade-16.1.9 → codegrade-16.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codegrade
-Version: 16.1.9
+Version: 16.1.14
 Summary: A client library for accessing CodeGrade
 License: AGPL-3.0-only OR BSD-3-Clause-Clear
 Requires-Python: >=3.6.1,<4.0
@@ -15,7 +15,7 @@ Requires-Dist: dataclasses (>=0.8,<0.9) ; python_version >= "3.6" and python_ver
 Requires-Dist: httpx (>=0.19.0,<1.0.0)
 Requires-Dist: python-dateutil (>=2.8.1,<3.0.0)
 Requires-Dist: structlog (>=20.1.0,<21.0.0)
-Requires-Dist: typing-extensions (>=3.7.4.3,<4.0.0.0)
+Requires-Dist: typing-extensions (>=4.0.0.0,<5.0.0.0)
 Requires-Dist: validate-email (>=1.3,<2.0)
 Project-URL: Documentation, https://python.api.codegrade.com
 Description-Content-Type: text/markdown

{codegrade-16.1.9 → codegrade-16.1.14}/cg_dt_utils/__init__.py

@@ -195,6 +195,7 @@ else:
             return dt
 
     DatetimeWithTimezone.max = datetime.datetime.max.replace(tzinfo=_utc)
+    DatetimeWithTimezone.min = datetime.datetime.min.replace(tzinfo=_utc)
 
 
 class Months(enum.IntEnum):

{codegrade-16.1.9 → codegrade-16.1.14}/cg_maybe/_just.py

@@ -339,6 +339,11 @@ class Just(t.Generic[_T]):
         """
         return self.value == val
 
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, Just):
+            return self.value == other.value
+        return NotImplemented
+
     def ne(  # pylint: disable=invalid-name
         self: 'Just[_Y]',
         val: _Y,

{codegrade-16.1.9 → codegrade-16.1.14}/cg_maybe/_nothing.py

@@ -24,6 +24,9 @@ class _Nothing(t.Generic[_T]):
     """
     __slots__ = ()
 
+    def __hash__(self) -> int:
+        return hash('cg_maybe.Nothing')
+
     is_just: Literal[False] = False
     is_nothing: Literal[True] = True
 
@@ -108,6 +111,11 @@ class _Nothing(t.Generic[_T]):
     def __repr__(self) -> str:
         return 'Nothing'
 
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, _Nothing):
+            return True
+        return NotImplemented
+
     def __structlog__(self) -> t.Mapping[str, object]:
         return {'type': 'Nothing'}
 

{codegrade-16.1.9 → codegrade-16.1.14}/cg_maybe/utils.py

@@ -8,6 +8,7 @@ from ._just import Just
 from ._maybe import Maybe
 from ._nothing import Nothing
 from ._type_helpers import Literal
+from ._type_helpers import SupportsLessThan as _SupportsLessThan
 
 _S = t.TypeVar('_S')
 _T = t.TypeVar('_T')
@@ -161,3 +162,61 @@ def encase(
         return Nothing
     else:
         return Just(val)
+
+
+def min(items: t.Iterator[_SupportsLessThan[_T]]) -> Maybe[_T]:  # pylint: disable=redefined-builtin
+    """Get the minimum value for a iterator.
+
+    >>> min([])
+    Nothing
+    >>> min([1, 2, 3])
+    Just(1)
+    >>> min([3, 1, 2])
+    Just(1)
+
+    :param items: The item to get the minimum for.
+    :returns: Maybe the minimum item, if the sequence was not empty.
+    """
+    best: None | _SupportsLessThan = None
+    done_any = False
+    for item in items:
+        done_any = True
+        if best is None or item < best:
+            best = item
+
+    if done_any:
+        # At this point best can be `None`, if any item in `items` was
+        # none. But it should never be unset.
+        return Just(t.cast(_T, best))
+
+    return Nothing
+
+
+def max(items: t.Iterator[_SupportsLessThan[_T]]) -> Maybe[_T]:  # pylint: disable=redefined-builtin
+    """Get the maximum value for a iterator.
+
+    >>> max([])
+    Nothing
+    >>> max([1, 2, 3])
+    Just(3)
+    >>> max([3, 1, 2])
+    Just(3)
+    >>> max([2, 3, 1])
+    Just(3)
+
+    :param items: The item to get the maximum for.
+    :returns: Maybe the maximum item, if the sequence was not empty.
+    """
+    best: None | _SupportsLessThan = None
+    done_any = False
+    for item in items:
+        done_any = True
+        if best is None or item > best:
+            best = item
+
+    if done_any:
+        # At this point best can be `None`, if any item in `items` was
+        # none. But it should never be unset.
+        return Just(t.cast(_T, best))
+
+    return Nothing

{codegrade-16.1.9 → codegrade-16.1.14}/cg_request_args/__init__.py

@@ -5,6 +5,7 @@ SPDX-License-Identifier: AGPL-3.0-only OR BSD-3-Clause-Clear
 
 from ._base import Union, Parser, SimpleValue
 from ._enum import EnumValue, StringEnum
+from ._form import FormURLEncoded
 from ._lazy import Lazy
 from ._list import List, TwoTuple
 from ._query import QueryParam

codegrade-16.1.14/cg_request_args/_form.py

@@ -0,0 +1,60 @@
+"""This module contains logic to parse flaks x-www-form-urlencoded requests.
+"""
+import typing as t
+
+from ._base import Parser as _Parser
+from ._utils import USE_SLOTS as _USE_SLOTS
+from ._utils import T as _T
+from ._swagger_utils import Schema as _Schema
+from ._swagger_utils import OpenAPISchema as _OpenAPISchema
+from ._swagger_utils import maybe_raise_schema as _maybe_raise_schema
+
+try:
+    import flask
+except ImportError:  # pragma: no cover
+    pass
+
+if t.TYPE_CHECKING:  # pragma: no cover
+    # pylint: disable=unused-import
+    from werkzeug.datastructures import FileStorage
+
+    from ._base import LogReplacer as _LogReplacer
+
+
+class FormURLEncoded(t.Generic[_T]):
+    """This class helps you parse JSON and files from the same request.
+    """
+    if _USE_SLOTS:
+        __slots__ = ('__parser', )
+
+    def __init__(
+        self,
+        parser: _Parser[_T],
+    ) -> None:
+        self.__parser = parser
+
+    def __generate_schema(self, open_api: _OpenAPISchema) -> _Schema:
+        json_schema = self.__parser.to_open_api(open_api)
+        return _Schema(
+            typ='multipart/form-data',
+            schema=json_schema,
+        )
+
+    def from_flask(
+        self,
+        *,
+        log_replacer: '_LogReplacer' = None,
+    ) -> _T:
+        """Parse a multipart request from the current flask request.
+
+        :param log_replacer: If passed this function should remove any
+            sensitive data from the logs.
+
+        :returns: A tuple, where the first item is the parsed JSON (according
+                  to the given parser), and the second argument is a list of
+                  the parsed files.
+        """
+        _maybe_raise_schema(self.__generate_schema)
+
+        body = flask.request.form
+        return self.__parser.try_parse_and_log(body, log_replacer=log_replacer)

{codegrade-16.1.9 → codegrade-16.1.14}/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.9"
+__version__ = "16.1.14"
 
 
 @wraps(AuthenticatedClient.get)

{codegrade-16.1.9 → codegrade-16.1.14}/codegrade/_api/about.py

@@ -75,7 +75,7 @@ class AboutService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),

{codegrade-16.1.9 → codegrade-16.1.14}/codegrade/_api/assignment.py

@@ -25,6 +25,7 @@ if t.TYPE_CHECKING or os.getenv("CG_EAGERIMPORT", False):
         AssignmentPeerFeedbackSettings,
     )
     from ..models.assignment_template import AssignmentTemplate
+    from ..models.assignment_timeframes import AssignmentTimeframes
     from ..models.auto_test import AutoTest
     from ..models.comment_base import CommentBase
     from ..models.copy_rubric_assignment_data import CopyRubricAssignmentData
@@ -106,7 +107,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -160,7 +161,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -204,7 +205,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -263,7 +264,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -310,7 +311,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -353,7 +354,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -407,7 +408,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -440,11 +441,11 @@ class AssignmentService(t.Generic[_ClientT]):
         )
         params = extra_parameters or {}
 
+        data, files = utils.to_multipart(utils.to_dict(multipart_data))
+
         with self.__client as client:
             resp = client.http.put(
-                url=url,
-                files=utils.to_multipart(utils.to_dict(multipart_data)),
-                params=params,
+                url=url, files=files, data=data, params=params
             )
         utils.log_warnings(resp)
 
@@ -459,7 +460,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -502,7 +503,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -549,7 +550,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -592,7 +593,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -654,7 +655,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -700,7 +701,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -754,7 +755,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -804,7 +805,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -851,7 +852,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -903,7 +904,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -965,7 +966,110 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
+                    utils.unpack_union(AnyError),
+                ),
+            ),
+        )
+
+    def get_timeframes(
+        self: "AssignmentService[codegrade.client.AuthenticatedClient]",
+        *,
+        assignment_id: "int",
+        extra_parameters: t.Mapping[
+            str, t.Union[str, bool, int, float]
+        ] = None,
+    ) -> "AssignmentTimeframes":
+        """Get the description for this assignment.
+
+        :param assignment_id: The id of the assignment;
+        :param extra_parameters: The extra query parameters you might want to
+            add. By default no extra query parameters are added.
+
+        :returns: A public link that allows users to download the file or the
+                  file itself as a stream of octets
+        """
+
+        url = "/api/v1/assignments/{assignmentId}/timeframes/".format(
+            assignmentId=assignment_id
+        )
+        params = extra_parameters or {}
+
+        with self.__client as client:
+            resp = client.http.get(url=url, params=params)
+        utils.log_warnings(resp)
+
+        if utils.response_code_matches(resp.status_code, 200):
+            # fmt: off
+            from ..models.assignment_timeframes import AssignmentTimeframes
+
+            # fmt: on
+            return parsers.JsonResponseParser(
+                parsers.ParserFor.make(AssignmentTimeframes)
+            ).try_parse(resp)
+
+        from ..models.any_error import AnyError
+
+        raise utils.get_error(
+            resp,
+            (
+                (
+                    (400, 409, 401, 403, 404, 429, "5XX"),
+                    utils.unpack_union(AnyError),
+                ),
+            ),
+        )
+
+    def put_timeframes(
+        self: "AssignmentService[codegrade.client.AuthenticatedClient]",
+        json_body: t.Union[dict, list, "AssignmentTimeframes"],
+        *,
+        assignment_id: "int",
+        extra_parameters: t.Mapping[
+            str, t.Union[str, bool, int, float]
+        ] = None,
+    ) -> "AssignmentTimeframes":
+        """Get the description for this assignment.
+
+        :param json_body: The body of the request. See
+            :class:`.AssignmentTimeframes` for information about the possible
+            fields. You can provide this data as a
+            :class:`.AssignmentTimeframes` or as a dictionary.
+        :param assignment_id: The id of the assignment;
+        :param extra_parameters: The extra query parameters you might want to
+            add. By default no extra query parameters are added.
+
+        :returns: A public link that allows users to download the file or the
+                  file itself as a stream of octets
+        """
+
+        url = "/api/v1/assignments/{assignmentId}/timeframes/".format(
+            assignmentId=assignment_id
+        )
+        params = extra_parameters or {}
+
+        with self.__client as client:
+            resp = client.http.put(
+                url=url, json=utils.to_dict(json_body), params=params
+            )
+        utils.log_warnings(resp)
+
+        if utils.response_code_matches(resp.status_code, 200):
+            # fmt: off
+            from ..models.assignment_timeframes import AssignmentTimeframes
+
+            # fmt: on
+            return parsers.JsonResponseParser(
+                parsers.ParserFor.make(AssignmentTimeframes)
+            ).try_parse(resp)
+
+        from ..models.any_error import AnyError
+
+        raise utils.get_error(
+            resp,
+            (
+                (
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1014,7 +1118,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1063,7 +1167,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1124,7 +1228,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1172,7 +1276,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1240,7 +1344,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1292,7 +1396,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1349,7 +1453,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1397,7 +1501,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1452,7 +1556,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1509,7 +1613,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1556,7 +1660,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1604,7 +1708,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1640,11 +1744,11 @@ class AssignmentService(t.Generic[_ClientT]):
         )
         params = extra_parameters or {}
 
+        data, files = utils.to_multipart(utils.to_dict(multipart_data))
+
         with self.__client as client:
             resp = client.http.patch(
-                url=url,
-                files=utils.to_multipart(utils.to_dict(multipart_data)),
-                params=params,
+                url=url, files=files, data=data, params=params
             )
         utils.log_warnings(resp)
 
@@ -1663,7 +1767,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),
@@ -1713,11 +1817,11 @@ class AssignmentService(t.Generic[_ClientT]):
             lambda val: params.__setitem__("author_id", val)
         )
 
+        data, files = utils.to_multipart(utils.to_dict(multipart_data))
+
         with self.__client as client:
             resp = client.http.post(
-                url=url,
-                files=utils.to_multipart(utils.to_dict(multipart_data)),
-                params=params,
+                url=url, files=files, data=data, params=params
             )
         utils.log_warnings(resp)
 
@@ -1736,7 +1840,7 @@ class AssignmentService(t.Generic[_ClientT]):
             resp,
             (
                 (
-                    (400, 409, 401, 403, 404, "5XX"),
+                    (400, 409, 401, 403, 404, 429, "5XX"),
                     utils.unpack_union(AnyError),
                 ),
             ),