auto-clean: first draft implementation

Author: elopez

crytic_compile/crytic_compile.py

@@ -545,6 +545,8 @@ def _compile(self, **kwargs: str) -> None:
             self._run_custom_build(custom_build)
 
         else:
+            if not kwargs.get("skip_clean", False) and not kwargs.get("ignore_compile", False):
+                self._platform.clean(**kwargs)
             self._platform.compile(self, **kwargs)
 
         remove_metadata = kwargs.get("compile_remove_metadata", False)

crytic_compile/platform/abstract_platform.py

@@ -119,6 +119,15 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
         """
         return
 
+    @abc.abstractmethod
+    def clean(self, **kwargs: str) -> None:
+        """Clean compilation artifacts
+
+        Args:
+            **kwargs: optional arguments.
+        """
+        return
+
     @staticmethod
     @abc.abstractmethod
     def is_supported(target: str, **kwargs: str) -> bool:

crytic_compile/platform/archive.py

@@ -71,7 +71,7 @@ def compile(self, crytic_compile: "CryticCompile", **_kwargs: str) -> None:
         """Run the compilation
 
         Args:
-            crytic_compile (CryticCompile): asscoiated CryticCompile object
+            crytic_compile (CryticCompile): associated CryticCompile object
             **_kwargs: unused
         """
         # pylint: disable=import-outside-toplevel
@@ -97,6 +97,9 @@ def compile(self, crytic_compile: "CryticCompile", **_kwargs: str) -> None:
 
         crytic_compile.src_content = loaded_json["source_content"]
 
+    def clean(self, **_kwargs: str) -> None:
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is an archive

crytic_compile/platform/brownie.py

@@ -82,6 +82,10 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
 
         _iterate_over_files(crytic_compile, Path(self._target), filenames)
 
+    def clean(self, **_kwargs: str) -> None:
+        # brownie does not offer a way to clean a project
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a brownie project

crytic_compile/platform/buidler.py

@@ -171,6 +171,10 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
                     crytic_compile.filenames.add(path)
                     compilation_unit.asts[path.absolute] = info["ast"]
 
+    def clean(self, **kwargs: str) -> None:
+        # TODO: call "buldler clean"?
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a buidler project

crytic_compile/platform/dapp.py

@@ -116,6 +116,30 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
             compiler="solc", version=version, optimized=optimized
         )
 
+    def clean(self, **kwargs: str) -> None:
+        """Clean compilation artifacts
+
+        Args:
+            **kwargs: optional arguments.
+        """
+
+        dapp_ignore_compile = kwargs.get("dapp_ignore_compile", False) or kwargs.get(
+            "ignore_compile", False
+        )
+        if dapp_ignore_compile:
+            return
+
+        cmd = ["dapp", "clean"]
+        LOGGER.info(
+            "'%s' running",
+            " ".join(cmd),
+        )
+        subprocess.run(
+            cmd,
+            cwd=self._target,
+            executable=shutil.which(cmd[0]),
+        )
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a dapp project

crytic_compile/platform/embark.py

@@ -168,6 +168,14 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
                 natspec = Natspec(userdoc, devdoc)
                 compilation_unit.natspec[contract_name] = natspec
 
+    def clean(self, **_kwargs: str) -> None:
+        """Clean compilation artifacts
+
+        Args:
+            **kwargs: unused.
+        """
+        return
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is an embark project

crytic_compile/platform/etherlime.py

@@ -157,6 +157,10 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: Any) -> None:
             compiler=compiler, version=version, optimized=_is_optimized(compile_arguments)
         )
 
+    def clean(self, **_kwargs: str) -> None:
+        # TODO: research if there's a way to clean artifacts
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is an etherlime project

crytic_compile/platform/etherscan.py

@@ -357,6 +357,9 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
 
         solc_standard_json.standalone_compile(filenames, compilation_unit, working_dir=working_dir)
 
+    def clean(self, **_kwargs: str) -> None:
+        pass
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a etherscan project

crytic_compile/platform/foundry.py

@@ -157,6 +157,14 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
             compiler=compiler, version=version, optimized=optimized, optimize_runs=runs
         )
 
+    def clean(self, **_kwargs: str) -> None:
+        """Clean compilation artifacts
+
+        Args:
+            **kwargs: unused.
+        """
+        return
+
     @staticmethod
     def is_supported(target: str, **kwargs: str) -> bool:
         """Check if the target is a foundry project