Rename Submission language_id attribute to language. Add new dataclass for storing language id and name.

fkdosilovic · fkdosilovic · commit 6993ff660fcf · 2024-11-14T23:01:55.000+01:00
diff --git a/examples/0001_hello_world.py b/examples/0001_hello_world.py
@@ -2,7 +2,7 @@
 
 submission = judge0.Submission(
     source_code="print('Hello Judge0')",
-    language_id=100,
+    language=100,
 )
 
 # Run submission on CE flavor of judge0.
diff --git a/examples/0002_hello_world.py b/examples/0002_hello_world.py
@@ -2,7 +2,7 @@
 
 submission = judge0.Submission(
     source_code="print('Hello Judge0')",
-    language_id=25,
+    language=25,
 )
 
 # Instead of relying on the CE flavor of judge0, we can use EXTRA_CE.
diff --git a/examples/0003_hello_world.py b/examples/0003_hello_world.py
@@ -2,7 +2,7 @@
 
 submission = judge0.Submission(
     source_code="print('Hello Judge0')",
-    language_id=judge0.PYTHON,
+    language=judge0.PYTHON,
 )
 
 judge0.run(submissions=submission)
diff --git a/examples/atd_submission.py b/examples/atd_submission.py
@@ -13,7 +13,7 @@ def run_example(client_class, language_id):
     client = client_class(api_key=api_key)
     submission = judge0.Submission(
         source_code="print('Hello Judge0')",
-        language_id=language_id,
+        language=language_id,
         expected_output="Hello Judge0",
     )
 
diff --git a/examples/atd_submissions.py b/examples/atd_submissions.py
@@ -13,12 +13,12 @@ def run_example(client_class, lang_id_python, lang_id_c):
     client = client_class(api_key=api_key)
     submission1 = judge0.Submission(
         source_code="print('Hello Judge0')",
-        language_id=lang_id_python,
+        language=lang_id_python,
         expected_output="Hello Judge0",
     )
     submission2 = judge0.Submission(
         source_code='#include <stdio.h>\n\nint main() {\n  printf("Hello World!");\n  return 0;\n}',
-        language_id=lang_id_c,
+        language=lang_id_c,
         expected_output="Hello World!",
     )
 
diff --git a/examples/rapid_submission.py b/examples/rapid_submission.py
@@ -13,7 +13,7 @@ def run_example(client_class, language_id):
     client = client_class(api_key=api_key)
     submission = judge0.Submission(
         source_code="print('Hello Judge0')",
-        language_id=language_id,
+        language=language_id,
         expected_output="Hello Judge0",
     )
 
diff --git a/examples/rapid_submissions.py b/examples/rapid_submissions.py
@@ -13,12 +13,12 @@ def run_example(client_class, lang_id_python, lang_id_c):
     client = client_class(api_key=api_key)
     submission1 = judge0.Submission(
         source_code="print('Hello Judge0')",
-        language_id=lang_id_python,
+        language=lang_id_python,
         expected_output="Hello Judge0",
     )
     submission2 = judge0.Submission(
         source_code='#include <stdio.h>\n\nint main() {\n  printf("Hello World!");\n  return 0;\n}',
-        language_id=lang_id_c,
+        language=lang_id_c,
         expected_output="Hello World!",
     )
 
diff --git a/examples/sulu_submission.py b/examples/sulu_submission.py
@@ -13,7 +13,7 @@ def run_example(client_class, language_id):
     client = client_class(api_key=api_key)
     submission = judge0.Submission(
         source_code="print('Hello Judge0')",
-        language_id=language_id,
+        language=language_id,
         expected_output="Hello Judge0",
     )
 
diff --git a/examples/sulu_submissions.py b/examples/sulu_submissions.py
@@ -13,12 +13,12 @@ def run_example(client_class, lang_id_python, lang_id_c):
     client = client_class(api_key=api_key)
     submission1 = judge0.Submission(
         source_code="print('Hello Judge0')",
-        language_id=lang_id_python,
+        language=lang_id_python,
         expected_output="Hello Judge0",
     )
     submission2 = judge0.Submission(
         source_code='#include <stdio.h>\n\nint main() {\n  printf("Hello World!");\n  return 0;\n}',
-        language_id=lang_id_c,
+        language=lang_id_c,
         expected_output="Hello World!",
     )
 
diff --git a/src/judge0/__init__.py b/src/judge0/__init__.py
@@ -1,6 +1,7 @@
 import os
 
 from .api import async_execute, execute, run, sync_execute, wait
+from .base_types import Flavor, Language, LanguageAlias, Status
 from .clients import (
     ATD,
     ATDJudge0CE,
@@ -13,7 +14,6 @@
     SuluJudge0CE,
     SuluJudge0ExtraCE,
 )
