Package rekall :: Package ui :: Module text :: Class TextRenderer

Class TextRenderer

Renderer for the command line that supports paging, colors and progress.

Nested Classes
	table_class A table is a collection of columns.
	__metaclass__ Automatic Plugin Registration through metaclasses. (Inherited from rekall.ui.renderer.BaseRenderer)
	top_level_class All renderers inherit from this. (Inherited from rekall.ui.renderer.BaseRenderer)

Instance Methods

__init__(self, tablesep=' ', output=None, mode='a+b', fd=None, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature source code

section(self, name=None, width=50)
Start a new section.

source code

format(self, formatstring, *data)
Parse and interpolate the format string.

source code

write(self, data)
Renderer should write some data.

source code

flush(self)
Renderer should flush data.

source code

table_header(self, *args, **options)
Table header renders the title row of a table.

source code

table_row(self, *args, **kwargs)
Outputs a single row of a table.

source code

GetColumns(self)

source code

RenderProgress(self, message=' %(spinner)s', *args, **kwargs)
Will be called to render a progress message to the user. source code

ClearProgress(self)
Delete the last progress message.

source code

open(self, directory=None, filename=None, mode='rb')
Opens a file for writing or reading. source code

Log(self, record)
Logs a log message. (Inherited from rekall.ui.renderer.BaseRenderer)

source code

__enter__(self) (Inherited from rekall.ui.renderer.BaseRenderer)

source code

__exit__(self, exc_type, exc_value, trace) (Inherited from rekall.ui.renderer.BaseRenderer)

source code

end(self)
Tells the renderer that we finished using it for a while. (Inherited from rekall.ui.renderer.BaseRenderer)

source code

get_object_renderer(self, target=None, type=None, target_renderer=None, **options) (Inherited from rekall.ui.renderer.BaseRenderer)

source code

report_error(self, message)
Render the error in an appropriate way. (Inherited from rekall.ui.renderer.BaseRenderer)

source code

start(self, plugin_name=None, kwargs=None)
The method is called when new output is required. (Inherited from rekall.ui.renderer.BaseRenderer)

source code

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

Class Methods

ImplementationByClass(self, name)

source code

ImplementationByName(self, name)

source code

Class Variables
	name = `'text'` hash(x)
	tablesep = `' '`
	paging_limit = `None` hash(x)
	progress_fd = `None` hash(x)
	deferred_rows = `None` hash(x)
	spinner = `'/-\\\|'`
	last_spin = `0`
	last_message_len = `0`
	classes = `{'BaseRenderer': <class 'rekall.ui.renderer.BaseRend...` (Inherited from rekall.ui.renderer.BaseRenderer)
	classes_by_name = `{None: [<class 'rekall.ui.renderer.BaseRende...` (Inherited from rekall.ui.renderer.BaseRenderer)
	last_gc_time = `0` (Inherited from rekall.ui.renderer.BaseRenderer)
	last_spin_time = `0` (Inherited from rekall.ui.renderer.BaseRenderer)
	plugin_feature = `'BaseRenderer'` (Inherited from rekall.ui.renderer.BaseRenderer)
	progress_interval = `0.2` (Inherited from rekall.ui.renderer.BaseRenderer)
	table = `None` hash(x) (Inherited from rekall.ui.renderer.BaseRenderer)

Properties
Inherited from `object`: `__class__`

Method Details

init(self, tablesep=`'` `'`, output=None, mode=`'a+b'`, fd=None, **kwargs)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

section(self, name=None, width=50)

source code

Start a new section.

Sections are used to separate distinct entries (e.g. reports of different files).

Overrides: renderer.BaseRenderer.section: (inherited documentation)

format(self, formatstring, *data)

source code

Parse and interpolate the format string.

A format string consists of a string with interpolation markers embedded. The syntax for an interpolation marker is {pos:opt1=value,opt2=value}, where pos is the position of the data element to interpolate, and opt1, opt2 are the options to provide the object renderer.

For example:

renderer.format("Process {0:style=compact}", task)

For backwards compatibility we support the following syntaxes: {0:#x} equivalent to {0:style=address} {1:d} equivalent to {1}

Overrides: renderer.BaseRenderer.format

write(self, data)

source code

Renderer should write some data.

Overrides: renderer.BaseRenderer.write: (inherited documentation)

flush(self)

source code

Renderer should flush data.

Overrides: renderer.BaseRenderer.flush: (inherited documentation)

table_header(self, *args, **options)

source code

Table header renders the title row of a table.

This also stores the header types to ensure everything is formatted appropriately. It must be a list of specs rather than a dict for ordering purposes.

Overrides: renderer.BaseRenderer.table_header: (inherited documentation)

table_row(self, *args, **kwargs)

source code

Outputs a single row of a table.

Text tables support these additional kwargs:
  highlight: Highlights this raw according to the color scheme (e.g.
             important, good...)