introduce customizable plugin arparse epilog

Abyss-W4tcher · Jan 10, 2025 · 5859011 · 5859011
1 parent cedc0b0
commit 5859011
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/volatility3/cli/__init__.py b/volatility3/cli/__init__.py
@@ -368,6 +368,9 @@ def run(self):
                 help=plugin_list[plugin].__doc__,
                 description=plugin_list[plugin].__doc__,
             )
+            epilog = getattr(plugin_list[plugin], "_argparse_epilog", None)
+            if epilog is not None:
+                plugin_parser.epilog = epilog
             self.populate_requirements_argparse(plugin_parser, plugin_list[plugin])
 
         ###

diff --git a/volatility3/framework/interfaces/plugins.py b/volatility3/framework/interfaces/plugins.py
@@ -112,6 +112,8 @@ class PluginInterface(
     # Be careful with inheritance around this (We default to requiring a version which doesn't exist, so it must be set)
     _required_framework_version: Tuple[int, int, int] = (0, 0, 0)
     """The _version variable is a quick way for plugins to define their current interface, it should follow SemVer rules"""
+    _argparse_epilog: str = None
+    """Display additional description of the plugin after the description of the arguments. See: https://docs.python.org/3/library/argparse.html#epilog"""
 
     def __init__(
         self,