mirror of
https://github.com/volatilityfoundation/volatility3.git
synced 2026-09-08 18:57:38 +02:00
Minor typos and docstring improvements, plus some todos.
This commit is contained in:
@@ -38,7 +38,7 @@ class ConfigurationGroup(validity.ValidityRoutines):
|
||||
self._options = {}
|
||||
|
||||
def __getattr__(self, attr):
|
||||
"""Locates an option within a configurationgroup and returns it"""
|
||||
"""Locates an option within a ConfigurationGroup and returns it"""
|
||||
if attr in self._options:
|
||||
return self._options[attr]
|
||||
|
||||
@@ -56,7 +56,7 @@ class Configuration(validity.ValidityRoutines):
|
||||
self._config_groups = {}
|
||||
|
||||
def __getattr__(self, attr):
|
||||
"""Locates a group within the configuration and returns it"""
|
||||
"""Locates a group within the Configuration and returns it"""
|
||||
if attr in self._config_groups:
|
||||
return self._config_groups[attr]
|
||||
raise AttributeError("Attribute " + attr + " not found in the configuration")
|
||||
|
||||
@@ -19,20 +19,26 @@ class PluginInterface(validity.ValidityRoutines):
|
||||
return self._context
|
||||
|
||||
def establish_context(self):
|
||||
"""Alters the context to ensure the plugin can run"""
|
||||
"""Alters the context to ensure the plugin can run.
|
||||
|
||||
This function constructs the necessary address spaces and symbol spaces that the plugin will need.
|
||||
"""
|
||||
raise NotImplementedError("Abstract method establish_context must be overridden by plugins.")
|
||||
|
||||
def plugin_options(self, config_group = None):
|
||||
"""Modifies the passed in ConfigGroup object to contain the required options"""
|
||||
raise NotImplementedError("Abstract method plugin_options must be overridden by plugins")
|
||||
|
||||
def __call__(self):
|
||||
def __call__(self, context):
|
||||
"""Executes the functionality of the code
|
||||
|
||||
Returns an OutputUI object
|
||||
|
||||
@:param
|
||||
|
||||
:return: a TreeGrid object that can then be passed to a Renderer.
|
||||
:rtype: TreeGrid
|
||||
"""
|
||||
|
||||
|
||||
# Needs to say what it can/can't handle (validate context)
|
||||
# Needs to offer available options'
|
||||
# Figure out how to handle global config options
|
||||
# TODO: Needs to say what it can/can't handle (validate context)
|
||||
# TODO: Needs to offer available options'
|
||||
# TODO: Figure out how to handle global config options
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
|
||||
|
||||
# TODO: Code to import all the py/pyc files available (but not both).
|
||||
# TODO: Code to return a none-instantiated list of plugin classes.
|
||||
@@ -1 +1,3 @@
|
||||
__author__ = 'mike'
|
||||
import volatility.framework.constants as constants
|
||||
|
||||
__path__ = constants.PLUGINS_PATH
|
||||
Reference in New Issue
Block a user