Merge pull request #1 from quarkslab/code-clean

style: various improvements on the code style

bindings/python/quokka/addresser.py

@@ -63,8 +63,8 @@ def file(self, offset: int) -> int:
         """
         try:
             segment = self.program.get_segment(offset)
-        except KeyError:
-            raise quokka.NotInFileError("Unable to find the segment")
+        except KeyError as exc:
+            raise quokka.NotInFileError("Unable to find the segment") from exc
 
         if segment.file_offset != -1:
             return offset + segment.file_offset

bindings/python/quokka/analysis/__init__.py

@@ -1,3 +1,7 @@
+"""Analysis modules
+
+This module contain some utilities function to manipulate the binaries.
+"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

bindings/python/quokka/analysis/arch.py

@@ -1,3 +1,4 @@
+"""Architecture module"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,9 +13,11 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-import capstone
 import collections
 from enum import IntEnum, IntFlag
+
+import capstone
+
 from quokka.types import List, RegType
 
 
@@ -35,11 +38,11 @@ def make_enums(
         A list of IntEnum/IntFlag
     """
     data = collections.defaultdict(dict)
-    for k, v in getattr(capstone_module, "__dict__").items():
-        _, cat, name = k.split("_", maxsplit=2)
+    for key, val in getattr(capstone_module, "__dict__").items():
+        _, cat, name = key.split("_", maxsplit=2)
         if name not in blacklist:
             name = "_" + name if "0" <= name[0] <= "9" else name
