Merge pull request #235 from 0xalpharush/bump-linter

dguido · web-flow · commit 2279686404c7 · 2022-03-08T11:31:56.000-05:00
Bump linter
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -33,7 +33,7 @@ jobs:
           cp pyproject.toml .github/linters
 
       - name: Black
-        uses: docker://github/super-linter:v3
+        uses: docker://github/super-linter:v4
         if: always()
         env:
           # run linter on everything to catch preexisting problems
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,4 +32,4 @@ jobs:
         TEST_TYPE: ${{ matrix.type }}
         GITHUB_ETHERSCAN: ${{ secrets.GITHUB_ETHERSCAN }}
       run: |
-        bash scripts/travis_test_${TEST_TYPE}.sh
+        bash "scripts/travis_test_${TEST_TYPE}.sh"
diff --git a/.github/workflows/etherscan.yml b/.github/workflows/etherscan.yml
@@ -31,4 +31,4 @@ jobs:
         TEST_TYPE: ${{ matrix.type }}
         GITHUB_ETHERSCAN: ${{ secrets.GITHUB_ETHERSCAN }}
       run: |
-        bash scripts/travis_test_${TEST_TYPE}.sh
+        bash "scripts/travis_test_${TEST_TYPE}.sh"
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -33,7 +33,7 @@ jobs:
           cp pyproject.toml .github/linters
 
       - name: Lint everything else
-        uses: docker://github/super-linter:v3
+        uses: docker://github/super-linter:v4
         if: always()
         env:
           # run linter on everything to catch preexisting problems
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -33,7 +33,7 @@ jobs:
           cp mypy.ini .github/linters
 
       - name: Mypy
-        uses: docker://github/super-linter:v3
+        uses: docker://github/super-linter:v4
         if: always()
         env:
           # run linter on everything to catch preexisting problems
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
@@ -33,7 +33,7 @@ jobs:
           cp pyproject.toml .github/linters
 
       - name: Pylint
-        uses: docker://github/super-linter:v3
+        uses: docker://github/super-linter:v4
         if: always()
         env:
           # run linter on everything to catch preexisting problems
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,7 +14,7 @@ crytic-compile uses the pull request contribution model. Please make an account
 
 Some pull request guidelines:
 
