msticpy.init.mp_plugins module

MSTICPy plugin loader.

To load MSTICPy plugins you must have modules with classes defined from one of the supported plugin types.

To specify the locations to look for plugins specify the folder(s) as absolute paths or relative to the current directory

msticpyconfig.yaml

PluginFolders:

• tests/testdata/dp_plugins

• tests/testdata/ti_plugins

• tests/testdata/mixed_plugins

class msticpy.init.mp_plugins.PluginReg(reg_dest: type | ModuleType, name_property: str | None)

Bases: NamedTuple

Plugin registration tuple.

Create new instance of PluginReg(reg_dest, name_property)

count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

name_property: str | None

Alias for field number 1

reg_dest: type | ModuleType

Alias for field number 0

msticpy.init.mp_plugins.load_plugins_from_path(plugin_path: str | Path)

Load all compatible plugins found in plugin_path.

msticpy.init.mp_plugins.read_plugins(plugin_paths: str | Iterable[str])

Load plugins from folders specified in msticpyconfig.yaml.