-from .common import Flavor, LanguageAlias, Status
 from .retry import MaxRetries, MaxWaitTime, RegularPeriodRetry
 from .submission import Submission
 
@@ -22,6 +22,7 @@
     "ATDJudge0CE",
     "ATDJudge0ExtraCE",
     "Client",
+    "Language",
     "LanguageAlias",
     "MaxRetries",
     "MaxWaitTime",
diff --git a/src/judge0/api.py b/src/judge0/api.py
@@ -1,7 +1,7 @@
 from typing import Optional, Union
 
+from .base_types import Flavor
 from .clients import Client
-from .common import Flavor
 from .retry import RegularPeriodRetry, RetryMechanism
 from .submission import Submission
 
@@ -26,7 +26,7 @@ def resolve_client(
         submissions = [submissions]
 
     # Check which client supports all languages from the provided submissions.
-    languages = [submission.language_id for submission in submissions]
+    languages = [submission.language for submission in submissions]
 
     for flavor in Flavor:
         client = _get_implicit_client(flavor)
diff --git a/src/judge0/base_types.py b/src/judge0/base_types.py
@@ -0,0 +1,39 @@
+from dataclasses import dataclass
+from enum import IntEnum
+
+
+@dataclass
+class Language:
+    id: int
+    name: str
+
+
+class LanguageAlias(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
+
+
+class Status(IntEnum):
+    IN_QUEUE = 1
+    PROCESSING = 2
+    ACCEPTED = 3
+    WRONG_ANSWER = 4
+    TIME_LIMIT_EXCEEDED = 5
+    COMPILATION_ERROR = 6
+    RUNTIME_ERROR_SIGSEGV = 7
+    RUNTIME_ERROR_SIGXFSZ = 8
+    RUNTIME_ERROR_SIGFPE = 9
+    RUNTIME_ERROR_SIGABRT = 10
+    RUNTIME_ERROR_NZEC = 11
+    RUNTIME_ERROR_OTHER = 12
+    INTERNAL_ERROR = 13
+    EXEC_FORMAT_ERROR = 14
diff --git a/src/judge0/clients.py b/src/judge0/clients.py
@@ -2,7 +2,7 @@
 
 import requests
 
-from .common import LanguageAlias
+from .base_types import Language, LanguageAlias
 from .data import LANGUAGE_TO_LANGUAGE_ID
 from .submission import Submission
 
@@ -15,7 +15,10 @@ def __init__(self, endpoint, auth_headers) -> None:
         self.auth_headers = auth_headers
 
         try:
-            self.languages = {lang["id"]: lang for lang in self.get_languages()}
+            self.languages = [
+                Language(id=lang["id"], name=lang["name"])
+                for lang in self.get_languages()
+            ]
         except Exception as e:
             raise RuntimeError(
                 f"Authentication failed. Visit {self.HOME_URL} to get or review your authentication credentials."
@@ -64,22 +67,24 @@ def version(self):
             setattr(self, "_version", _version)
         return self._version
 
-    def resolve_language_id(self, language_id: Union[LanguageAlias, int]) -> int:
-        if isinstance(language_id, LanguageAlias):
-            languages = LANGUAGE_TO_LANGUAGE_ID[self.version]
-            language_id = languages.get(language_id, -1)
-        return language_id
+    def get_language_id(self, language: Union[LanguageAlias, int]) -> int:
+        """Get language id for the corresponding language alias for the client."""
+        if isinstance(language, LanguageAlias):
+            supported_language_ids = LANGUAGE_TO_LANGUAGE_ID[self.version]
+            language = supported_language_ids.get(language, -1)
+        return language
 
-    def is_language_supported(self, language_id: Union[LanguageAlias, int]) -> bool:
-        language_id = self.resolve_language_id(language_id)
-        return language_id in self.languages
+    def is_language_supported(self, language: Union[LanguageAlias, int]) -> bool:
+        """Check if language is supported by the client."""
+        language_id = self.get_language_id(language)
+        return any(language_id == lang.id for lang in self.languages)
 
     def create_submission(self, submission: Submission) -> Submission:
-        # Check if submission contains supported language.
-        if not self.is_language_supported(language_id=submission.language_id):
+        # Check if the client supports the language specified in the submission.
+        if not self.is_language_supported(language=submission.language):
             raise RuntimeError(
                 f"Client {type(self).__name__} does not support language with "
-                f"id {submission.language_id}!"
+                f"id {submission.language}!"
             )
 
         params = {
@@ -88,10 +93,7 @@ def create_submission(self, submission: Submission) -> Submission:
         }
 
         # TODO: Rename to_dict to as_body that accepts the client.
-        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)
+        body = submission.to_dict(self)
 
         resp = requests.post(
             f"{self.endpoint}/submissions",
@@ -139,10 +141,10 @@ def get_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):
+            if not self.is_language_supported(language=submission.language):
                 raise RuntimeError(
-                    f"Client {type(self).__name__} does not support language with "
-                    f"id {submission.language_id}!"
+                    f"Client {type(self).__name__} does not support language "
+                    f"{submission.language}!"
                 )
 
         submissions_body = [submission.to_dict() for submission in submissions]
diff --git a/src/judge0/common.py b/src/judge0/common.py
@@ -1,38 +1,4 @@
 from base64 import b64decode, b64encode
-from enum import IntEnum
-
-
-# TODO: Consider moving enumerations and other possible future types to separate
-# module (_types.py).
-class LanguageAlias(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
-
-
-class Status(IntEnum):
-    IN_QUEUE = 1
-    PROCESSING = 2
-    ACCEPTED = 3
-    WRONG_ANSWER = 4
-    TIME_LIMIT_EXCEEDED = 5
-    COMPILATION_ERROR = 6
-    RUNTIME_ERROR_SIGSEGV = 7
-    RUNTIME_ERROR_SIGXFSZ = 8
-    RUNTIME_ERROR_SIGFPE = 9
-    RUNTIME_ERROR_SIGABRT = 10
-    RUNTIME_ERROR_NZEC = 11
-    RUNTIME_ERROR_OTHER = 12
-    INTERNAL_ERROR = 13
-    EXEC_FORMAT_ERROR = 14
 
 
 def encode(text: str) -> str:
diff --git a/src/judge0/data.py b/src/judge0/data.py
@@ -1,4 +1,4 @@
-from .common import LanguageAlias
+from .base_types import LanguageAlias
 
 LANGUAGE_TO_LANGUAGE_ID = {
     "1.13.1": {
diff --git a/src/judge0/submission.py b/src/judge0/submission.py
@@ -1,6 +1,7 @@
 from typing import Union
 
-from .common import decode, encode, LanguageAlias, Status
+from .base_types import LanguageAlias, Status
+from .common import decode, encode
 
 ENCODED_REQUEST_FIELDS = {
     "source_code",
@@ -54,7 +55,7 @@ class Submission:
     def __init__(
         self,
         source_code: str,
-        language_id: Union[Language, int] = LanguageAlias.PYTHON,
+        language: Union[LanguageAlias, int] = LanguageAlias.PYTHON,
         *,
         additional_files=None,
         compiler_options=None,
@@ -76,7 +77,7 @@ def __init__(
         callback_url=None,
     ):
         self.source_code = source_code
-        self.language_id = language_id
+        self.language = language
         self.additional_files = additional_files
 
         # Extra pre-execution submission attributes.
@@ -131,10 +132,10 @@ def set_attributes(self, attributes):
                 setattr(self, attr, value)
 
     # TODO: Rename to as_body that accepts a Client.
-    def to_dict(self) -> dict:
+    def to_dict(self, client: "Client") -> dict:
         body = {
             "source_code": encode(self.source_code),
-            "language_id": self.language_id,
+            "language_id": client.get_language_id(self.language),
         }
 
         if self.stdin is not None:

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`submission = judge0.Submission(`
`4`	`4`	`source_code="print('Hello Judge0')",`
`5`		`- language_id=100,`
	`5`	`+ language=100,`
`6`	`6`	`)`
`7`	`7`
`8`	`8`	`# Run submission on CE flavor of judge0.`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ def run_example(client_class, language_id):`
`13`	`13`	`client = client_class(api_key=api_key)`
`14`	`14`	`submission = judge0.Submission(`
`15`	`15`	`source_code="print('Hello Judge0')",`
`16`		`- language_id=language_id,`
	`16`	`+ language=language_id,`
`17`	`17`	`expected_output="Hello Judge0",`
`18`	`18`	`)`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -13,12 +13,12 @@ def run_example(client_class, lang_id_python, lang_id_c):`
`13`	`13`	`client = client_class(api_key=api_key)`
`14`	`14`	`submission1 = judge0.Submission(`
`15`	`15`	`source_code="print('Hello Judge0')",`
`16`		`- language_id=lang_id_python,`
	`16`	`+ language=lang_id_python,`
`17`	`17`	`expected_output="Hello Judge0",`
`18`	`18`	`)`
`19`	`19`	`submission2 = judge0.Submission(`
`20`	`20`	`source_code='#include <stdio.h>\n\nint main() {\n printf("Hello World!");\n return 0;\n}',`
`21`		`- language_id=lang_id_c,`
	`21`	`+ language=lang_id_c,`
`22`	`22`	`expected_output="Hello World!",`
`23`	`23`	`)`
`24`	`24`