l2tscaffolder.definitions package¶
Submodules¶
l2tscaffolder.definitions.interface module¶
Interface defining how a project class looks like.
l2tscaffolder.definitions.manager module¶
The definition manager.
-
class
l2tscaffolder.definitions.manager.
DefinitionManager
[source]¶ Bases:
object
The definition manager.
-
classmethod
DeregisterDefinition
(definition_class: Type[l2tscaffolder.definitions.interface.ScaffolderDefinition])[source]¶ Deregisters a definition class.
Definition classes are identified by their NAME attribute.
Parameters: definition_class (type) – definition class (subclass of ScaffolderDefinition). Raises: KeyError
– if definition class is not set for the corresponding name.
-
classmethod
GetDefinitionByName
(name: str) → Type[l2tscaffolder.definitions.interface.ScaffolderDefinition][source]¶ Returns a definition class based on registered name.
Parameters: name (str) – name of the definition. Returns: - definition class or None
- if name is not registered.
Return type: interface.ScaffolderDefinition
-
classmethod
GetDefinitionNames
() → Iterator[str][source]¶ Yields all names of registered definition classes.
Yields: str – definition names.
-
classmethod
GetDefinitionObjects
() → Iterator[l2tscaffolder.definitions.interface.ScaffolderDefinition][source]¶ Yields instances of each registered definition class.
Yields: ScaffolderDefinition – definition object.
-
classmethod
RegisterDefinition
(definition_class: Type[l2tscaffolder.definitions.interface.ScaffolderDefinition])[source]¶ Registers a definition class.
Definition classes are identified by their NAME attribute.
Parameters: definition_class (ScaffolderDefinition) – definition class. Raises: KeyError
– if definition class is already set for the corresponding name.
-
classmethod
l2tscaffolder.definitions.plaso module¶
The plaso definition class.
-
class
l2tscaffolder.definitions.plaso.
PlasoProject
[source]¶ Bases:
l2tscaffolder.definitions.interface.ScaffolderDefinition
Plaso project definition.
-
NAME
= 'plaso'¶
-
l2tscaffolder.definitions.timesketch module¶
The Timesketch definition class.
-
class
l2tscaffolder.definitions.timesketch.
TimesketchProject
[source]¶ Bases:
l2tscaffolder.definitions.interface.ScaffolderDefinition
Timesketch project definition.
-
NAME
= 'timesketch'¶
-
l2tscaffolder.definitions.turbinia module¶
The Turbinia definition class.
-
class
l2tscaffolder.definitions.turbinia.
TurbiniaProject
[source]¶ Bases:
l2tscaffolder.definitions.interface.ScaffolderDefinition
Turbinia project definition.
-
NAME
= 'turbinia'¶
-
Module contents¶
This file imports Python modules that registers definitions.