Skip to content

Commit 86d935a

Browse files
committed
Minor docs update.
1 parent 8338f21 commit 86d935a

File tree

2 files changed

+74
-8
lines changed

2 files changed

+74
-8
lines changed

src/judge0/api.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -353,10 +353,12 @@ def async_execute(
353353
resolved.
354354
submissions : Submission or Submissions, optional
355355
Submission or submissions for execution.
356-
source_code: str, optional
356+
source_code : str, optional
357357
A source code of a program.
358-
test_cases: TestCaseType or TestCases, optional
358+
test_cases : TestCaseType or TestCases, optional
359359
A single test or a list of test cases
360+
**kwargs : dict
361+
Additional keyword arguments to pass to the Submission constructor.
360362
361363
Returns
362364
-------
@@ -405,6 +407,8 @@ def sync_execute(
405407
A source code of a program.
406408
test_cases: TestCaseType or TestCases, optional
407409
A single test or a list of test cases
410+
**kwargs : dict
411+
Additional keyword arguments to pass to the Submission constructor.
408412
409413
Returns
410414
-------

src/judge0/clients.py

+68-6
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,19 @@ def get_submissions(
356356

357357

358358
class ATD(Client):
359-
"""Base class for all AllThingsDev clients."""
359+
"""Base class for all AllThingsDev clients.
360+
361+
Parameters
362+
----------
363+
endpoint : str
364+
Default request endpoint.
365+
host_header_value : str
366+
Value for the x-apihub-host header.
367+
api_key : str
368+
AllThingsDev API key.
369+
**kwargs : dict
370+
Additional keyword arguments for the base Client.
371+
"""
360372

361373
API_KEY_ENV: ClassVar[str] = "JUDGE0_ATD_API_KEY"
362374

@@ -376,7 +388,15 @@ def _update_endpoint_header(self, header_value):
376388

377389

378390
class ATDJudge0CE(ATD):
379-
"""AllThingsDev client for CE flavor."""
391+
"""AllThingsDev client for CE flavor.
392+
393+
Parameters
394+
----------
395+
api_key : str
396+
AllThingsDev API key.
397+
**kwargs : dict
398+
Additional keyword arguments for the base Client.
399+
"""
380400

381401
DEFAULT_ENDPOINT: ClassVar[str] = (
382402
"https://judge0-ce.proxy-production.allthingsdev.co"
@@ -460,7 +480,15 @@ def get_submissions(
460480

461481

462482
class ATDJudge0ExtraCE(ATD):
463-
"""AllThingsDev client for Extra CE flavor."""
483+
"""AllThingsDev client for Extra CE flavor.
484+
485+
Parameters
486+
----------
487+
api_key : str
488+
AllThingsDev API key.
489+
**kwargs : dict
490+
Additional keyword arguments for the base Client.
491+
"""
464492

465493
DEFAULT_ENDPOINT: ClassVar[str] = (
466494
"https://judge0-extra-ce.proxy-production.allthingsdev.co"
@@ -545,7 +573,19 @@ def get_submissions(
545573

546574

547575
class Rapid(Client):
548-
"""Base class for all RapidAPI clients."""
576+
"""Base class for all RapidAPI clients.
577+
578+
Parameters
579+
----------
580+
endpoint : str
581+
Default request endpoint.
582+
host_header_value : str
583+
Value for the x-rapidapi-host header.
584+
api_key : str
585+
RapidAPI API key.
586+
**kwargs : dict
587+
Additional keyword arguments for the base Client.
588+
"""
549589

550590
API_KEY_ENV: ClassVar[str] = "JUDGE0_RAPID_API_KEY"
551591

@@ -562,7 +602,15 @@ def __init__(self, endpoint, host_header_value, api_key, **kwargs):
562602

563603

564604
class RapidJudge0CE(Rapid):
565-
"""RapidAPI client for CE flavor."""
605+
"""RapidAPI client for CE flavor.
606+
607+
Parameters
608+
----------
609+
api_key : str
610+
RapidAPI API key.
611+
**kwargs : dict
612+
Additional keyword arguments for the base Client.
613+
"""
566614

567615
DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-ce.p.rapidapi.com"
568616
DEFAULT_HOST: ClassVar[str] = "judge0-ce.p.rapidapi.com"
@@ -578,7 +626,15 @@ def __init__(self, api_key, **kwargs):
578626

579627

580628
class RapidJudge0ExtraCE(Rapid):
581-
"""RapidAPI client for Extra CE flavor."""
629+
"""RapidAPI client for Extra CE flavor.
630+
631+
Parameters
632+
----------
633+
api_key : str
634+
RapidAPI API key.
635+
**kwargs : dict
636+
Additional keyword arguments for the base Client.
637+
"""
582638

583639
DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-extra-ce.p.rapidapi.com"
584640
DEFAULT_HOST: ClassVar[str] = "judge0-extra-ce.p.rapidapi.com"
@@ -602,6 +658,8 @@ class Sulu(Client):
602658
Default request endpoint.
603659
api_key : str, optional
604660
Sulu API key.
661+
**kwargs : dict
662+
Additional keyword arguments for the base Client.
605663
"""
606664

607665
API_KEY_ENV: ClassVar[str] = "JUDGE0_SULU_API_KEY"
@@ -622,6 +680,8 @@ class SuluJudge0CE(Sulu):
622680
----------
623681
api_key : str, optional
624682
Sulu API key.
683+
**kwargs : dict
684+
Additional keyword arguments for the base Client.
625685
"""
626686

627687
DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-ce.p.sulu.sh"
@@ -642,6 +702,8 @@ class SuluJudge0ExtraCE(Sulu):
642702
----------
643703
api_key : str
644704
Sulu API key.
705+
**kwargs : dict
706+
Additional keyword arguments for the base Client.
645707
"""
646708

647709
DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-extra-ce.p.sulu.sh"

0 commit comments

Comments
 (0)