ls_mlkit.util.hook.base_hook module

class ls_mlkit.util.hook.base_hook.Hook(name: str, stage: HookStageType, fn: Callable[[...], Any | None], priority: int = 0, enabled: bool = True)

Bases: Generic[HookStageType]

class ls_mlkit.util.hook.base_hook.HookHandler(manager: HookManager[HookStageType], hook: Hook[HookStageType])

Bases: Generic[HookStageType]

disable() → None

enable() → None

property hook: Hook[HookStageType]

remove() → None

class ls_mlkit.util.hook.base_hook.HookManager

Bases: Generic[HookStageType]

disable_hook(name: str = None, stage: HookStageType = None) → None

enable_hook(name: str = None, stage: HookStageType = None, enabled: bool = True) → None

list_hooks() → None

register_hook(hook: Hook[HookStageType]) → HookHandler[HookStageType]

register_hooks(hooks: list[Hook[HookStageType]]) → list[HookHandler[HookStageType]]

run_hooks(stage: HookStageType, tgt_key_name=None, **kwargs) → Any | None

Executes all enabled hooks for a given stage, optionally updating or collecting results in kwargs, and returns either the final modified kwargs or a specific key’s value.

Parameters:

• stage (HookStageType) – _description_

• tgt_key_name (_type_, optional) – target key name. Defaults to None.

unregister_hook(name: str, stage: HookStageType | None = None) → None