Skip to content

component_model.py

ofrak.model.component_model

ClientComponentContext (ComponentContext)

__init__(self) special

Initialize self. See help(type(self)) for accurate signature.

Source code in ofrak/model/component_model.py
def __init__(self):
    super().__init__(CLIENT_COMPONENT_ID, CLIENT_COMPONENT_VERSION)

ComponentConfig dataclass

Base class for all components' configs. All subclasses should also be dataclasses.

ComponentContext dataclass

ComponentContext(component_id: bytes, component_version: int, access_trackers: Dict[bytes, ofrak.model.component_model.ComponentResourceAccessTracker] = , modification_trackers: Dict[bytes, ofrak.model.component_model.ComponentResourceModificationTracker] = , resources_created: Set[bytes] = , resources_deleted: Set[bytes] = )

ComponentResourceAccessTracker dataclass

ComponentResourceAccessTracker(data_accessed: Set[ofrak_type.range.Range] = , attributes_accessed: Set[Type[ofrak.model.resource_model.ResourceAttributes]] = )

ComponentResourceModificationTracker dataclass

ComponentResourceModificationTracker(data_patches: List[ofrak.model.data_model.DataPatch] = , data_moves: List[ofrak.model.data_model.DataMove] = )

ComponentRunResult dataclass

Dataclass created after one or more components complete, holding high-level information about what resources were affected by a component or components