Add ruff and pre-commit (#23)

Author: twizmwazin

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.15.4
+  hooks:
+    - id: ruff-check
+      args: [ --fix ]
+    - id: ruff-format

pyproject.toml

@@ -15,4 +15,16 @@ pysoot = ["soot-trunk.jar"]
 
 [dependency-groups]
 testing = ["pytest", "pytest-xdist"]
-dev = [{ include-group = "testing" }]
+dev = [
+    { include-group = "testing" },
+    "ruff>=0.15.4",
+]
+
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "UP",
+    "W",
+]

pysoot/__init__.py

@@ -1 +1,3 @@
 from .lifter import Lifter
+
+__all__ = ["Lifter"]

pysoot/errors.py

@@ -1,4 +1,3 @@
-
 class PySootError(Exception):
     pass
 

pysoot/lifter.py

@@ -8,14 +8,21 @@
 from .soot_manager import SootManager
 
 
-l = logging.getLogger("pysoot.lifter")
+log = logging.getLogger("pysoot.lifter")
 self_dir = os.path.dirname(os.path.realpath(__file__))
 
 
-class Lifter(object):
-
-    def __init__(self, input_file=None, input_format="jar", ir_format="shimple", additional_jars=None,
-                 additional_jar_roots=None, android_sdk=None, save_to_file=None):
+class Lifter:
+    def __init__(
+        self,
+        input_file=None,
+        input_format="jar",
+        ir_format="shimple",
+        additional_jars=None,
+        additional_jar_roots=None,
+        android_sdk=None,
+        save_to_file=None,
+    ):
 
         self.input_file = os.path.realpath(input_file)
         self.save_to_file = save_to_file
