Allow plugins to re-use arguments from main tools (#1262)

Author: Schamper

dissect/target/helpers/docs.py

@@ -118,7 +118,7 @@ def _get_real_func_obj(func: Callable) -> tuple[type[Plugin], Callable]:
         func = func.fget
 
     if inspect.ismethod(func):
-        for klass in inspect.getmro(func.__self__.__class__):
+        for klass in func.__self__.__class__.__mro__:
             if func.__name__ in klass.__dict__:
                 break
         else:

dissect/target/plugins/general/loaders.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import json
+import json as jsonlib
 
 from dissect.target.helpers.docs import INDENT_STEP, get_docstring
 from dissect.target.loader import LOADERS_BY_SCHEME
@@ -14,12 +14,8 @@ def check_compatible(self) -> None:
         pass
 
     @export(output="none")
-    # NOTE: We would prefer to re-use arguments across plugins from argparse in query.py, but that is not possible yet.
-    # For now we use --as-json, but in the future this should be changed to inherit --json from target-query.
-    # https://github.com/fox-it/dissect.target/pull/841
-    # https://github.com/fox-it/dissect.target/issues/889
-    @arg("--as-json", dest="as_json", action="store_true", help="output in JSON format")
-    def loaders(self, as_json: bool = False) -> None:
+    @arg("-j", "--json", action="store_true", help="output in JSON format")
+    def loaders(self, json: bool = False) -> None:
         """List the available loaders."""
 
         loaders_info = {}
@@ -32,8 +28,8 @@ def loaders(self, as_json: bool = False) -> None:
 
         loaders = sorted(loaders_info.items())
 
-        if as_json:
-            print(json.dumps([{"name": name, "description": desc} for name, desc in loaders]), end="")
+        if json:
+            print(jsonlib.dumps([{"name": name, "description": desc} for name, desc in loaders]), end="")
 
         else:
             print("Available loaders:")

dissect/target/plugins/general/plugins.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import json
+import json as jsonlib
 import textwrap
 
 from dissect.target import plugin
@@ -92,7 +92,7 @@ def generate_functions_json(functions: list[plugin.FunctionDescriptor] | None =
     if failures := plugin.failed():
         failed = [{"module": f.module, "stacktrace": "".join(f.stacktrace)} for f in failures]
 
-    return json.dumps({"loaded": loaded, "failed": failed})
+    return jsonlib.dumps({"loaded": loaded, "failed": failed})
 
 
 def _get_os_functions() -> list[plugin.FunctionDescriptor]:
@@ -162,14 +162,10 @@ def check_compatible(self) -> None:
 
     @export(output="none", cache=False)
     @arg("--docs", dest="print_docs", action="store_true", help="output docstrings")
-    # NOTE: We would prefer to re-use arguments across plugins from argparse in query.py, but that is not possible yet.
-    # For now we use --as-json, but in the future this should be changed to inherit --json from target-query.
-    # https://github.com/fox-it/dissect.target/pull/841
-    # https://github.com/fox-it/dissect.target/issues/889
-    @arg("--as-json", dest="as_json", action="store_true", help="output in JSON format")
-    def plugins(self, print_docs: bool = False, as_json: bool = False) -> None:
+    @arg("-j", "--json", action="store_true", help="output in JSON format")
+    def plugins(self, print_docs: bool = False, json: bool = False) -> None:
         """Print all available plugins."""
-        if as_json:
+        if json:
             print(generate_functions_json(), end="")
         else:
             print(generate_functions_overview(include_docs=print_docs))

dissect/target/plugins/os/unix/esxi/_os.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import gzip
-import json
+import json as jsonlib
 import lzma
 import struct
 import subprocess
@@ -189,12 +189,12 @@ def vm_inventory(self) -> Iterator[VirtualMachineRecord]:
 
     @export(output="none")
     @arg("path", help="config path")
-    @arg("--as-json", action="store_true", help="format as json")
-    def esxconf(self, path: str, as_json: bool) -> None:
+    @arg("-j", "--json", action="store_true", help="output in JSON format")
+    def esxconf(self, path: str, json: bool) -> None:
         obj = self._cfg(path)
 
-        if as_json:
-            print(json.dumps(obj, indent=4, sort_keys=True))
+        if json:
+            print(jsonlib.dumps(obj, indent=4, sort_keys=True))
         else:
             print(obj)
 
@@ -578,11 +578,11 @@ def parse_config_store(fh: BinaryIO) -> dict[str, Any]:
             identifier["creation_time"] = row.CreationTime
             identifier["version"] = row.Version
             identifier["success"] = row.Success
-            identifier["auto_conf_value"] = json.loads(row.AutoConfValue) if row.AutoConfValue else None
-            identifier["user_value"] = json.loads(row.UserValue) if row.UserValue else None
-            identifier["vital_value"] = json.loads(row.VitalValue) if row.VitalValue else None
-            identifier["cached_value"] = json.loads(row.CachedValue) if row.CachedValue else None
-            identifier["desired_value"] = json.loads(row.DesiredValue) if row.DesiredValue else None
+            identifier["auto_conf_value"] = jsonlib.loads(row.AutoConfValue) if row.AutoConfValue else None
+            identifier["user_value"] = jsonlib.loads(row.UserValue) if row.UserValue else None
+            identifier["vital_value"] = jsonlib.loads(row.VitalValue) if row.VitalValue else None
+            identifier["cached_value"] = jsonlib.loads(row.CachedValue) if row.CachedValue else None
+            identifier["desired_value"] = jsonlib.loads(row.DesiredValue) if row.DesiredValue else None
             identifier["revision"] = row.Revision
 
     return store

dissect/target/tools/dd.py

@@ -35,8 +35,8 @@ def main() -> int:
     parser.add_argument("-b", "--bytes", type=int, default=-1, help="amount of bytes to read")
     configure_generic_arguments(parser)
 
-    args, rest = parser.parse_known_args()
-    process_generic_arguments(args, rest)
+    args, _ = parser.parse_known_args()
+    process_generic_arguments(args)
 
     try:
         t = Target.open(args.target)

dissect/target/tools/diff.py

@@ -37,7 +37,7 @@
 from dissect.target.tools.utils import (
     catch_sigpipe,
     configure_generic_arguments,
-    generate_argparse_for_bound_method,
+    generate_argparse_for_method,
     process_generic_arguments,
 )
 
@@ -119,7 +119,7 @@ def get_plugin_output_records(plugin_name: str, plugin_arg_parts: list[str], tar
         raise ValueError("Comparing plugin output is only supported for plugins outputting records.")
 
     if callable(attr):
-        argparser = generate_argparse_for_bound_method(attr)
+        argparser = generate_argparse_for_method(attr)
         try:
             args = argparser.parse_args(plugin_arg_parts)
         except SystemExit:
@@ -965,8 +965,8 @@ def main() -> int:
 
     configure_generic_arguments(parser)
 
-    args, rest = parser.parse_known_args()
-    process_generic_arguments(args, rest)
+    args, _ = parser.parse_known_args()
+    process_generic_arguments(args)
 
     if len(args.targets) < 2:
         parser.error("at least two targets are required for target-diff")

dissect/target/tools/dump/run.py

@@ -300,7 +300,7 @@ def parse_arguments() -> tuple[argparse.Namespace, list[str]]:
     configure_generic_arguments(parser)
 
     args, rest = parser.parse_known_args()
-    process_generic_arguments(args, rest)
+    process_generic_arguments(args)
 
     if not args.function and ("-h" in rest or "--help" in rest):
         parser.print_help()

dissect/target/tools/fs.py

@@ -143,8 +143,8 @@ def main() -> int:
     parser_cp.set_defaults(handler=cp)
     configure_generic_arguments(parser)
 
-    args, rest = parser.parse_known_args()
-    process_generic_arguments(args, rest)
+    args, _ = parser.parse_known_args()
+    process_generic_arguments(args)
 
     if args.subcommand is None:
         parser.error("No subcommand specified")

dissect/target/tools/info.py

@@ -58,7 +58,7 @@ def main() -> int:
     parser.add_argument("-J", "--jsonlines", action="store_true", help="output records as one-line json")
     configure_generic_arguments(parser)
 
-    args, rest = parser.parse_known_args()
+    args, _ = parser.parse_known_args()
 
     if not args.targets and not args.from_file:
         parser.error("too few arguments")
@@ -72,7 +72,7 @@ def main() -> int:
             targets = targets[:-1]
         args.targets = targets
 
-    process_generic_arguments(args, rest)
+    process_generic_arguments(args)
 
     try:
         for i, target in enumerate(Target.open_all(args.targets, include_children=args.children)):

dissect/target/tools/mount.py

@@ -58,8 +58,8 @@ def main() -> int:
     parser.add_argument("-o", "--options", help="additional FUSE options")
     configure_generic_arguments(parser)
 
-    args, rest = parser.parse_known_args()
-    process_generic_arguments(args, rest)
+    args, _ = parser.parse_known_args()
+    process_generic_arguments(args)
 
     if not HAS_FUSE:
         log.error("fusepy is not installed: pip install fusepy")