Add JUDGE0_ prefix to all env vars. Implicitly load client.

fkdosilovic · fkdosilovic · commit 225a286c3383 · 2024-11-03T20:00:47.000+01:00
diff --git a/examples/0001_hello_world.py b/examples/0001_hello_world.py
@@ -0,0 +1,10 @@
+import judge0
+
+submission = judge0.Submission(
+    source_code="print('Hello Judge0')",
+    language_id=100,
+)
+
+judge0.execute(submissions=submission)
+
+print(submission.stdout)
diff --git a/examples/atd_clients.py b/examples/atd_clients.py
@@ -5,7 +5,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("ATD_API_KEY")
+api_key = os.getenv("JUDGE0_ATD_API_KEY")
 
 client_ce = judge0.ATDJudge0CE(api_key=api_key)
 print(client_ce.get_about())
diff --git a/examples/atd_submission.py b/examples/atd_submission.py
@@ -6,7 +6,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("ATD_API_KEY")
+api_key = os.getenv("JUDGE0_ATD_API_KEY")
 
 
 def run_example(client_class, language_id):
diff --git a/examples/atd_submissions.py b/examples/atd_submissions.py
@@ -6,7 +6,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("ATD_API_KEY")
+api_key = os.getenv("JUDGE0_ATD_API_KEY")
 
 
 def run_example(client_class, lang_id_python, lang_id_c):
diff --git a/examples/rapid_clients.py b/examples/rapid_clients.py
@@ -5,7 +5,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("RAPID_API_KEY")
+api_key = os.getenv("JUDGE0_RAPID_API_KEY")
 
 client_ce = judge0.RapidJudge0CE(api_key=api_key)
 print(client_ce.get_about())
diff --git a/examples/rapid_submission.py b/examples/rapid_submission.py
@@ -6,7 +6,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("RAPID_API_KEY")
+api_key = os.getenv("JUDGE0_RAPID_API_KEY")
 
 
 def run_example(client_class, language_id):
diff --git a/examples/rapid_submissions.py b/examples/rapid_submissions.py
@@ -6,7 +6,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("RAPID_API_KEY")
+api_key = os.getenv("JUDGE0_RAPID_API_KEY")
 
 
 def run_example(client_class, lang_id_python, lang_id_c):
diff --git a/examples/sulu_clients.py b/examples/sulu_clients.py
@@ -5,7 +5,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("SULU_API_KEY")
+api_key = os.getenv("JUDGE0_SULU_API_KEY")
 
 client_ce = judge0.SuluJudge0CE(api_key=api_key)
 print(client_ce.get_about())
diff --git a/examples/sulu_submission.py b/examples/sulu_submission.py
@@ -6,7 +6,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("SULU_API_KEY")
+api_key = os.getenv("JUDGE0_SULU_API_KEY")
 
 
 def run_example(client_class, language_id):
diff --git a/examples/sulu_submissions.py b/examples/sulu_submissions.py
@@ -6,7 +6,7 @@
 
 load_dotenv()
 
-api_key = os.getenv("SULU_API_KEY")
+api_key = os.getenv("JUDGE0_SULU_API_KEY")
 
 
 def run_example(client_class, lang_id_python, lang_id_c):
diff --git a/src/judge0/__init__.py b/src/judge0/__init__.py
@@ -1,3 +1,7 @@
+import os
+
+from dotenv import load_dotenv
+
 from .clients import (
     async_execute,
     ATDJudge0CE,
@@ -32,3 +36,29 @@
     execute,
     wait,
 ]
+
+
+def _create_default_client():
+    if globals().get("judge0_default_client") is not None:
+        return
+
+    load_dotenv()
+
+    rapid_api_key = os.getenv("JUDGE0_RAPID_API_KEY")
+    sulu_api_key = os.getenv("JUDGE0_SULU_API_KEY")
+    atd_api_key = os.getenv("JUDGE0_ATD_API_KEY")
+
+    if rapid_api_key is not None:
+        client = RapidJudge0CE(api_key=rapid_api_key)
+    elif sulu_api_key is not None:
+        client = SuluJudge0CE(api_key=sulu_api_key)
+    elif atd_api_key is not None:
+        client = ATDJudge0CE(api_key=sulu_api_key)
+    else:
+        client = None
+
+    if client is not None:
+        globals()["judge0_default_client"] = client
+
+
+_create_default_client()
diff --git a/src/judge0/clients.py b/src/judge0/clients.py
@@ -379,11 +379,23 @@ def __init__(self, api_key):
 
 
 def wait(
-    client: Client,
-    submissions: Union[Submission, list[Submission]],
     *,
+    client: Optional[Client] = None,
+    submissions: Union[Submission, list[Submission], None] = None,
     retry_mechanism: Optional[RetryMechanism] = None,
 ) -> Union[Submission, list[Submission]]:
