Add client resolution based on the submissions and the languages. Add Language enumeration.

Author: fkdosilovic

Pipfile

@@ -11,6 +11,7 @@ ufmt = "==2.7.3"
 pre-commit = "==3.8.0"
 pytest = "==8.3.3"
 python-dotenv = "==1.0.1"
+pytest-cov = "6.0.0"
 
 [requires]
 python_version = "3.9"

examples/0003_hello_world.py

@@ -0,0 +1,10 @@
+import judge0
+
+submission = judge0.Submission(
+    source_code="print('Hello Judge0')",
+    language_id=judge0.PYTHON,
+)
+
+judge0.run(submissions=submission)
+
+print(submission.stdout)

src/judge0/__init__.py

@@ -15,7 +15,7 @@
     SuluJudge0CE,
     SuluJudge0ExtraCE,
 )
-from .common import Flavor, Status
+from .common import Flavor, Language, Status
 from .retry import MaxRetries, MaxWaitTime, RegularPeriodRetry
 from .submission import Submission
 
@@ -24,22 +24,23 @@
     "ATDJudge0CE",
     "ATDJudge0ExtraCE",
     "Client",
+    "Language",
+    "MaxRetries",
+    "MaxWaitTime",
     "Rapid",
     "RapidJudge0CE",
     "RapidJudge0ExtraCE",
+    "RegularPeriodRetry",
+    "Status",
+    "Submission",
     "Sulu",
     "SuluJudge0CE",
     "SuluJudge0ExtraCE",
-    "Submission",
-    "RegularPeriodRetry",
-    "MaxRetries",
-    "MaxWaitTime",
     "async_execute",
-    "sync_execute",
     "execute",
-    "wait",
     "run",
-    "Status",
+    "sync_execute",
+    "wait",
 ]
 
 
