fix: add ruff rules

Author: SmoothHacker

.ruff.toml

@@ -0,0 +1,3 @@
+[lint]
+select = ["F", "SIM", "C4", "B", "LOG", "RET", "TC", "E", "W", "PL"]
+ignore = ["E501"]

README.md

@@ -14,6 +14,3 @@ current binary view and any successive binary view in the current session.
 A potential workflow for this plugin would be to compile an open source library with debug information, load it into
 Binary Ninja,
 run the debug info parser, and export it to a type library.
-
-## Future Plans
-- [ ] Headless support

__init__.py

@@ -8,7 +8,15 @@ def is_valid(bv: BinaryView):
     return bv.has_initial_analysis()
 
 
-PluginCommand.register("Export As Type Library", "Compiles the exported function types into a type library",
-                       export.export_functions, is_valid)
-PluginCommand.register("Apply Type Library", "Loads and applies a type library to the current binary view",
-                       apply.load_library, is_valid)
+PluginCommand.register(
+    "Export As Type Library",
+    "Compiles the exported function types into a type library",
+    export.export_functions,
+    is_valid,
+)
+PluginCommand.register(
+    "Apply Type Library",
+    "Loads and applies a type library to the current binary view",
+    apply.load_library,
+    is_valid,
+)

apply.py

@@ -6,13 +6,14 @@
 
 
 def get_library_path() -> Optional[str]:
-    library_path = bn.TextLineField("Path to load type library:", "~/Desktop/libcapstone.bntl")
+    library_path = bn.TextLineField(
+        "Path to load type library:", "~/Desktop/libcapstone.bntl"
+    )
     bn.get_form_input([library_path], "Apply Type Library Options")
     res_path = os.path.expanduser(library_path.result)
     if os.path.exists(res_path):
         return res_path
-    else:
-        return None
+    return None
 
 
 def apply_library(bv: BinaryView, typelib_handle: TypeLibrary):
@@ -27,7 +28,7 @@ def apply_library(bv: BinaryView, typelib_handle: TypeLibrary):
 def load_library(bv: BinaryView):
     lib_path = get_library_path()
     if lib_path is None:
-        bn.log_error(f"Supplied path was invalid")
+        bn.log_error("Supplied path was invalid")
         return
     bn.log_debug(f"lib_path: {lib_path}")
     typelib_handle = TypeLibrary.load_from_file(lib_path)

export.py

@@ -7,7 +7,9 @@
 from binaryninja import TypeLibrary, Function
 
 
-def create_type_library(log: Logger, bv: BinaryView, func_list: list[Function], config: dict) -> TypeLibrary:
+def create_type_library(
+    log: Logger, bv: BinaryView, func_list: list[Function], config: dict
+) -> TypeLibrary:
     typelib = TypeLibrary.new(bv.arch, config["lib_name"])
     typelib.add_platform(bv.platform)
 
@@ -24,49 +26,70 @@ def create_type_library(log: Logger, bv: BinaryView, func_list: list[Function],
     return typelib
 
 
-def get_funcs_from_syms(log: Logger, bv: BinaryView, func_syms: list[CoreSymbol]) -> list[Function]:
+def get_funcs_from_syms(
+    log: Logger, bv: BinaryView, func_syms: list[CoreSymbol]
+) -> list[Function]:
     func_list = []
     for sym in func_syms:
         res = bv.get_function_at(sym.address)
         if res is None:
-            log.log_warn(f"Function: {sym.name} at address: {sym.address} does not exist in the current binary view")
+            log.log_warn(
+                f"Function: {sym.name} at address: {sym.address} does not exist in the current binary view"
+            )
         else:
             func_list.append(res)
 
     return func_list
 
 
 def get_config_options(bv: BinaryView):
-    lib_name = bn.TextLineField("Type Library Name:", f"{os.path.basename(bv.file.filename)}")
-    alternate_names = bn.TextLineField("Alternative Names (optional):", "lib_musl.so;lib_musl.so.5")
-    export_path = bn.TextLineField("Path to store type library:", f"~/{os.path.basename(bv.file.filename)}.bntl")
+    lib_name = bn.TextLineField(
+        "Type Library Name:", f"{os.path.basename(bv.file.filename)}"
+    )
+    alternate_names = bn.TextLineField(
+        "Alternative Names (optional):", "lib_musl.so;lib_musl.so.5"
+    )
+    export_path = bn.TextLineField(
+        "Path to store type library:", f"~/{os.path.basename(bv.file.filename)}.bntl"
+    )
     dependency_name = bn.TextLineField("Dependency Name (optional):")
-    bn.get_form_input([lib_name, alternate_names, export_path, dependency_name], "Export as Type Library Options")
+    bn.get_form_input(
+        [lib_name, alternate_names, export_path, dependency_name],
+        "Export as Type Library Options",
+    )
 
-    config = {"lib_name": lib_name.result, "alternate_names": alternate_names.result, "export_path": os.path.expanduser(export_path.result),
-              "dependency_name": dependency_name.result}
-    return config
+    return {
+        "lib_name": lib_name.result,
+        "alternate_names": alternate_names.result,
+        "export_path": os.path.expanduser(export_path.result),
+        "dependency_name": dependency_name.result,
+    }
 
 
 def export_functions(bv: BinaryView):
     log = bv.create_logger("TypeLib_Exporter")
     config = get_config_options(bv)
-    if not os.path.exists(os.path.dirname(config['export_path'])):
-        log.log_error(f"Please specify a path to export the type library: {config['export_path']}")
+    if not os.path.exists(os.path.dirname(config["export_path"])):
+        log.log_error(
+            f"Please specify a path to export the type library: {config['export_path']}"
+        )
         return
     if len(config["lib_name"]) == 0:
         log.log_error(f"lib name: [{config['lib_name']}]")
         log.log_error("Please specify a name for the type library")
         return
 
     func_list = bv.get_symbols_of_type(SymbolType.FunctionSymbol)
-    export_func_syms = [sym for sym in func_list
-                        if sym.binding == SymbolBinding.GlobalBinding or sym.binding == SymbolBinding.WeakBinding]
+    export_func_syms = [
+        sym
+        for sym in func_list
+        if sym.binding in (SymbolBinding.GlobalBinding, SymbolBinding.WeakBinding)
+    ]
 
     export_funcs = get_funcs_from_syms(log, bv, export_func_syms)
     log.log_debug(f"Discovered {len(export_funcs)} exported functions")
 
     typelib = create_type_library(log, bv, export_funcs, config)
     typelib.finalize()
     log.log_info(f"Exported {len(export_funcs)} functions to {config['export_path']}")
-    typelib.write_to_file(config['export_path'])
+    typelib.write_to_file(config["export_path"])

plugin.json

@@ -12,7 +12,7 @@
   "description": "This plugin compiles exported functions and its corresponding types into a type library. Type libraries can also be applied to existing bndbs through this plugin.",
   "license": {
     "name": "MIT",
-    "text": "Copyright (c) 2022 Scott Lagler\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
+    "text": "Copyright (c) 2025 Scott Lagler\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
   },
   "platforms": [
     "Darwin",
@@ -30,7 +30,7 @@
     "installers": [],
     "other": []
   },
-  "version": "2.2",
+  "version": "2.3",
   "author": "SmoothHacker",
   "minimumbinaryninjaversion": 3469
 }