changes for v0.3

Author: Bhupesh-V

.travis.yml

@@ -11,5 +11,5 @@ script:
   - python tests.py
   - isort --check-only --recursive coderunner
   - black --check --diff coderunner
-  - flake8 coderunner --max-line-length=88
-  - pylint coderunner --disable=bad-continuation,invalid-name
+  - flake8 coderunner --max-line-length=88 --ignore=F401
+  - pylint coderunner --disable=bad-continuation,invalid-name,too-many-instance-attributes

coderunner/__init__.py

@@ -1 +1,2 @@
-from coderunner.coderunner import Run
+"""Import Run() for initializing program data"""
+from coderunner.coderunner import Run

coderunner/coderunner.py

@@ -1,14 +1,8 @@
-import time
-import sys
+"""coderunner helps you run your programs on Judge0's Server"""
 import requests
 
 # language IDs on judge0, see README.md
-languages = {
-	"C++" : 10,
-	"Java" : 27,
-	"Python": 34,
-	"C": 4
-}
+languages = {"C++": 10, "Java": 27, "Python": 34, "C": 4}
 
 api_params = {
     "number_of_runs": "1",
@@ -18,106 +12,119 @@
     "memory_limit": "128000",
     "stack_limit": "64000",
     "max_processes_and_or_threads": "30",
-    "enable_per_process_and_thread_time_limit": 'false',
-    "enable_per_process_and_thread_memory_limit": 'true',
-    "max_file_size": "1024"
+    "enable_per_process_and_thread_time_limit": "false",
+    "enable_per_process_and_thread_memory_limit": "true",
+    "max_file_size": "1024",
 }
 
 API_URL = "https://api.judge0.com/submissions/"
 
-class Run:
-
-	def __init__(self, program_name: str, lang: str, output: str, inp: str = None):
-		self.program_name = program_name
-		self.lang = lang
-		if lang not in languages:
-			raise ValueError(f"{lang} is not a supported languige {languages.keys()}")
-		
-		self.output = output
-		self.inp = inp
-		self.language_id = languages[lang]
-
-	def __readCode(self):
-		"""
-		Read Source Code & return as string
-		"""
-		with open(self.program_name, 'r') as myfile:
-			data = myfile.read()
-		return data
-
-
-	def __readExpectedOutput(self):
-		with open(self.output, 'r') as out:
-			data = out.read()
-		return data
-
-
-	def __readStandardInput(self):
-		with open(self.inp, 'r') as out:
-			data = out.read()
-		return data
-
-
-	def __readStatus(self, token: str):
-		"""
-		Check Submission status
-		"""
-		while True:
-			req = requests.get(API_URL + token['token'])
-			self.__response = req.json()
-			self.__memory = self.__response["memory"]
-			self.__time = self.__response["time"]
-			status = self.__response['status']['description']
-			if status != "Processing" and status != "In Queue":
-				break
-
-		if status == "Accepted":
-			self.__stdout = self.__response["stdout"]
-			return status
-		else:
-			return self.__response['status']['description']
-
-	def __submit(self):
-		if self.inp != None:
-			api_params['stdin'] = self.inp
-		
-		api_params['expected_output'] = self.output
-		api_params['language_id'] = self.language_id
-		api_params['source_code'] = self.program_name
-
-		res = requests.post(API_URL, data=api_params)
-		token = res.json()
-		return token
-
-
-	def getStandardOutput(self):
-		return self.__stdout
-
-
-	def getMemory(self):
-		return self.__memory
-
-
-	def getError(self):
-		if self.__response['stderr'] != '':
-			return self.__response['stderr']
-		return None
-
-
-	def getTime(self):
-		return self.__time
-
-
-	def getStatus(self):
-		self.program_name = self.__readCode()
-		self.output = self.__readExpectedOutput()
-		
-		if self.inp != None:
-			self.inp = self.__readStandardInput()
-			token = self.__submit()
-			status = self.__readStatus(token)
-		else:
-			token = self.__submit()
-			status = self.__readStatus(token)
-		return status
 
+class Run:
+    """
+    Initialize program data like name,expected input/output etc
+    """
+
+    def __init__(self, program_name: str, lang: str, output: str, inp: str = None):
+        self.program_name = program_name
+        self.lang = lang
+        if lang not in languages:
+            raise ValueError(f"{lang} is not a supported language {languages.keys()}")
+
+        self.output = output
+        self.inp = inp
+        self.language_id = languages[lang]
+        self.__response = None
+        self.__memory = None
+        self.__time = None
+        self.__stdout = None
+
+    def __readCode(self):
+        """
+        Read Source Code & return as string
+        """
+        with open(self.program_name, "r") as myfile:
+            data = myfile.read()
+        return data
+
+    def __readExpectedOutput(self):
+        with open(self.output, "r") as out:
+            data = out.read()
+        return data
+
+    def __readStandardInput(self):
+        with open(self.inp, "r") as out:
+            data = out.read()
+        return data
+
+    def __readStatus(self, token: str):
+        """
+        Check Submission status
+        """
+        while True:
+            req = requests.get(API_URL + token["token"])
+            self.__response = req.json()
+            self.__memory = self.__response["memory"]
+            self.__time = self.__response["time"]
+            status = self.__response["status"]["description"]
+            if status not in ("Processing", "In Queue"):
+                break
+
+        if status == "Accepted":
+            self.__stdout = self.__response["stdout"]
+            return status
+        return self.__response["status"]["description"]
+
+    def __submit(self):
+        if self.inp is not None:
+            api_params["stdin"] = self.inp
+
+        api_params["expected_output"] = self.output
+        api_params["language_id"] = self.language_id
+        api_params["source_code"] = self.program_name
+
+        res = requests.post(API_URL, data=api_params)
+        token = res.json()
+        return token
+
+    def getStandardOutput(self):
+        """
+        Return the standard output of the program
+        """
+        return self.__stdout
+
+    def getMemory(self):
+        """
+        Return the memory used by the program (in bytes)
+        """
+        return self.__memory
+
+    def getError(self):
+        """
+        Return any error occured during program execution
+        """
+        if self.__response["stderr"] != "":
+            return self.__response["stderr"]
+        return None
+
+    def getTime(self):
+        """
+        Return execution time used by the program
+        """
+        return self.__time
+
+    def getStatus(self):
+        """
+        Submits the program on Judge0's server and returns its status
+        """
+        self.program_name = self.__readCode()
+        self.output = self.__readExpectedOutput()
+
+        if self.inp is not None:
+            self.inp = self.__readStandardInput()
+            token = self.__submit()
+            status = self.__readStatus(token)
+        else:
+            token = self.__submit()
+            status = self.__readStatus(token)
+        return status

setup.py

@@ -5,13 +5,20 @@
 
 setuptools.setup(
     name="coderunner",
-    version="0.2",
+    version="0.3",
     author="Bhupesh Varshey",
     author_email="[email protected]",
     description="Judge0 API Interface written in Python",
+    keywords='judge0 coderunner judge0-api codeclassroom',
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/codeclassroom/CodeRunner",
+    project_urls={
+        "Documentation": "https://github.com/codeclassroom/CodeRunner/wiki/Documentation---coderunner-v0.3",
+        "Source Code": "https://github.com/codeclassroom/CodeRunner",
+        "Funding": "https://www.patreon.com/bePatron?u=18082750",
+        "Say Thanks!": "https://github.com/codeclassroom/CodeRunner/issues/new?assignees=&labels=&template=---say-thank-you.md&title=",
+    },
     packages=setuptools.find_packages(),
     install_requires=[
         'requests',