Add to_dict and from_dict to Submission and Filesystem objects.

Author: fkdosilovic

src/judge0/base_types.py

@@ -1,7 +1,6 @@
-from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from enum import IntEnum
-from typing import Optional, Sequence, Union
+from typing import Optional, Protocol, runtime_checkable, Sequence, Union
 
 Iterable = Sequence
 
@@ -33,10 +32,11 @@ def from_record(test_case: Optional[TestCaseType] = None) -> "TestCase":
         )
 
 
-class Encodeable(ABC):
-    @abstractmethod
+@runtime_checkable
+class Encodeable(Protocol):
     def encode(self) -> bytes:
-        pass
+        """Serialize the object to bytes."""
+        ...
 
 
 @dataclass(frozen=True)
@@ -46,6 +46,8 @@ class Language:
 
 
 class LanguageAlias(IntEnum):
+    """Language enumeration."""
+
     PYTHON = 0
     CPP = 1
     JAVA = 2
@@ -55,11 +57,15 @@ class LanguageAlias(IntEnum):
 
 
 class Flavor(IntEnum):
+    """Judge0 flavor enumeration."""
+
     CE = 0
     EXTRA_CE = 1
 
 
 class Status(IntEnum):
+    """Status enumeration."""
+
     IN_QUEUE = 1
     PROCESSING = 2
     ACCEPTED = 3

src/judge0/common.py

@@ -2,7 +2,7 @@
 from itertools import islice
 from typing import Union
 
-from .base_types import Encodeable
+from judge0.base_types import Encodeable
 
 
 def encode(content: Union[bytes, str, Encodeable]) -> str:
@@ -26,7 +26,7 @@ def decode(content: Union[bytes, str]) -> str:
 
 
 def batched(iterable, n):
-    """Utility function for batching submissions.
+    """Iterate over an iterable in batches of a specified size.
 
     Adapted from https://docs.python.org/3/library/itertools.html#itertools.batched.
     """

src/judge0/filesystem.py

@@ -5,7 +5,7 @@
 from base64 import b64decode, b64encode
 from typing import Optional, Union
 
-from .base_types import Encodeable, Iterable
+from .base_types import Iterable
 
 
 class File:
@@ -24,7 +24,7 @@ def __str__(self):
         return self.content.decode(errors="backslashreplace")
 
 
-class Filesystem(Encodeable):
+class Filesystem:
     def __init__(
         self,
         content: Optional[Union[str, bytes, File, Iterable[File], "Filesystem"]] = None,
@@ -47,6 +47,14 @@ def __init__(
             self.files = [content]
         elif isinstance(content, Filesystem):
             self.files = copy.deepcopy(content.files)
+        elif content is None:
+            pass
+        else:
+            raise ValueError(
+                "Unsupported type for content argument. Expected "
+                "one of str, bytes, File, Iterable[File], or Filesystem, "
+                f"got {type(content)}."
+            )
 
     def __repr__(self) -> str:
         content_encoded = b64encode(self.encode()).decode()
@@ -59,7 +67,17 @@ def encode(self) -> bytes:
                 zip_file.writestr(file.name, file.content)
         return zip_buffer.getvalue()
 
+    def to_dict(self) -> dict:
+        """Pack the Filesystem object to a dictionary."""
+        return {"filesystem": str(self)}
+
+    @staticmethod
+    def from_dict(filesystem_dict: dict) -> "Filesystem":
+        """Create a Filesystem object from dictionary."""
+        return Filesystem(filesystem_dict.get("filesystem"))
+
     def __str__(self) -> str:
+        """Create string representation of Filesystem object."""
         return b64encode(self.encode()).decode()
 
     def __iter__(self):

src/judge0/submission.py

@@ -17,7 +17,7 @@
     "stdout",
     "stderr",
     "compile_output",
-    # "post_execution_filesystem",
+    "post_execution_filesystem",
 }
 ENCODED_FIELDS = ENCODED_REQUEST_FIELDS | ENCODED_RESPONSE_FIELDS
 EXTRA_REQUEST_FIELDS = {
@@ -48,7 +48,6 @@
     "time",
     "wall_time",
     "memory",
-    "post_execution_filesystem",
 }
 REQUEST_FIELDS = ENCODED_REQUEST_FIELDS | EXTRA_REQUEST_FIELDS
 RESPONSE_FIELDS = ENCODED_RESPONSE_FIELDS | EXTRA_RESPONSE_FIELDS
@@ -207,7 +206,7 @@ def set_attributes(self, attributes: dict[str, Any]) -> None:
             if attr in SKIP_FIELDS:
                 continue
 
-            if attr in ENCODED_FIELDS:
+            if attr in ENCODED_FIELDS and attr not in ("post_execution_filesystem",):
                 value = decode(value) if value else None
             elif attr == "status":
                 value = Status(value["id"])
@@ -241,6 +240,43 @@ def as_body(self, client: "Client") -> dict:
 
         return body
 
+    def to_dict(self) -> dict:
+        encoded_request_fields = {
+            field_name: encode(getattr(self, field_name))
+            for field_name in ENCODED_REQUEST_FIELDS
+            if getattr(self, field_name) is not None
+        }
+        extra_request_fields = {
+            field_name: getattr(self, field_name)
+            for field_name in EXTRA_REQUEST_FIELDS
+            if getattr(self, field_name) is not None
+        }
+        encoded_response_fields = {
+            field_name: encode(getattr(self, field_name))
+            for field_name in ENCODED_RESPONSE_FIELDS
+            if getattr(self, field_name) is not None
+        }
+        extra_response_fields = {
+            field_name: getattr(self, field_name)
+            for field_name in EXTRA_RESPONSE_FIELDS
+            if getattr(self, field_name) is not None
+        }
+
+        submission_dict = (
+            encoded_request_fields
+            | extra_request_fields
+            | encoded_response_fields
+            | extra_response_fields
+        )
+
+        return submission_dict
+
+    @staticmethod
+    def from_dict(submission_dict) -> "Submission":
+        submission = Submission()
+        submission.set_attributes(submission_dict)
+        return submission
+
     def is_done(self) -> bool:
         """Check if submission is finished processing.