Add retry strategy to clients. Make submissions and test cases iterable. Increase retry frequency for default implicit Sulu client.

Author: fkdosilovic

src/judge0/__init__.py

@@ -98,9 +98,9 @@ def _get_implicit_client(flavor: Flavor) -> Client:
     # the preview Sulu client based on the flavor.
     if client is None:
         if flavor == Flavor.CE:
-            client = SuluJudge0CE()
+            client = SuluJudge0CE(retry_strategy=RegularPeriodRetry(0.5))
         else:
-            client = SuluJudge0ExtraCE()
+            client = SuluJudge0ExtraCE(retry_strategy=RegularPeriodRetry(0.5))
 
     if flavor == Flavor.CE:
         JUDGE0_IMPLICIT_CE_CLIENT = client

src/judge0/api.py

@@ -1,10 +1,10 @@
-from typing import Iterable, Optional, Union
+from typing import Optional, Union
 
-from .base_types import Flavor, TestCase, TestCases
+from .base_types import Flavor, Iterable, TestCase, TestCases
 from .clients import Client
 from .common import batched
 
-from .retry import RegularPeriodRetry, RetryMechanism
+from .retry import RegularPeriodRetry, RetryStrategy
 from .submission import Submission, Submissions
 
 
@@ -31,7 +31,7 @@ def _resolve_client(
     if isinstance(client, Flavor):
         return get_client(client)
 
-    if client is None and isinstance(submissions, list) and len(submissions) == 0:
+    if client is None and isinstance(submissions, Iterable) and len(submissions) == 0:
         raise ValueError("Client cannot be determined from empty submissions.")
 
     # client is None and we have to determine a flavor of the client from the
@@ -57,6 +57,7 @@ def _resolve_client(
 
 
 def create_submissions(
+    *,
     client: Optional[Client] = None,
     submissions: Optional[Union[Submission, Submissions]] = None,
 ) -> Union[Submission, Submissions]:
@@ -81,7 +82,7 @@ def get_submissions(
     *,
     client: Optional[Client] = None,
     submissions: Optional[Union[Submission, Submissions]] = None,
-    fields: Union[str, Iterable[str], None] = None,
+    fields: Optional[Union[str, Iterable[str]]] = None,
 ) -> Union[Submission, Submissions]:
     client = _resolve_client(client=client, submissions=submissions)
 
@@ -108,12 +109,15 @@ def wait(
     *,
     client: Optional[Client] = None,
     submissions: Optional[Union[Submission, Submissions]] = None,
-    retry_mechanism: Optional[RetryMechanism] = None,
+    retry_strategy: Optional[RetryStrategy] = None,
 ) -> Union[Submission, Submissions]:
     client = _resolve_client(client, submissions)
 
-    if retry_mechanism is None:
-        retry_mechanism = RegularPeriodRetry()
+    if retry_strategy is None:
+        if client.retry_strategy is None:
+            retry_strategy = RegularPeriodRetry()
+        else:
+            retry_strategy = client.retry_strategy
 
     if isinstance(submissions, Submission):
         submissions_to_check = {
@@ -124,7 +128,7 @@ def wait(
             submission.token: submission for submission in submissions
         }
 
-    while len(submissions_to_check) > 0 and not retry_mechanism.is_done():
+    while len(submissions_to_check) > 0 and not retry_strategy.is_done():
         get_submissions(client=client, submissions=list(submissions_to_check.values()))
         for token in list(submissions_to_check):
             submission = submissions_to_check[token]
@@ -135,8 +139,8 @@ def wait(
         if len(submissions_to_check) == 0:
             break
 
-        retry_mechanism.wait()
-        retry_mechanism.step()
+        retry_strategy.wait()
+        retry_strategy.step()
 
     return submissions
 
@@ -204,6 +208,7 @@ def _execute(
     if submissions is None and source_code is None:
         raise ValueError("Neither source_code nor submissions argument are provided.")
 
+    # Internally, let's rely on Submission's dataclass.
     if source_code is not None:
         submissions = Submission(source_code=source_code, **kwargs)
 

src/judge0/base_types.py

@@ -1,19 +1,11 @@
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from enum import IntEnum
-from typing import Optional, Union
-
-
-TestCases = Union[
-    list["TestCase"],
-    tuple["TestCase"],
-    list[dict],
-    tuple[dict],
-    list[list],
-    list[tuple],
-    tuple[list],
-    tuple[tuple],
-]
+from typing import Optional, Sequence, Union
+
+Iterable = Sequence
+
+TestCases = Iterable["TestCase"]
 
 
 @dataclass(frozen=True)

src/judge0/clients.py

@@ -1,26 +1,29 @@
-from typing import Iterable, Union
+from typing import Optional, Union
 
 import requests
 
-from .base_types import Config, Language, LanguageAlias
+from .base_types import Config, Iterable, Language, LanguageAlias
 from .data import LANGUAGE_TO_LANGUAGE_ID
+from .retry import RetryStrategy
 from .submission import Submission, Submissions
 
 
 class Client:
-    API_KEY_ENV = "JUDGE0_API_KEY"
-    DEFAULT_MAX_SUBMISSION_BATCH_SIZE = 20
-    ENABLED_BATCHED_SUBMISSIONS = True
-    EFFECTIVE_SUBMISSION_BATCH_SIZE = (
-        DEFAULT_MAX_SUBMISSION_BATCH_SIZE if ENABLED_BATCHED_SUBMISSIONS else 1
-    )
+    API_KEY_ENV = None
 
-    def __init__(self, endpoint, auth_headers) -> None:
+    def __init__(
+        self,
+        endpoint,
+        auth_headers,
+        *,
+        retry_strategy: Optional[RetryStrategy] = None,
+    ) -> None:
         self.endpoint = endpoint
         self.auth_headers = auth_headers
+        self.retry_strategy = retry_strategy
 
         try:
-            self.languages = [Language(**lang) for lang in self.get_languages()]
+            self.languages = tuple(Language(**lang) for lang in self.get_languages())
             self.config = Config(**self.get_config_info())
         except Exception as e:
             raise RuntimeError(
@@ -113,7 +116,7 @@ def get_submission(
         self,
         submission: Submission,
         *,
-        fields: Union[str, Iterable[str], None] = None,
+        fields: Optional[Union[str, Iterable[str]]] = None,
     ) -> Submission:
         """Check the submission status."""
 
@@ -168,7 +171,7 @@ def get_submissions(
         self,
         submissions: Submissions,
         *,
-        fields: Union[str, Iterable[str], None] = None,
+        fields: Optional[Union[str, Iterable[str]]] = None,
     ) -> Submissions:
         params = {
             "base64_encoded": "true",
@@ -201,14 +204,15 @@ def get_submissions(
 class ATD(Client):
     API_KEY_ENV = "JUDGE0_ATD_API_KEY"
 
-    def __init__(self, endpoint, host_header_value, api_key):
+    def __init__(self, endpoint, host_header_value, api_key, **kwargs):
         self.api_key = api_key
         super().__init__(
             endpoint,
             {
                 "x-apihub-host": host_header_value,
                 "x-apihub-key": api_key,
             },
+            **kwargs,
         )
 
     def _update_endpoint_header(self, header_value):
@@ -232,11 +236,12 @@ class ATDJudge0CE(ATD):
     DEFAULT_CREATE_SUBMISSIONS_ENDPOINT: str = "402b857c-1126-4450-bfd8-22e1f2cbff2f"
     DEFAULT_GET_SUBMISSIONS_ENDPOINT: str = "e42f2a26-5b02-472a-80c9-61c4bdae32ec"
 
-    def __init__(self, api_key):
+    def __init__(self, api_key, **kwargs):
         super().__init__(
             self.DEFAULT_ENDPOINT,
             self.DEFAULT_HOST,
             api_key,
+            **kwargs,
         )
 
     def get_about(self) -> dict:
@@ -267,7 +272,7 @@ def get_submission(
         self,
         submission: Submission,
         *,
-        fields: Union[str, Iterable[str], None] = None,
+        fields: Optional[Union[str, Iterable[str]]] = None,
     ) -> Submission:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSION_ENDPOINT)
         return super().get_submission(submission, fields=fields)
@@ -280,7 +285,7 @@ def get_submissions(
         self,
         submissions: Submissions,
         *,
-        fields: Union[str, Iterable[str], None] = None,
+        fields: Optional[Union[str, Iterable[str]]] = None,
     ) -> Submissions:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSIONS_ENDPOINT)
         return super().get_submissions(submissions, fields=fields)
@@ -303,11 +308,12 @@ class ATDJudge0ExtraCE(ATD):
     DEFAULT_CREATE_SUBMISSIONS_ENDPOINT: str = "c64df5d3-edfd-4b08-8687-561af2f80d2f"
     DEFAULT_GET_SUBMISSIONS_ENDPOINT: str = "5d173718-8e6a-4cf5-9d8c-db5e6386d037"
 
-    def __init__(self, api_key):
+    def __init__(self, api_key, **kwargs):
         super().__init__(
             self.DEFAULT_ENDPOINT,
             self.DEFAULT_HOST,
             api_key,
+            **kwargs,
         )
 
     def get_about(self) -> dict:
@@ -338,7 +344,7 @@ def get_submission(
         self,
         submission: Submission,
         *,
-        fields: Union[str, Iterable[str], None] = None,
+        fields: Optional[Union[str, Iterable[str]]] = None,
     ) -> Submission:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSION_ENDPOINT)
         return super().get_submission(submission, fields=fields)
@@ -351,7 +357,7 @@ def get_submissions(
         self,
         submissions: Submissions,
         *,
-        fields: Union[str, Iterable[str], None] = None,
+        fields: Optional[Union[str, Iterable[str]]] = None,
     ) -> Submissions:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSIONS_ENDPOINT)
         return super().get_submissions(submissions, fields=fields)
@@ -360,14 +366,15 @@ def get_submissions(
 class Rapid(Client):
     API_KEY_ENV = "JUDGE0_RAPID_API_KEY"
 
-    def __init__(self, endpoint, host_header_value, api_key):
+    def __init__(self, endpoint, host_header_value, api_key, **kwargs):
         self.api_key = api_key
         super().__init__(
             endpoint,
             {
                 "x-rapidapi-host": host_header_value,
                 "x-rapidapi-key": api_key,
             },
+            **kwargs,
         )
 
 
@@ -376,11 +383,12 @@ class RapidJudge0CE(Rapid):
     DEFAULT_HOST: str = "judge0-ce.p.rapidapi.com"
     HOME_URL: str = "https://rapidapi.com/judge0-official/api/judge0-ce"
 
-    def __init__(self, api_key):
+    def __init__(self, api_key, **kwargs):
         super().__init__(
             self.DEFAULT_ENDPOINT,
             self.DEFAULT_HOST,
             api_key,
+            **kwargs,
         )
 
 
@@ -389,40 +397,46 @@ class RapidJudge0ExtraCE(Rapid):
     DEFAULT_HOST: str = "judge0-extra-ce.p.rapidapi.com"
     HOME_URL: str = "https://rapidapi.com/judge0-official/api/judge0-extra-ce"
 
-    def __init__(self, api_key):
+    def __init__(self, api_key, **kwargs):
         super().__init__(
             self.DEFAULT_ENDPOINT,
             self.DEFAULT_HOST,
             api_key,
+            **kwargs,
         )
 
 
 class Sulu(Client):
     API_KEY_ENV = "JUDGE0_SULU_API_KEY"
 
-    def __init__(self, endpoint, api_key=None):
+    def __init__(self, endpoint, api_key=None, **kwargs):
         self.api_key = api_key
         super().__init__(
             endpoint,
             {"Authorization": f"Bearer {api_key}"} if api_key else None,
+            **kwargs,
         )
 
 
 class SuluJudge0CE(Sulu):
     DEFAULT_ENDPOINT: str = "https://judge0-ce.p.sulu.sh"
     HOME_URL: str = "https://sparkhub.sulu.sh/apis/judge0/judge0-ce/readme"
 
-    def __init__(self, api_key=None):
-        super().__init__(self.DEFAULT_ENDPOINT, api_key)
+    def __init__(self, api_key=None, **kwargs):
+        super().__init__(
+            self.DEFAULT_ENDPOINT,
+            api_key,
+            **kwargs,
+        )
 
 
 class SuluJudge0ExtraCE(Sulu):
     DEFAULT_ENDPOINT: str = "https://judge0-extra-ce.p.sulu.sh"
     HOME_URL: str = "https://sparkhub.sulu.sh/apis/judge0/judge0-extra-ce/readme"
 
-    def __init__(self, api_key=None):
-        super().__init__(self.DEFAULT_ENDPOINT, api_key)
+    def __init__(self, api_key=None, **kwargs):
+        super().__init__(self.DEFAULT_ENDPOINT, api_key, **kwargs)
 
 
-CE = [RapidJudge0CE, SuluJudge0CE, ATDJudge0CE]
-EXTRA_CE = [RapidJudge0ExtraCE, SuluJudge0ExtraCE, ATDJudge0ExtraCE]
+CE = (RapidJudge0CE, SuluJudge0CE, ATDJudge0CE)
+EXTRA_CE = (RapidJudge0ExtraCE, SuluJudge0ExtraCE, ATDJudge0ExtraCE)

src/judge0/filesystem.py

@@ -3,10 +3,9 @@
 import zipfile
 
 from base64 import b64decode, b64encode
-from collections import abc
-from typing import Iterable, Optional, Union
+from typing import Optional, Union
 
-from .base_types import Encodeable
+from .base_types import Encodeable, Iterable
 
 
 class File:
@@ -42,7 +41,7 @@ def __init__(
                 for file_name in zip_file.namelist():
                     with zip_file.open(file_name) as fp:
                         self.files.append(File(file_name, fp.read()))
-        elif isinstance(content, abc.Iterable):
+        elif isinstance(content, Iterable):
             self.files = list(content)
         elif isinstance(content, File):
             self.files = [content]