Add async_execute, sync_execute, execute. Separate wait from client

fkdosilovic · fkdosilovic · commit 891ddad7a8ef · 2024-11-03T19:12:21.000+01:00
diff --git a/examples/atd_submission.py b/examples/atd_submission.py
@@ -17,8 +17,7 @@ def run_example(client_class, language_id):
         expected_output="Hello Judge0",
     )
 
-    client.create_submission(submission)
-    client.wait(submission)
+    judge0.execute(client=client, submissions=submission)
 
     print(f"{submission.status=}")
     print(f"{submission.stdout=}")
diff --git a/examples/atd_submissions.py b/examples/atd_submissions.py
@@ -23,8 +23,7 @@ def run_example(client_class, lang_id_python, lang_id_c):
     )
 
     submissions = [submission1, submission2]
-    client.create_submissions(submissions)
-    client.wait(submissions)
+    judge0.execute(client=client, submissions=submissions)
 
     for submission in submissions:
         print(f"{submission.status=}")
diff --git a/examples/rapid_submission.py b/examples/rapid_submission.py
@@ -17,8 +17,7 @@ def run_example(client_class, language_id):
         expected_output="Hello Judge0",
     )
 
-    client.create_submission(submission)
-    client.wait(submission)
+    judge0.execute(client=client, submissions=submission)
 
     print(f"{submission.status=}")
     print(f"{submission.stdout=}")
diff --git a/examples/rapid_submissions.py b/examples/rapid_submissions.py
@@ -23,8 +23,7 @@ def run_example(client_class, lang_id_python, lang_id_c):
     )
 
     submissions = [submission1, submission2]
-    client.create_submissions(submissions)
-    client.wait(submissions)
+    judge0.execute(client=client, submissions=submissions)
 
     for submission in submissions:
         print(f"{submission.status=}")
diff --git a/examples/sulu_submission.py b/examples/sulu_submission.py
@@ -17,8 +17,7 @@ def run_example(client_class, language_id):
         expected_output="Hello Judge0",
     )
 
-    client.create_submission(submission)
-    client.wait(submission)
+    judge0.execute(client=client, submissions=submission)
 
     print(f"{submission.status=}")
     print(f"{submission.stdout=}")
diff --git a/examples/sulu_submissions.py b/examples/sulu_submissions.py
@@ -23,8 +23,7 @@ def run_example(client_class, lang_id_python, lang_id_c):
     )
 
     submissions = [submission1, submission2]
-    client.create_submissions(submissions)
-    client.wait(submissions)
+    judge0.execute(client=client, submissions=submissions)
 
     for submission in submissions:
         print(f"{submission.status=}")
diff --git a/src/judge0/__init__.py b/src/judge0/__init__.py
@@ -1,11 +1,15 @@
 from .clients import (
+    async_execute,
     ATDJudge0CE,
     ATDJudge0ExtraCE,
     Client,
+    execute,
     RapidJudge0CE,
     RapidJudge0ExtraCE,
     SuluJudge0CE,
     SuluJudge0ExtraCE,
+    sync_execute,
+    wait,
 )
 from .retry import MaxRetries, MaxWaitTime, RegularPeriodRetry
 
@@ -23,4 +27,8 @@
     RegularPeriodRetry,
     MaxRetries,
     MaxWaitTime,
+    async_execute,
+    sync_execute,
+    execute,
+    wait,
 ]
diff --git a/src/judge0/clients.py b/src/judge0/clients.py
@@ -55,7 +55,7 @@ def get_statuses(self) -> list[dict]:
     def is_language_supported(self, language_id: int) -> bool:
         return language_id in self.languages
 