@@ -88,3 +89,10 @@ def _create_default_client(
 
 CE = Flavor.CE
 EXTRA_CE = Flavor.EXTRA_CE
+
+PYTHON = Language.PYTHON
+CPP = Language.CPP
+JAVA = Language.JAVA
+CPP_GCC = Language.CPP_GCC
+CPP_CLANG = Language.CPP_CLANG
+PYTHON_FOR_ML = Language.PYTHON_FOR_ML

src/judge0/api.py

@@ -2,24 +2,67 @@
 
 from .clients import Client
 from .common import Flavor
+from .data import LANGUAGE_TO_LANGUAGE_ID
 from .retry import RegularPeriodRetry, RetryMechanism
 from .submission import Submission
 
 
-def _resolve_client(client: Union[Client, Flavor]) -> Client:
-    if not isinstance(client, Flavor):
-        return client
-
-    if client == Flavor.CE:
-        from . import JUDGE0_IMPLICIT_CE_CLIENT
-
-        client = JUDGE0_IMPLICIT_CE_CLIENT
-    else:
-        from . import JUDGE0_IMPLICIT_EXTRA_CE_CLIENT
+def resolve_client(
+    client: Optional[Union[Client, Flavor]] = None,
+    submissions: Optional[Union[Submission, list[Submission]]] = None,
+) -> Union[Client, None]:
+    from . import JUDGE0_IMPLICIT_CE_CLIENT, JUDGE0_IMPLICIT_EXTRA_CE_CLIENT
 
-        client = JUDGE0_IMPLICIT_EXTRA_CE_CLIENT
+    # User explicitly passed a client.
+    if isinstance(client, Client):
+        return client
 
-    return client
+    # User explicitly choose the flavor of the client.
+    if isinstance(client, Flavor):
+        if client == Flavor.CE:
+            return JUDGE0_IMPLICIT_CE_CLIENT
+        else:
+            return JUDGE0_IMPLICIT_EXTRA_CE_CLIENT
+
+    # client is None and we have to determine a flavor of the client from the
+    # submissions and the languages.
+    if isinstance(submissions, Submission):
+        submissions = [submissions]
+
+    if submissions is not None and len(submissions) == 0:
+        raise ValueError("Client cannot be determined from empty submissions argument.")
+
+    if submissions is None:
+        raise ValueError(
+            "Client cannot be determined from unprovided submissions argument."
+        )
+
+    # Check which client supports all languages from the provided submissions.
+    languages = [submission.language_id for submission in submissions]
+
+    if JUDGE0_IMPLICIT_CE_CLIENT is not None:
+        if all(
+            [
+                JUDGE0_IMPLICIT_CE_CLIENT.is_language_supported(lang)
+                for lang in languages
+            ]
+        ):
+            return JUDGE0_IMPLICIT_CE_CLIENT
+
+    if JUDGE0_IMPLICIT_EXTRA_CE_CLIENT is not None:
+        if all(
+            [
+                JUDGE0_IMPLICIT_EXTRA_CE_CLIENT.is_language_supported(lang)
+                for lang in languages
+            ]
+        ):
+            return JUDGE0_IMPLICIT_EXTRA_CE_CLIENT
+
+    raise RuntimeError(
+        "Failed to resolve the client from submissions argument."
+        "None of the implicit clients supports all languages from the submissions."
+        "Please explicitly provide the client argument."
+    )
 
 
 def wait(
@@ -59,10 +102,10 @@ def wait(
 
 def async_execute(
     *,
-    client: Union[Client, Flavor] = Flavor.CE,
-    submissions: Union[Submission, list[Submission], None] = None,
+    client: Optional[Union[Client, Flavor]] = None,
+    submissions: Optional[Union[Submission, list[Submission]]] = None,
 ) -> Union[Submission, list[Submission]]:
-    client = _resolve_client(client)
+    client = resolve_client(client)
 
     if isinstance(submissions, (list, tuple)):
         return client.create_submissions(submissions)
@@ -72,10 +115,10 @@ def async_execute(
 
 def sync_execute(
     *,
-    client: Union[Client, Flavor] = Flavor.CE,
+    client: Optional[Union[Client, Flavor]] = None,
     submissions: Union[Submission, list[Submission], None] = None,
 ) -> Union[Submission, list[Submission]]:
-    client = _resolve_client(client)
+    client = resolve_client(client, submissions=submissions)
     submissions = async_execute(client=client, submissions=submissions)
     return wait(client, submissions)
 

src/judge0/clients.py

@@ -2,6 +2,8 @@
 
 import requests
 
+from .common import Language
+from .data import LANGUAGE_TO_LANGUAGE_ID
 from .submission import Submission
 
 
@@ -55,7 +57,21 @@ def get_statuses(self) -> list[dict]:
         r.raise_for_status()
         return r.json()
 
-    def is_language_supported(self, language_id: int) -> bool:
+    @property
+    def version(self):
+        if not hasattr(self, "_version"):
+            _version = self.get_about()["version"]
+            setattr(self, "_version", _version)
+        return self._version
+
+    def resolve_language_id(self, language_id: Union[Language, int]) -> int:
+        if isinstance(language_id, Language):
+            languages = LANGUAGE_TO_LANGUAGE_ID[self.version]
+            language_id = languages.get(language_id, -1)
+        return language_id
+
+    def is_language_supported(self, language_id: Union[Language, int]) -> bool:
+        language_id = self.resolve_language_id(language_id)
         return language_id in self.languages
 
     def create_submission(self, submission: Submission) -> Submission:
@@ -72,6 +88,9 @@ def create_submission(self, submission: Submission) -> Submission:
         }
 
         body = submission.to_dict()
+        # We have to resolve language_id because language_id can be Language
+        # enumeration.
+        body["language_id"] = self.resolve_language_id(submission.language_id)
 
         resp = requests.post(
             f"{self.endpoint}/submissions",
@@ -126,6 +145,12 @@ def create_submissions(self, submissions: list[Submission]) -> list[Submission]:
                 )
 
         submissions_body = [submission.to_dict() for submission in submissions]
+        # We have to resolve language_id because language_id can be Language
+        # enumeration.
+        for submission_body in submissions_body:
+            submission_body["language_id"] = self.resolve_language_id(
+                submission_body["language_id"]
+            )
 
         resp = requests.post(
             f"{self.endpoint}/submissions/batch",

src/judge0/common.py

@@ -1,6 +1,15 @@
 from enum import IntEnum
 
 
+class Language(IntEnum):
+    PYTHON = 0
+    CPP = 1
+    JAVA = 2
+    CPP_GCC = 3
+    CPP_CLANG = 4
+    PYTHON_FOR_ML = 5
+
+
 class Flavor(IntEnum):
     CE = 0
     EXTRA_CE = 1

src/judge0/data.py

@@ -0,0 +1,32 @@
+from .common import Language
+
+LANGUAGE_TO_LANGUAGE_ID = {
+    "1.13.1": {
+        Language.PYTHON: 71,
+        Language.CPP: 54,
+        Language.JAVA: 62,
+        Language.CPP_GCC: 54,
+        Language.CPP_CLANG: 76,
+    },
+    "1.13.1-extra": {
+        Language.PYTHON: 10,
+        Language.CPP: 2,
+        Language.JAVA: 4,
+        Language.CPP_CLANG: 2,
+        Language.PYTHON_FOR_ML: 10,
+    },
+    "1.14.0": {
+        Language.PYTHON: 100,
+        Language.CPP: 105,
+        Language.JAVA: 91,
+        Language.CPP_GCC: 105,
+        Language.CPP_CLANG: 76,
+    },
+    "1.14.0-extra": {
+        Language.PYTHON: 25,
+        Language.CPP: 2,
+        Language.JAVA: 4,
+        Language.CPP_CLANG: 2,
+        Language.PYTHON_FOR_ML: 25,
+    },
+}

tests/test_api.py

@@ -0,0 +1,107 @@
+import pytest
+
+from judge0 import (
+    Flavor,
+    JUDGE0_IMPLICIT_CE_CLIENT,
+    JUDGE0_IMPLICIT_EXTRA_CE_CLIENT,
+    Language,
+    Submission,
+    submission,
+)
+from judge0.api import resolve_client
+
+DEFAULT_CLIENTS = (
+    "atd_ce_client",
+    "atd_extra_ce_client",
+    "rapid_ce_client",
+    "rapid_extra_ce_client",
+    "sulu_ce_client",
+    "sulu_extra_ce_client",
+)
+
+
+@pytest.mark.parametrize("client", DEFAULT_CLIENTS)
+def test_resolve_client_with_explicit_client(client, request):
+    client = request.getfixturevalue(client)
+    assert resolve_client(client) is client
+
+
+@pytest.mark.parametrize(
+    "flavor,expected_client",
+    [
+        [
+            Flavor.CE,
+            JUDGE0_IMPLICIT_CE_CLIENT,
+        ],
+        [
+            Flavor.EXTRA_CE,
+            JUDGE0_IMPLICIT_EXTRA_CE_CLIENT,
+        ],
+    ],
+)
+def test_resolve_client_with_flavor(
+    flavor,
+    expected_client,
+):
+    assert resolve_client(client=flavor) is expected_client
+
+
+@pytest.mark.parametrize(
+    "submissions",
+    [
+        [],
+        None,
+    ],
+)
+def test_resolve_client_empty_submissions_argument(submissions):
+    with pytest.raises(ValueError):
+        resolve_client(submissions=submissions)
+
+
+def test_resolve_client_no_common_client_for_submissions():
+    cpp_submission = Submission(
+        source_code="",  # source code is not important because in this test
+        language_id=Language.CPP_GCC,
+    )
+
+    py_submission = Submission(
+        source_code="",  # source code is not important because in this test
+        language_id=Language.PYTHON_FOR_ML,
+    )
+
+    submissions = [cpp_submission, py_submission]
+
+    with pytest.raises(RuntimeError):
+        resolve_client(submissions=submissions)
+
+
+def test_resolve_client_common_ce_client():
+    cpp_submission = Submission(
+        source_code="",  # source code is not important because in this test
+        language_id=Language.CPP_GCC,
+    )
+
+    py_submission = Submission(
+        source_code="",  # source code is not important because in this test
+        language_id=Language.PYTHON,
+    )
+
+    submissions = [cpp_submission, py_submission]
+
+    assert resolve_client(submissions=submissions) is JUDGE0_IMPLICIT_CE_CLIENT
+
+
+def test_resolve_client_common_extra_ce_client():
+    cpp_submission = Submission(
+        source_code="",  # source code is not important because in this test
+        language_id=Language.CPP_CLANG,
+    )
+
+    py_submission = Submission(
+        source_code="",  # source code is not important because in this test
+        language_id=Language.PYTHON_FOR_ML,
+    )
+
+    submissions = [cpp_submission, py_submission]
+
+    assert resolve_client(submissions=submissions) is JUDGE0_IMPLICIT_EXTRA_CE_CLIENT