+    if client is None:
+        from . import judge0_default_client
+
+        if judge0_default_client is None:
+            raise RuntimeError(
+                "Client is not set. Please explicitly set the client argument "
+                "or make sure that one of the implemented client's API keys "
+                "is set as an environment variable."
+            )
+        else:
+            client = judge0_default_client
+
     if retry_mechanism is None:
         retry_mechanism = RegularPeriodRetry()
 
@@ -415,9 +427,21 @@ def wait(
 
 def async_execute(
     *,
-    client: Client,
-    submissions: Union[Submission, list[Submission]],
+    client: Optional[Client] = None,
+    submissions: Union[Submission, list[Submission], None] = None,
 ) -> Union[Submission, list[Submission]]:
+    if client is None:
+        from . import judge0_default_client
+
+        if judge0_default_client is None:
+            raise RuntimeError(
+                "Client is not set. Please explicitly set the client argument "
+                "or make sure that one of the implemented client's API keys "
+                "is set as an environment variable."
+            )
+        else:
+            client = judge0_default_client
+
     if isinstance(submissions, (list, tuple)):
         return client.create_submissions(submissions)
     else:
@@ -426,16 +450,16 @@ def async_execute(
 
 def sync_execute(
     *,
-    client: Client,
-    submissions: Union[Submission, list[Submission]],
+    client: Optional[Client] = None,
+    submissions: Union[Submission, list[Submission], None] = None,
 ) -> Union[Submission, list[Submission]]:
     submissions = async_execute(client=client, submissions=submissions)
-    return wait(client, submissions)
+    return wait(client=client, submissions=submissions)
 
 
 def execute(
     *,
-    client: Client,
-    submissions: Union[Submission, list[Submission]],
+    client: Optional[Client] = None,
+    submissions: Union[Submission, list[Submission], None] = None,
 ) -> Union[Submission, list[Submission]]:
     return sync_execute(client=client, submissions=submissions)
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -10,41 +10,41 @@
 
 @pytest.fixture(scope="session")
 def atd_ce_client():
-    api_key = os.getenv("ATD_API_KEY")
+    api_key = os.getenv("JUDGE0_ATD_API_KEY")
     client = clients.ATDJudge0CE(api_key)
     return client
 
 
 @pytest.fixture(scope="session")
 def atd_extra_ce_client():
-    api_key = os.getenv("ATD_API_KEY")
+    api_key = os.getenv("JUDGE0_ATD_API_KEY")
     client = clients.ATDJudge0ExtraCE(api_key)
     return client
 
 
 @pytest.fixture(scope="session")
 def rapid_ce_client():
-    api_key = os.getenv("RAPID_API_KEY")
+    api_key = os.getenv("JUDGE0_RAPID_API_KEY")
     client = clients.RapidJudge0CE(api_key)
     return client
 
 
 @pytest.fixture(scope="session")
 def rapid_extra_ce_client():
-    api_key = os.getenv("RAPID_API_KEY")
+    api_key = os.getenv("JUDGE0_RAPID_API_KEY")
     client = clients.RapidJudge0ExtraCE(api_key)
     return client
 
 
 @pytest.fixture(scope="session")
 def sulu_ce_client():
-    api_key = os.getenv("SULU_API_KEY")
+    api_key = os.getenv("JUDGE0_SULU_API_KEY")
     client = clients.SuluJudge0CE(api_key)
     return client
 
 
 @pytest.fixture(scope="session")
 def sulu_extra_ce_client():
-    api_key = os.getenv("SULU_API_KEY")
+    api_key = os.getenv("JUDGE0_SULU_API_KEY")
     client = clients.SuluJudge0ExtraCE(api_key)
     return client