-- Work from the [`dev`](https://github.com/crytic/crytic-compile/tree/dev) branch. We performed extensive tests prior to merging anything to `master`, working from `dev` will allow us to merge your work faster.
+- Work from the [`dev`](https://github.com/crytic/crytic-compile/tree/dev) branch. We perform extensive tests prior to merging anything to `master`, working from `dev` will allow us to merge your work faster.
 - Minimize irrelevant changes (formatting, whitespace, etc) to code that would otherwise not be touched by this patch. Save formatting or style corrections for a separate pull request that does not make any semantic changes.
 - When possible, large changes should be split up into smaller focused pull requests.
 - Fill out the pull request description with a summary of what your patch does, key changes that have been made, and any further points of discussion, if applicable.
@@ -35,7 +35,7 @@ To run them locally:
 - `darglint crytic_compile`
 
 
-We use pylint `2.8.2`, black `20.8b1`, mypy `0.812` and dargling `1.8.0`.
+We use pylint `2.12.2`, black `21.10b0`, mypy `0.812` and darglint `1.8.0`.
 
 ## Development Environment
 Instructions for installing a development version of crytic-compile can be found in our [wiki](https://github.com/crytic/crytic-compile/wiki/Developer-installation).
diff --git a/crytic_compile/compilation_unit.py b/crytic_compile/compilation_unit.py
@@ -618,7 +618,7 @@ def _update_bytecode_with_libraries(
                 if library_found in libraries:
                     bytecode = re.sub(
                         re.escape(library_found),
-                        "{:040x}".format(int(libraries[library_found])),
+                        f"{libraries[library_found]:0>40x}",
                         bytecode,
                     )
         return bytecode
diff --git a/crytic_compile/crytic_compile.py b/crytic_compile/crytic_compile.py
@@ -91,13 +91,13 @@ def __init__(self, target: Union[str, AbstractPlatform], **kwargs: str):
         # This is not memory optimized, but allow an offset lookup in O(1)
         # Because we frequently do this lookup in Slither during the AST parsing
         # We decided to favor the running time versus memory
-        self._cached_offset_to_line: Dict[Filename, Dict[int, Tuple[int, int]]] = dict()
+        self._cached_offset_to_line: Dict[Filename, Dict[int, Tuple[int, int]]] = {}
         # Lines are indexed from 1
         self._cached_line_to_offset: Dict[Filename, Dict[int, int]] = defaultdict(dict)
 
         # Return the line from the line number
         # Note: line 1 is at index 0
-        self._cached_line_to_code: Dict[Filename, List[bytes]] = dict()
+        self._cached_line_to_code: Dict[Filename, List[bytes]] = {}
 
         self._working_dir = Path.cwd()
 
@@ -259,7 +259,7 @@ def _get_cached_offset_to_line(self, file: Filename) -> None:
 
         source_code = self._cached_line_to_code[file]
         acc = 0
-        lines_delimiters: Dict[int, Tuple[int, int]] = dict()
+        lines_delimiters: Dict[int, Tuple[int, int]] = {}
         for line_number, x in enumerate(source_code):
             self._cached_line_to_offset[file][line_number + 1] = acc
 
@@ -630,7 +630,7 @@ def compile_all(target: str, **kwargs: str) -> List[CryticCompile]:
             compilations = load_from_zip(target)
         elif target.endswith(".zip.base64"):
             with tempfile.NamedTemporaryFile() as tmp:
-                with open(target) as target_file:
+                with open(target, encoding="base64") as target_file:
                     tmp.write(base64.b64decode(target_file.read()))
                     compilations = load_from_zip(tmp.name)
         else:
diff --git a/crytic_compile/platform/abstract_platform.py b/crytic_compile/platform/abstract_platform.py
@@ -45,21 +45,21 @@ def __init__(self, target: str, **_kwargs: str):
         """
         if not self.NAME:
             raise IncorrectPlatformInitialization(
-                "NAME is not initialized {}".format(self.__class__.__name__)
+                f"NAME is not initialized {self.__class__.__name__}"
             )
 
         if not self.PROJECT_URL:
             raise IncorrectPlatformInitialization(
-                "PROJECT_URL is not initialized {}".format(self.__class__.__name__)
+                f"PROJECT_URL is not initialized {self.__class__.__name__}"
             )
 
         if self.TYPE == Type.NOT_IMPLEMENTED:
             raise IncorrectPlatformInitialization(
-                "TYPE is not initialized {}".format(self.__class__.__name__)
+                f"TYPE is not initialized {self.__class__.__name__}"
             )
 
         self._target: str = target
-        self._cached_dependencies: Dict[str, bool] = dict()
+        self._cached_dependencies: Dict[str, bool] = {}
 
     # region Properties.
     ###################################################################################
diff --git a/crytic_compile/platform/buidler.py b/crytic_compile/platform/buidler.py
@@ -228,10 +228,10 @@ def _get_version_from_config(builder_directory: Path) -> Tuple[str, str, bool]:
         path_config = Path(builder_directory, "last-vyper-config.json")
         if not path_config.exists():
             raise InvalidCompilation(f"{path_config} not found")
-        with open(path_config) as config_f:
+        with open(path_config, "r", encoding="utf8") as config_f:
             version = config_f.read()
             return "vyper", version, False
-    with open(path_config) as config_f:
+    with open(path_config, "r", encoding="utf8") as config_f:
         config = json.load(config_f)
 
     version = config["solc"]["version"]
diff --git a/crytic_compile/platform/dapp.py b/crytic_compile/platform/dapp.py
@@ -60,7 +60,7 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
 
         optimized = False
 
-        with open(os.path.join(directory, "dapp.sol.json")) as file_desc:
+        with open(os.path.join(directory, "dapp.sol.json"), "r", encoding="utf8") as file_desc:
             targets_json = json.load(file_desc)
 
             version: Optional[str] = None
diff --git a/crytic_compile/platform/etherscan.py b/crytic_compile/platform/etherscan.py
@@ -234,7 +234,7 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
             etherscan_bytecode_url += f"&apikey={bscan_api_key}"
 
         source_code: str = ""
-        result: Dict[str, Union[bool, str, int]] = dict()
+        result: Dict[str, Union[bool, str, int]] = {}
         contract_name: str = ""
 
         if not only_bytecode:
diff --git a/crytic_compile/platform/solc.py b/crytic_compile/platform/solc.py
@@ -31,7 +31,7 @@
 
 
 def _build_contract_data(compilation_unit: "CompilationUnit") -> Dict:
-    contracts = dict()
+    contracts = {}
 
     for filename, contract_names in compilation_unit.filename_to_contracts.items():
         for contract_name in contract_names:
@@ -376,6 +376,7 @@ def get_version(solc: str, env: Optional[Dict[str, str]]) -> str:
                 raise InvalidCompilation(f"Solidity version not found: {stdout}")
             return version[0]
     except OSError as error:
+        print("get versions")
         # pylint: disable=raise-missing-from
         raise InvalidCompilation(error)
 
@@ -460,9 +461,7 @@ def _run_solc(
     if not os.path.isfile(filename) and (
         not working_dir or not os.path.isfile(os.path.join(str(working_dir), filename))
     ):
-        raise InvalidCompilation(
-            "{} does not exist (are you in the correct directory?)".format(filename)
-        )
+        raise InvalidCompilation(f"{filename} does not exist (are you in the correct directory?)")
 
     if not filename.endswith(".sol"):
         raise InvalidCompilation("Incorrect file format")
@@ -516,6 +515,7 @@ def _run_solc(
             process = subprocess.Popen(
                 cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **additional_kwargs
             )
+        print(cmd)
     except OSError as error:
         # pylint: disable=raise-missing-from
         raise InvalidCompilation(error)
diff --git a/crytic_compile/platform/solc_standard_json.py b/crytic_compile/platform/solc_standard_json.py
@@ -49,7 +49,7 @@ def standalone_compile(
         LOGGER.error("The compiler version of the compilation unit must be set")
         return
 
-    standard_json_dict: Dict = dict()
+    standard_json_dict: Dict = {}
     build_standard_json_default(standard_json_dict)
 
     for filename in filenames:
@@ -340,7 +340,7 @@ def __init__(self, target: Union[str, dict] = None, **kwargs: str):
         super().__init__(str(target), **kwargs)
 
         if target is None:
-            self._json: Dict = dict()
+            self._json: Dict = {}
         elif isinstance(target, str):
             if os.path.isfile(target):
                 with open(target, mode="r", encoding="utf-8") as target_file:
diff --git a/crytic_compile/platform/standard.py b/crytic_compile/platform/standard.py
@@ -213,9 +213,9 @@ def generate_standard_export(crytic_compile: "CryticCompile") -> Dict:
 
     compilation_units = {}
     for key, compilation_unit in crytic_compile.compilation_units.items():
-        contracts: Dict[str, Dict[str, Any]] = dict()
+        contracts: Dict[str, Dict[str, Any]] = {}
         for filename, contract_names in compilation_unit.filename_to_contracts.items():
-            contracts[filename.relative] = dict()
+            contracts[filename.relative] = {}
             for contract_name in contract_names:
                 libraries = compilation_unit.libraries_names_and_patterns(contract_name)
                 contracts[filename.relative][contract_name] = {
@@ -225,15 +225,15 @@ def generate_standard_export(crytic_compile: "CryticCompile") -> Dict:
                     "srcmap": ";".join(compilation_unit.srcmap_init(contract_name)),
                     "srcmap-runtime": ";".join(compilation_unit.srcmap_runtime(contract_name)),
                     "filenames": _convert_filename_to_dict(filename),
-                    "libraries": dict(libraries) if libraries else dict(),
+                    "libraries": dict(libraries) if libraries else {},
                     "is_dependency": crytic_compile.is_dependency(filename.absolute),
                     "userdoc": compilation_unit.natspec[contract_name].userdoc.export(),
                     "devdoc": compilation_unit.natspec[contract_name].devdoc.export(),
                 }
 
         # Create our root object to contain the contracts and other information.
 
-        compiler: Dict = dict()
+        compiler: Dict = {}
         if compilation_unit.compiler_version:
             compiler = {
                 "compiler": compilation_unit.compiler_version.compiler,
diff --git a/crytic_compile/platform/truffle.py b/crytic_compile/platform/truffle.py
@@ -132,14 +132,14 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
                             version = package["devDependencies"]["truffle"]
                             if version.startswith("^"):
                                 version = version[1:]
-                            truffle_version = "truffle@{}".format(version)
+                            truffle_version = f"truffle@{version}"
                             base_cmd = ["npx", truffle_version]
                     if "dependencies" in package:
                         if "truffle" in package["dependencies"]:
                             version = package["dependencies"]["truffle"]
                             if version.startswith("^"):
                                 version = version[1:]
-                            truffle_version = "truffle@{}".format(version)
+                            truffle_version = f"truffle@{version}"
                             base_cmd = ["npx", truffle_version]
 
         if not truffle_ignore_compile:
@@ -339,7 +339,7 @@ def _get_version_from_config(target: str) -> Optional[Tuple[str, str]]:
         config = Path(target, "truffle.js")
         if not config.exists():
             return None
-    with open(config) as config_f:
+    with open(config, "r", encoding="utf8") as config_f:
         config_buffer = config_f.read()
 
     # The config is a javascript file
@@ -378,7 +378,7 @@ def _get_version(truffle_call: List[str], cwd: str) -> Tuple[str, str]:
             for line in stdout:
                 if "Solidity" in line:
                     if "native" in line:
-                        return solc.get_version("solc", dict()), "solc-native"
+                        return solc.get_version("solc", {}), "solc-native"
                     version = re.findall(r"\d+\.\d+\.\d+", line)[0]
                     compiler = re.findall(r"(solc[a-z\-]*)", line)
                     if len(compiler) > 0:
@@ -445,7 +445,7 @@ def _write_config(cwd: Path, original_config: Path, version: Optional[str]) -> N
       }}
     }}
     """
-    with open(Path(cwd, original_config), "w") as f:
+    with open(Path(cwd, original_config), "w", encoding="utf8") as f:
         f.write(txt)
 
 
diff --git a/crytic_compile/platform/vyper.py b/crytic_compile/platform/vyper.py
@@ -140,9 +140,7 @@ def _run_vyper(
         Dict: Vyper json compilation artifact
     """
     if not os.path.isfile(filename):
-        raise InvalidCompilation(
-            "{} does not exist (are you in the correct directory?)".format(filename)
-        )
+        raise InvalidCompilation(f"{filename} does not exist (are you in the correct directory?)")
 
     cmd = [vyper, filename, "-f", "combined_json"]
 
@@ -181,9 +179,7 @@ def _get_vyper_ast(
         Dict: [description]
     """
     if not os.path.isfile(filename):
-        raise InvalidCompilation(
-            "{} does not exist (are you in the correct directory?)".format(filename)
-        )
+        raise InvalidCompilation(f"{filename} does not exist (are you in the correct directory?)")
 
     cmd = [vyper, filename, "-f", "ast"]
 
diff --git a/crytic_compile/platform/waffle.py b/crytic_compile/platform/waffle.py
@@ -61,7 +61,7 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
         # Default behaviour (without any config_file)
         build_directory = os.path.join("build")
         compiler = "native"
-        config: Dict = dict()
+        config: Dict = {}
 
         config_file = kwargs.get("waffle_config_file", "waffle.json")
 
@@ -169,8 +169,8 @@ def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
         if not os.path.exists(combined_path):
             raise InvalidCompilation("`Combined-Json.json` not found")
 
-        with open(combined_path, "r") as file_desc:
-            target_all = json.load(file_desc)
+        with open(combined_path, encoding="utf8") as f:
+            target_all = json.load(f)
 
         optimized = None
 
@@ -286,7 +286,11 @@ def _load_config(config_file: str) -> Dict:
     Returns:
         Dict: [description]
     """
-    with open(config_file, "r") as file_desc:
+    with open(
+        config_file,
+        "r",
+        encoding="utf8",
+    ) as file_desc:
         content = file_desc.read()
 
     if "module.exports" in content:
diff --git a/crytic_compile/utils/npm.py b/crytic_compile/utils/npm.py
@@ -30,7 +30,7 @@ def get_package_name(target_txt: Union[str, "SolcStandardJson"]) -> Optional[str
         if target.is_dir():
             package = Path(target, "package.json")
             if package.exists():
-                with open(package) as file_desc:
+                with open(package, "r", encoding="utf8") as file_desc:
                     try:
                         package_dict: Dict[str, str] = json.load(file_desc)
                         return package_dict.get("name", None)
diff --git a/setup.py b/setup.py
@@ -3,17 +3,20 @@
 """
 from setuptools import find_packages, setup
 
+with open("README.md", "r", encoding="utf8") as f:
+    long_description = f.read()
+
 setup(
     name="crytic-compile",
     description="Util to facilitate smart contracts compilation.",
     url="https://github.com/crytic/crytic-compile",
     author="Trail of Bits",
-    version="0.2.1",
+    version="0.2.2",
     packages=find_packages(),
     python_requires=">=3.6",
     install_requires=["pysha3>=1.0.2"],
     license="AGPL-3.0",
-    long_description=open("README.md", encoding="utf8").read(),
+    long_description=long_description,
     package_data={"crytic_compile": ["py.typed"]},
     entry_points={"console_scripts": ["crytic-compile = crytic_compile.__main__:main"]},
 )

Original file line number	Diff line number	Diff line change
`@@ -618,7 +618,7 @@ def _update_bytecode_with_libraries(`
`618`	`618`	`if library_found in libraries:`
`619`	`619`	`bytecode = re.sub(`
`620`	`620`	`re.escape(library_found),`
`621`		`- "{:040x}".format(int(libraries[library_found])),`
	`621`	`+ f"{libraries[library_found]:0>40x}",`
`622`	`622`	`bytecode,`
`623`	`623`	`)`
`624`	`624`	`return bytecode`