@@ -31,47 +38,71 @@ def __init__(self, input_file=None, input_format="jar", ir_format="shimple", add
 
         if input_format == "jar":
             if android_sdk is not None:
-                l.warning("when input_format is 'jar', setting android_sdk is pointless")
+                log.warning(
+                    "when input_format is 'jar', setting android_sdk is pointless"
+                )
             absolute_library_jars = {_find_jrt_jar()}
             if additional_jars is not None:
-                absolute_library_jars |= {os.path.realpath(jar) for jar in additional_jars}
+                absolute_library_jars |= {
+                    os.path.realpath(jar) for jar in additional_jars
+                }
             if additional_jar_roots is not None:
                 for jar_root in additional_jar_roots:
                     for jar_name in os.listdir(jar_root):
                         if jar_name.endswith(".jar"):
-                            absolute_path = os.path.realpath(os.path.join(jar_root, jar_name))
+                            absolute_path = os.path.realpath(
+                                os.path.join(jar_root, jar_name)
+                            )
                             if absolute_path not in absolute_library_jars:
                                 absolute_library_jars.add(absolute_path)
             seperator = ";" if os.name == "nt" else ":"
             bad_jars = [p for p in absolute_library_jars if seperator in p]
             if len(bad_jars) > 0:
-                raise ParameterError("these jars have a semicolon in their name: " + repr(bad_jars))
+                raise ParameterError(
+                    "these jars have a semicolon in their name: " + repr(bad_jars)
+                )
             self.soot_classpath = seperator.join(absolute_library_jars)
 
         elif input_format == "apk":
             if android_sdk is None:
-                raise ParameterError("when format is apk, android_sdk should point to something like: "
-                                     "~/Android/Sdk/platforms")
+                raise ParameterError(
+                    "when format is apk, android_sdk should point to something like: "
+                    "~/Android/Sdk/platforms"
+                )
             if additional_jars is not None or additional_jar_roots is not None:
-                l.warning("when input_format is 'apk', setting additional_jars or additional_jar_roots is pointless")
+                log.warning(
+                    "when input_format is 'apk', setting additional_jars or "
+                    "additional_jar_roots is pointless"
+                )
             self.android_sdk = android_sdk
 
         self._get_ir()
 
     def _get_ir(self):
         config = {}
-        settings = ["input_file", "input_format", "ir_format", "android_sdk", "soot_classpath", "main_class"]
+        settings = [
+            "input_file",
+            "input_format",
+            "ir_format",
+            "android_sdk",
+            "soot_classpath",
+            "main_class",
+        ]
         for s in settings:
             config[s] = str(getattr(self, s, None))
 
         self.soot_wrapper = SootManager()
 
-        l.info("Running Soot with the following config: " + repr(config))
+        log.info("Running Soot with the following config: " + repr(config))
         self.soot_wrapper.init(**config)
         if self.save_to_file is None:
             self.classes = self.soot_wrapper.get_classes()
         else:
-            ipc_options = {'return_result': False, 'return_pickle': False, 'save_pickle': self.save_to_file}
+            ipc_options = {
+                "return_result": False,
+                "return_pickle": False,
+                "save_pickle": self.save_to_file,
+            }
             self.classes = self.soot_wrapper.get_classes(_ipc_options=ipc_options)
 
 
@@ -81,13 +112,13 @@ def _get_java_home() -> str:
         return os.environ["JAVA_HOME"]
 
     # Command to get Java properties
-    command = ["java", '-XshowSettings:properties', '-version']
+    command = ["java", "-XshowSettings:properties", "-version"]
     # Execute the command and capture the output
     result = subprocess.run(command, capture_output=True, text=True)
     # Extract JAVA_HOME from the output
     for line in result.stderr.splitlines():
         if "java.home" in line:
-            return line.split('=')[1].strip()
+            return line.split("=")[1].strip()
 
     raise JavaNotFoundError
 

pysoot/soot_manager.py

@@ -22,13 +22,20 @@ class SootManager:
     def __init__(self, java_heap_size: int | None = None):
         if java_heap_size is None:
             # use 75% of total memory for the Java heap
-            self.java_heap_size = int(psutil.virtual_memory().total*0.75)
+            self.java_heap_size = int(psutil.virtual_memory().total * 0.75)
         else:
             self.java_heap_size = java_heap_size
         startJVM()
 
-
-    def init(self, main_class, input_file, input_format: str, android_sdk: str | None, soot_classpath: str | None, ir_format: str):
+    def init(
+        self,
+        main_class,
+        input_file,
+        input_format: str,
+        android_sdk: str | None,
+        soot_classpath: str | None,
+        ir_format: str,
+    ):
         Collections = JClass("java.util.Collections")
 
         G = JClass("soot.G")
@@ -81,12 +88,16 @@ def get_classes(self):
         classes = {}
         for raw_class in self.raw_classes:
             # TODO with this we only get classes for which we have all the code
-            # soot also has classes with lower "resolving levels", but for those we may not have
-            # the method list or the code, if we want them we cannot fully translate them
+            # soot also has classes with lower "resolving levels", but for those we may
+            # not have the method list or the code, if we want them we cannot fully
+            # translate them
             if raw_class.isApplicationClass():
                 soot_class = SootClass.from_ir(raw_class)
                 classes[soot_class.name] = soot_class
         return classes
 
     def getSubclassesOf(self, class_name: str) -> list[str]:
-        return [c.getName() for c in self.hierarchy.getSubclassesOf(self.class_name_map[class_name])]
+        return [
+            c.getName()
+            for c in self.hierarchy.getSubclassesOf(self.class_name_map[class_name])
+        ]

pysoot/sootir/soot_block.py

@@ -12,11 +12,8 @@ class SootBlock:
     idx: int | None
 
     def __repr__(self):
-        return "<Block %d [%d], %d statements>" % (
-            self.idx if self.idx is not None else -1,
-            self.label,
-            len(self.statements),
-        )
+        idx = self.idx if self.idx is not None else -1
+        return f"<Block {idx} [{self.label}], {len(self.statements)} statements>"
 
     def __str__(self):
         tstr = "//" + repr(self) + "\n"

pysoot/sootir/soot_class.py

@@ -77,5 +77,10 @@ def from_ir(ir_class):
         else:
             super_class = ""
         return SootClass(
-            class_name, super_class, tuple(interface_names), tuple(attrs), tuple(methods), frozendict(fields)
+            class_name,
+            super_class,
+            tuple(interface_names),
+            tuple(attrs),
+            tuple(methods),
+            frozendict(fields),
         )