-    def create_submission(self, submission: Submission) -> None:
+    def create_submission(self, submission: Submission) -> Submission:
         # Check if submission contains supported language.
         if not self.is_language_supported(language_id=submission.language_id):
             raise RuntimeError(
@@ -80,12 +80,14 @@ def create_submission(self, submission: Submission) -> None:
 
         submission.set_attributes(resp.json())
 
+        return submission
+
     def get_submission(
         self,
         submission: Submission,
         *,
         fields: Union[str, Iterable[str], None] = None,
-    ) -> None:
+    ) -> Submission:
         """Check the submission status."""
 
         params = {
@@ -109,7 +111,9 @@ def get_submission(
 
         submission.set_attributes(resp.json())
 
-    def create_submissions(self, submissions: list[Submission]) -> None:
+        return submission
+
+    def create_submissions(self, submissions: list[Submission]) -> list[Submission]:
         # Check if all submissions contain supported language.
         for submission in submissions:
             if not self.is_language_supported(language_id=submission.language_id):
@@ -131,12 +135,14 @@ def create_submissions(self, submissions: list[Submission]) -> None:
         for submission, attrs in zip(submissions, resp.json()):
             submission.set_attributes(attrs)
 
+        return submissions
+
     def get_submissions(
         self,
         submissions: list[Submission],
         *,
         fields: Union[str, Iterable[str], None] = None,
-    ) -> None:
+    ) -> list[Submission]:
         params = {
             "base64_encoded": "true",
         }
@@ -162,35 +168,7 @@ def get_submissions(
         for submission, attrs in zip(submissions, resp.json()["submissions"]):
             submission.set_attributes(attrs)
 
-    def wait(
-        self,
-        submissions: Union[Submission, list[Submission]],
-        *,
-        retry_mechanism: Optional[RetryMechanism] = None,
-    ):
-        if retry_mechanism is None:
-            retry_mechanism = RegularPeriodRetry()
-
-        if not isinstance(submissions, (list, tuple)):
-            submissions = [submissions]
-
-        submissions_to_check = {
-            submission.token: submission for submission in submissions
-        }
-
-        while len(submissions_to_check) > 0 and not retry_mechanism.is_done():
-            self.get_submissions(submissions_to_check.values())
-            for token in list(submissions_to_check):
-                submission = submissions_to_check[token]
-                if submission.is_done():
-                    submissions_to_check.pop(token)
-
-            # Don't wait if there is no submissions to check for anymore.
-            if len(submissions_to_check) == 0:
-                break
-
-            retry_mechanism.wait()
-            retry_mechanism.step()
+        return submissions
 
 
 class ATD(Client):
@@ -249,7 +227,7 @@ def get_statuses(self) -> list[dict]:
         self._update_endpoint_header(self.DEFAULT_STATUSES_ENDPOINT)
         return super().get_statuses()
 
-    def create_submission(self, submission: Submission) -> None:
+    def create_submission(self, submission: Submission) -> Submission:
         self._update_endpoint_header(self.DEFAULT_CREATE_SUBMISSION_ENDPOINT)
         return super().create_submission(submission)
 
@@ -258,11 +236,11 @@ def get_submission(
         submission: Submission,
         *,
         fields: Union[str, Iterable[str], None] = None,
-    ) -> None:
+    ) -> Submission:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSION_ENDPOINT)
         return super().get_submission(submission, fields=fields)
 
-    def create_submissions(self, submissions: list[Submission]) -> None:
+    def create_submissions(self, submissions: list[Submission]) -> list[Submission]:
         self._update_endpoint_header(self.DEFAULT_CREATE_SUBMISSIONS_ENDPOINT)
         return super().create_submissions(submissions)
 
@@ -271,7 +249,7 @@ def get_submissions(
         submissions: list[Submission],
         *,
         fields: Union[str, Iterable[str], None] = None,
-    ) -> None:
+    ) -> list[Submission]:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSIONS_ENDPOINT)
         return super().get_submissions(submissions, fields=fields)
 
@@ -317,7 +295,7 @@ def get_statuses(self) -> list[dict]:
         self._update_endpoint_header(self.DEFAULT_STATUSES_ENDPOINT)
         return super().get_statuses()
 
-    def create_submission(self, submission: Submission):
+    def create_submission(self, submission: Submission) -> Submission:
         self._update_endpoint_header(self.DEFAULT_CREATE_SUBMISSION_ENDPOINT)
         return super().create_submission(submission)
 
