Skip to content

manager

dev_tool.event.app.manager

AppEventManager

A manager class for application lifecycle events.

This class handles the registration and emission of application events through an event bus system with lifecycle hooks.

The constructor for the AppEventManager class.

Parameters:

  • event_bus (EventBus) –

    The event bus instance for publishing events.

Source code in dev_tool/event/app/manager.py 
22
23
24
25
26
27
28
29
30
31
32
33
def __init__(self, event_bus: EventBus) -> None:
    """
    The constructor for the AppEventManager class.

    :param event_bus: The event bus instance for publishing events.
    """

    self.event_bus = event_bus
    self.handler = AppLifecycleHandler()

    for event_type in cast('Iterable[AppEventType]', AppEventType):
        self.event_bus.subscribe(event_type, self.handler)

event_bus = event_bus instance-attribute

handler = AppLifecycleHandler() instance-attribute

emit_app_event

A method that emits an application lifecycle event.

Parameters:

  • event_type (AppEventType) –

    The type of application event to emit.

  • data (dict[str, Any] | None, default: None ) –

    Optional event data dictionary.

Source code in dev_tool/event/app/manager.py 
35
36
37
38
39
40
41
42
43
def emit_app_event(self, event_type: AppEventType, data: dict[str, Any] | None = None) -> None:
    """
    A method that emits an application lifecycle event.

    :param event_type: The type of application event to emit.
    :param data: Optional event data dictionary.
    """

    self.event_bus.emit(event_type, data or {}, source='app')

register_hook

A method that registers a function to run when an application event occurs.

Parameters:

  • event_type (AppEventType) –

    The application event type to listen for.

  • function (Callable) –

    The callback function to execute when the event occurs.

Source code in dev_tool/event/app/manager.py 
45
46
47
48
49
50
51
52
53
def register_hook(self, event_type: AppEventType, function: Callable) -> None:
    """
    A method that registers a function to run when an application event occurs.

    :param event_type: The application event type to listen for.
    :param function: The callback function to execute when the event occurs.
    """

    self.handler.register_hook(event_type, function)