pylint

Author: montyly

crytic_compile/platform/foundry.py

@@ -1,25 +1,17 @@
 """
 Truffle platform
 """
-import json
 import logging
 import os
 import shutil
 import subprocess
 from pathlib import Path
 from typing import TYPE_CHECKING, List
 
-from crytic_compile.compilation_unit import CompilationUnit
-from crytic_compile.compiler.compiler import CompilerVersion
 from crytic_compile.platform.abstract_platform import AbstractPlatform
-from crytic_compile.platform.exceptions import InvalidCompilation
 from crytic_compile.platform.types import Type
-from crytic_compile.utils.naming import convert_filename, extract_name
-from crytic_compile.utils.natspec import Natspec
 from .hardhat import hardhat_like_parsing
 
-from .solc import relative_to_short
-
 # Handle cycle
 if TYPE_CHECKING:
     from crytic_compile import CryticCompile

crytic_compile/platform/hardhat.py

@@ -25,10 +25,24 @@
 
 LOGGER = logging.getLogger("CryticCompile")
 
-
+# pylint: disable=too-many-locals
 def hardhat_like_parsing(
     crytic_compile: "CryticCompile", target: str, build_directory: Path, working_dir: str
 ) -> None:
+    """
+    This function parse the output generated by hardhat.
+    It can be re-used by any platform that follows the same schema (ex:foudnry)
+
+
+    Args:
+        crytic_compile: CryticCompile object
+        target: target
+        build_directory: build directory
+        working_dir: working directory
+
+    Returns:
+
+    """
     files = sorted(
         os.listdir(build_directory), key=lambda x: os.path.getmtime(Path(build_directory, x))
     )
@@ -128,7 +142,6 @@ class Hardhat(AbstractPlatform):
     PROJECT_URL = "https://github.com/nomiclabs/hardhat"
     TYPE = Type.HARDHAT
 
-    # pylint: disable=too-many-locals,too-many-statements
     def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
         """Run the compilation