-            data[cat][name] = v
+            data[cat][name] = val
 
     return [
         IntEnum(x, names=data[x], module=__name__)
@@ -73,6 +76,7 @@ class ArchEnum(IntEnum):
 
 class QuokkaArch:
     """Base class for a QuokkaArch"""
+
     address_size: int
     compared_mnemonics: List[str]
     stack_pointer: RegType
@@ -100,6 +104,7 @@ class ArchX86(QuokkaArch):  # type: ignore
 
 class ArchX64(ArchX86):  # type: ignore
     """Arch X64 definition"""
+
     address_size = 64
 
     frame_pointer = ArchX86.regs.RBP
@@ -109,6 +114,7 @@ class ArchX64(ArchX86):  # type: ignore
 
 class ArchARM(QuokkaArch):  # type: ignore
     """ArchARM definition"""
+
     (
         cc,
         cpsflag,
@@ -157,11 +163,13 @@ class ArchARM(QuokkaArch):  # type: ignore
 
 class ArchARMThumb(ArchARM):  # type: ignore
     """Arch Arm Thum definition"""
+
     thumb: bool = True
 
 
 class ArchARM64(QuokkaArch):  # type: ignore
     """Arch Arm64 definition"""
+
     (
         at,
         barrier,

bindings/python/quokka/analysis/calling_convention.py

@@ -1,3 +1,4 @@
+"""Calling conventions"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,6 +22,7 @@
 
 class CallingConvention:
     """Base class for a calling convention"""
+
     name: str
     argument_registers: List[RegType]
     floating_point_registers: List[RegType]
@@ -33,6 +35,7 @@ class CallingConvention:
 
 class CCdecl(CallingConvention):
     """Cdecl calling convention"""
+
     name = "cdecl"
     argument_registers: List[RegType] = []  # All arguments are on the stack
     floating_point_registers: List[RegType] = []  # Same
@@ -48,12 +51,14 @@ class CCdecl(CallingConvention):
 
 class Stdcall(CCdecl):
     """Stdcall calling convention"""
+
     name = "stdcall"
     callee_saved = True
 
 
 class Fastcall(CallingConvention):
     """Fastcall calling convention"""
+
     name = "fastcall"
     argument_registers = [ArchX86.regs.ECX, ArchX86.regs.EDX]
     floating_point_registers = [ArchX86.regs.ST0, ArchX86.regs.ST1]  # TODO(dm) check
@@ -70,6 +75,7 @@ class Fastcall(CallingConvention):
 
 class MicrosoftAMD64(CallingConvention):
     """Microsoft 64 calling convention"""
+
     name = "ms"
     argument_registers = [
         ArchX64.regs.RCX,
@@ -91,6 +97,7 @@ class MicrosoftAMD64(CallingConvention):
 
 class SystemVAMD(CallingConvention):
     """SysV calling convention"""
+
     name = "sysv"
     argument_registers = [
         ArchX64.regs.RDI,
@@ -124,6 +131,7 @@ class SystemVAMD(CallingConvention):
 
 class ARMCC(CallingConvention):
     """AAPCS calling convention for ARM"""
+
     name = "aapcs"
     argument_registers = [
         ArchARM.regs.R0,
@@ -138,6 +146,7 @@ class ARMCC(CallingConvention):
 
 class ARM64CC(CallingConvention):
     """AAPCS calling convention for Aarch64"""
+
     name = "aapcs"
     argument_registers = [
         ArchARM64.regs.X0,

bindings/python/quokka/analysis/env.py

@@ -1,3 +1,4 @@
+"""Environment module"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -55,8 +56,8 @@ def get_calling_convention_for_arch_platform(
     for architecture, convention in platform_mapping.items():
         if issubclass(arch, architecture):
             return convention
-    else:
-        return cc.CallingConvention
+
+    return cc.CallingConvention
 
 
 class Environment:
@@ -72,6 +73,7 @@ class Environment:
         calling_convention: Calling convention
 
     """
+
     def __init__(
         self,
         platform: quokka.analysis.Platform,
@@ -87,6 +89,7 @@ def __init__(
 
 class Platform(enum.Enum):
     """Platform enumeration"""
+
     UNKNOWN = enum.auto()
     WINDOWS = enum.auto()
     LINUX = enum.auto()

bindings/python/quokka/analysis/replacer.py

@@ -20,9 +20,10 @@
 class Replacer:
     """Replacer class
 
-    Warning: This class has been used in some experiments but will should probably be
+    Warning: This class has been used in some experiments but will/should probably be
     removed because it does not belong to the project.
     """
+
     ignored_registers: List[str]
     ignored_mnemonics: List[str]
 

bindings/python/quokka/analysis/utils.py

@@ -1,3 +1,4 @@
+"""Utilities functions for the analysis"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,7 +17,7 @@
 import networkx as nx
 
 import quokka
-from quokka.types import Union, List
+from quokka.types import Union
 
 
 def split_chunk(
@@ -36,5 +37,5 @@ def split_chunk(
     components = list(nx.connected_components(nx.Graph(chunk.graph)))
     if len(components) <= 1:
         return chunk
-    else:
-        return quokka.function.SuperChunk(chunk, components)
+
+    return quokka.function.SuperChunk(chunk, components)

bindings/python/quokka/backends/__init__.py

@@ -1,3 +1,4 @@
+"""Backends integration"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

bindings/python/quokka/backends/capstone.py

@@ -1,3 +1,4 @@
+"""Capstone integration"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -46,8 +47,8 @@ def get_capstone_context(arch: Type[quokka.analysis.QuokkaArch]) -> capstone.Cs:
 
     try:
         capstone_arch, capstone_mode = mapping.get(arch)
-    except TypeError:
-        raise quokka.CapstoneError("Unable to find the Architecture")
+    except TypeError as exc:
+        raise quokka.CapstoneError("Unable to find the Architecture") from exc
 
     context = capstone.Cs(capstone_arch, capstone_mode)
     context.detail = True

bindings/python/quokka/backends/pypcode.py

@@ -1,3 +1,4 @@
+"""PyPCode integration"""
 #  Copyright 2022 Quarkslab
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -75,8 +76,10 @@ def get_pypcode_context(
 
     try:
         target_id = names[arch]
-    except KeyError:
-        raise quokka.PypcodeError("Unable to find the appropriate arch: missing id")
+    except KeyError as exc:
+        raise quokka.PypcodeError(
+            "Unable to find the appropriate arch: missing id"
+        ) from exc
 
     pcode_arch = get_arch_from_string(target_id)
     return pypcode.Context(pcode_arch)
@@ -157,20 +160,20 @@ def combine_instructions(
         while remaining_size > 0:
             try:
                 pcode_inst: pypcode.Translation = next(translated_instructions)
-            except StopIteration:
+            except StopIteration as exc:
                 logger.error(
-                    f"Disassembly discrepancy between Pypcode / IDA: missing inst"
+                    "Disassembly discrepancy between Pypcode / IDA: missing inst"
                 )
                 raise quokka.PypcodeError(
                     f"Decoding error for block at 0x{block.start:x}"
-                )
+                ) from exc
 
             remaining_size -= pcode_inst.length
             instruction._pcode_insts.extend(pcode_inst.ops)
 
             if remaining_size < 0:
                 logger.error(
-                    f"Disassembly discrepancy between Pypcode / IDA: sizes mismatch"
+                    "Disassembly discrepancy between Pypcode / IDA: sizes mismatch"
                 )
                 raise quokka.PypcodeError(
                     f"Decoding error for block at 0x{block.start:x}"
@@ -287,6 +290,5 @@ def pypcode_decode_instruction(
         )
         return instructions
 
-    else:
-        logger.error(translation.error.explain)
-        raise quokka.PypcodeError("Unable to decode instruction")
+    logger.error(translation.error.explain)
+    raise quokka.PypcodeError("Unable to decode instruction")

bindings/python/quokka/block.py

@@ -33,7 +33,6 @@
     MutableMapping,
     ReferenceType,
     Set,
-    Union,
 )