Minor code updates, moved JSON loads to Result constructor

Author: mikicz

arca/_arca.py

@@ -39,18 +39,18 @@ class Arca:
 
     def __init__(self, backend: BackendDefinitionType=NOT_SET,
                  settings=None,
-                 single_pull=None,
-                 base_dir=None,
-                 ignore_cache_errors=None) -> None:
+                 single_pull=NOT_SET,
+                 base_dir=NOT_SET,
+                 ignore_cache_errors=NOT_SET) -> None:
         self.settings: Settings = Settings(settings)
 
-        if ignore_cache_errors is not None:
+        if ignore_cache_errors is not NOT_SET:
             self.ignore_cache_errors = bool(ignore_cache_errors)
 
-        if single_pull is not None:
+        if single_pull is not NOT_SET:
             self.single_pull = bool(single_pull)
 
-        if base_dir is not None:
+        if base_dir is not NOT_SET:
             self.base_dir = base_dir
 
         self.region: CacheRegion = self.make_region()
@@ -378,9 +378,7 @@ def run(self, repo: str, branch: str, task: Task, *,
 
         logger.info("Running Arca task %r for repo '%s' in branch '%s'", task, repo, branch)
 
-        git_repo, repo_path = self.get_files(repo, branch,
-                                             depth=depth,
-                                             reference=reference)
+        git_repo, repo_path = self.get_files(repo, branch, depth=depth, reference=reference)
 
         def create_value():
             logger.debug("Value not in cache, creating.")
@@ -428,9 +426,7 @@ def static_filename(self, repo: str, branch: str, relative_path: Union[str, Path
         if not isinstance(relative_path, Path):
             relative_path = Path(relative_path)
 
-        _, repo_path = self.get_files(repo, branch,
-                                      depth=depth,
-                                      reference=reference)
+        _, repo_path = self.get_files(repo, branch, depth=depth, reference=reference)
 
         result = repo_path / relative_path
         result = result.resolve()

arca/_runner.py

@@ -1,4 +1,4 @@
-""" This file is the code which actually launches the tasks, the serialized jsons.
+""" This file is the code which actually launches the tasks, the serialized JSONs.
 """
 import json
 import traceback
@@ -46,7 +46,6 @@ def run(filename):
         # KeyError: keys can be missing from the parsed json
         # TypeError: task_definition["entry_point"] is a list
         # AttributeError: task_definition["entry_point"] isn't a dict
-
         return {"success": False, "reason": "corrupted_definition", "error": traceback.format_exc()}
 
     try:

arca/backend/base.py

@@ -1,5 +1,4 @@
 import hashlib
-import json
 import re
 import subprocess
 from pathlib import Path
@@ -168,7 +167,7 @@ def run(self, repo: str, branch: str, task: Task, git_repo: Repo, repo_path: Pat
             logger.debug("stdout output from the command")
             logger.debug(out_output)
 
-            return Result(json.loads(out_output))
+            return Result(out_output)
         except BuildError:  # can be raised by  :meth:`Result.__init__`
             raise
         except Exception as e:

arca/backend/docker.py

@@ -747,7 +747,7 @@ def run(self, repo: str, branch: str, task: Task, git_repo: Repo, repo_path: Pat
                                       f"/srv/scripts/{task_filename}"],
                                      tty=True)
 
-            return Result(json.loads(res.output))
+            return Result(res.output)
         except BuildError:  # can be raised by  :meth:`Result.__init__`
             raise
         except Exception as e:

arca/backend/vagrant.py

@@ -1,4 +1,3 @@
-import json
 import re
 import subprocess
 from pathlib import Path
@@ -69,7 +68,7 @@ def validate_settings(self):
         * ``provider`` format
         * ``use_registry_name`` is set
         """
-        super(VagrantBackend, self).validate_settings()
+        super().validate_settings()
 
         if self.use_registry_name is None:
             raise ArcaMisconfigured("Push to registry setting is required for VagrantBackend")
@@ -213,7 +212,7 @@ def run(self, repo: str, branch: str, task: Task, git_repo: Repo, repo_path: Pat
         try:
             res = api.execute(self.fabric_task, container_name=container_name, definition_filename=task_filename)
 
-            return Result(json.loads(res[vagrant.user_hostname_port()].stdout))
+            return Result(res[vagrant.user_hostname_port()].stdout)
         except BuildError:  # can be raised by  :meth:`Result.__init__`
             raise
         except Exception as e:

arca/result.py

@@ -1,4 +1,5 @@
-from typing import Dict, Any
+import json
+from typing import Dict, Any, Union
 
 from arca.exceptions import BuildError
 
@@ -7,7 +8,14 @@ class Result:
     """ For storing results of the tasks. So far only has one attribute, :attr:`output`.
     """
 
-    def __init__(self, result: Dict[str, Any]) -> None:
+    def __init__(self, result: Union[str, Dict[str, Any]]) -> None:
+        if isinstance(result, (str, bytes, bytearray)):
+            try:
+                result = json.loads(result)
+            except ValueError:
+                raise BuildError("The build failed (the output was corrupted, "
+                                 "possibly by the callable printing something)")
+
         if not isinstance(result, dict):
             raise BuildError("The build failed (the value returned from the runner was not valid)")