Class TypedProfileCommand

source code

Mixin that provides the plugin with standardized table output.

Instance Methods

__init__(self, *pos_args, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

column_types(self)
Returns instances for each column definition.

source code

collect(self)
Collect data that will be passed to renderer.table_row.

source code

collect_as_dicts(self)

source code

render(self, renderer, **options)

source code

reflect(self, member)

source code

getkeys(self)

source code

get_column(self, name)

source code

get_column_type(self, name)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

args(cls, parser)

source code

Class Variables
	table_header = `None` hash(x)
	table_options = `{}`
	ROW_OPTIONS = `set(['annotation', 'depth', 'hex_width', 'highli...`
	plugin_args = `None` hash(x) (Inherited from rekall.plugin.ArgsParserMixin)

Properties
Inherited from `object`: `__class__`

Method Details

init(self, *pos_args, **kwargs)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

column_types(self)

source code

Returns instances for each column definition.

The actual objects that are returned when the plugin runs are often determined at run time because they depend on the profile loaded.

This method is used in order to introspect the types of each column without actually running the plugin. A plugin must provide an instance for each column without running any code. This allows interospectors to learn about the output format before running the actual plugin.

Note that this method should almost always be overloaded. We try to do our best here but it is not ideal. Ultimately all plugins will override this method and just declare a column_types() method.

Class Variable Details

ROW_OPTIONS

Value:

set(['annotation', 'depth', 'hex_width', 'highlight', 'nowrap'])

Class TypedProfileCommand

__init__(self, *pos_args, **kwargs) (Constructor)

column_types(self)

ROW_OPTIONS

init(self, *pos_args, **kwargs)
(Constructor)