Skip to content

Commit

Permalink
Merge pull request #1538 from Abyss-W4tcher/plugins_argparse_epilogue
Browse files Browse the repository at this point in the history
Introduce customizable plugin arparse epilog
  • Loading branch information
ikelos authored Jan 10, 2025
2 parents bedcaa2 + 8842375 commit a677714
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions volatility3/cli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,7 @@ def run(self):
plugin,
help=plugin_list[plugin].__doc__,
description=plugin_list[plugin].__doc__,
epilog=plugin_list[plugin].additional_description,
)
self.populate_requirements_argparse(plugin_parser, plugin_list[plugin])

Expand Down
2 changes: 1 addition & 1 deletion volatility3/framework/constants/_version.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# We use the SemVer 2.0.0 versioning scheme
VERSION_MAJOR = 2 # Number of releases of the library with a breaking change
VERSION_MINOR = 15 # Number of changes that only add to the interface
VERSION_MINOR = 16 # Number of changes that only add to the interface
VERSION_PATCH = 0 # Number of changes that do not change the interface
VERSION_SUFFIX = ""

Expand Down
2 changes: 2 additions & 0 deletions volatility3/framework/interfaces/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"""
additional_description: 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,
Expand Down

0 comments on commit a677714

Please sign in to comment.