dissect.target.plugins.general.plugins

Module Contents

Classes

PluginListPlugin

Plugin list plugin (so meta).

Functions

generate_functions_overview	Generate a tree list of functions with optional documentation.
generate_functions_json	Generate a JSON representation of all available functions.

dissect.target.plugins.general.plugins.generate_functions_overview(functions: list[dissect.target.plugin.FunctionDescriptor] | None = None, include_docs: bool = False) → list[str]

Generate a tree list of functions with optional documentation.

dissect.target.plugins.general.plugins.generate_functions_json(functions: list[dissect.target.plugin.FunctionDescriptor] | None = None) → str

Generate a JSON representation of all available functions.

class dissect.target.plugins.general.plugins.PluginListPlugin(target: dissect.target.Target)

Bases: dissect.target.plugin.Plugin

Plugin list plugin (so meta).

check_compatible() → None

Perform a compatibility check with the target.

This function should return None if the plugin is compatible with the current target (self.target). For example, check if a certain file exists. Otherwise it should raise an UnsupportedPluginError.

Raises:

UnsupportedPluginError – If the plugin could not be loaded.

plugins(print_docs: bool = False, as_json: bool = False) → None

Print all available plugins.