volatility.cli.text_renderer module

class CLIRenderer(options=None)[source]

Bases: volatility.framework.interfaces.renderers.Renderer

Class to add specific requirements for CLI renderers.

Accepts an options object to configure the renderers.

abstract get_render_options()

Returns a list of rendering options.

Return type

List[Any]

name = 'unnamed'
abstract render(grid)

Takes a grid object and renders it based on the object’s preferences.

Return type

None

class CSVRenderer(options=None)[source]

Bases: volatility.cli.text_renderer.CLIRenderer

Accepts an options object to configure the renderers.

get_render_options()[source]

Returns a list of rendering options.

name = 'csv'
render(grid)[source]

Renders each row immediately to stdout.

Parameters

grid (TreeGrid) – The TreeGrid object to render

Return type

None

class PrettyTextRenderer(options=None)[source]

Bases: volatility.cli.text_renderer.CLIRenderer

Accepts an options object to configure the renderers.

get_render_options()[source]

Returns a list of rendering options.

name = 'pretty'
render(grid)[source]

Renders each column immediately to stdout.

This does not format each line’s width appropriately, it merely tab separates each field

Parameters

grid (TreeGrid) – The TreeGrid object to render

Return type

None

class QuickTextRenderer(options=None)[source]

Bases: volatility.cli.text_renderer.CLIRenderer

Accepts an options object to configure the renderers.

get_render_options()[source]

Returns a list of rendering options.

name = 'quick'
render(grid)[source]

Renders each column immediately to stdout.

This does not format each line’s width appropriately, it merely tab separates each field

Parameters

grid (TreeGrid) – The TreeGrid object to render

Return type

None

display_disassembly(disasm)[source]

Renders a disassembly renderer type into string format.

Parameters

disasm (Disassembly) – Input disassembly objects

Return type

str

Returns

A string as rendererd by capstone where available, otherwise output as if it were just bytes

hex_bytes_as_text(value)[source]

Renders HexBytes as text.

Parameters

value (bytes) – A series of bytes to convert to text

Return type

str

Returns

A text representation of the hexadecimal bytes plus their ascii equivalents, separated by newline characters

optional(func)[source]
quoted_optional(func)[source]