@@ -326,11 +304,11 @@ def get_submission(
         submission: Submission,
         *,
         fields: Union[str, Iterable[str], None] = None,
-    ):
+    ) -> Submission:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSION_ENDPOINT)
         return super().get_submission(submission, fields=fields)
 
-    def create_submissions(self, submissions: list[Submission]) -> None:
+    def create_submissions(self, submissions: list[Submission]) -> list[Submission]:
         self._update_endpoint_header(self.DEFAULT_CREATE_SUBMISSIONS_ENDPOINT)
         return super().create_submissions(submissions)
 
@@ -339,7 +317,7 @@ def get_submissions(
         submissions: list[Submission],
         *,
         fields: Union[str, Iterable[str], None] = None,
-    ) -> None:
+    ) -> list[Submission]:
         self._update_endpoint_header(self.DEFAULT_GET_SUBMISSIONS_ENDPOINT)
         return super().get_submissions(submissions, fields=fields)
 
@@ -398,3 +376,66 @@ class SuluJudge0ExtraCE(Sulu):
 
     def __init__(self, api_key):
         super().__init__(self.DEFAULT_ENDPOINT, api_key=api_key)
+
+
+def wait(
+    client: Client,
+    submissions: Union[Submission, list[Submission]],
+    *,
+    retry_mechanism: Optional[RetryMechanism] = None,
+) -> Union[Submission, list[Submission]]:
+    if retry_mechanism is None:
+        retry_mechanism = RegularPeriodRetry()
+
+    if not isinstance(submissions, (list, tuple)):
+        submissions_to_check = {
+            submission.token: submission for submission in [submissions]
+        }
+    else:
+        submissions_to_check = {
+            submission.token: submission for submission in submissions
+        }
+
+    while len(submissions_to_check) > 0 and not retry_mechanism.is_done():
+        client.get_submissions(submissions_to_check.values())
+        for token in list(submissions_to_check):
+            submission = submissions_to_check[token]
+            if submission.is_done():
+                submissions_to_check.pop(token)
+
+        # Don't wait if there is no submissions to check for anymore.
+        if len(submissions_to_check) == 0:
+            break
+
+        retry_mechanism.wait()
+        retry_mechanism.step()
+
+    return submissions
+
+
+def async_execute(
+    *,
+    client: Client,
+    submissions: Union[Submission, list[Submission]],
+) -> Union[Submission, list[Submission]]:
+    if isinstance(submissions, (list, tuple)):
+        return client.create_submissions(submissions)
+    else:
+        return client.create_submission(submissions)
+
+
+def sync_execute(
+    *,
+    client: Client,
+    submissions: Union[Submission, list[Submission]],
+) -> Union[Submission, list[Submission]]:
+    submissions = async_execute(client=client, submissions=submissions)
+    return wait(client, submissions)
+
+
+def execute(
+    *,
+    client: Client,
+    submissions: Union[Submission, list[Submission]],
+) -> Union[Submission, list[Submission]]:
+    return sync_execute(client=client, submissions=submissions)

Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,7 @@ def run_example(client_class, language_id):`
`17`	`17`	`expected_output="Hello Judge0",`
`18`	`18`	`)`
`19`	`19`
`20`		`- client.create_submission(submission)`
`21`		`- client.wait(submission)`
	`20`	`+ judge0.execute(client=client, submissions=submission)`
`22`	`21`
`23`	`22`	`print(f"{submission.status=}")`
`24`	`23`	`print(f"{submission.stdout=}")`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,7 @@ def run_example(client_class, lang_id_python, lang_id_c):`
`23`	`23`	`)`
`24`	`24`
`25`	`25`	`submissions = [submission1, submission2]`
`26`		`- client.create_submissions(submissions)`
`27`		`- client.wait(submissions)`
	`26`	`+ judge0.execute(client=client, submissions=submissions)`
`28`	`27`
`29`	`28`	`for submission in submissions:`
`30`	`29`	`print(f"{submission.status=}")`