Skip to content
v0.1.3

Hooks Module API Reference

This section documents the internals of the hooks module in Bijux CLI.

bijux_cli.services.plugins.hooks

Defines the hook specifications for the Bijux CLI plugin system.

This module uses pluggy's hook specification markers to define the formal set of hooks that plugins can implement. The CoreSpec class groups all standard lifecycle and execution hooks that the core application will invoke on registered plugins. This provides a clear and versioned interface for plugin developers.

CoreSpec 

CoreSpec(dependency_injector: DIContainer)

Defines the core hook specifications for CLI plugins.

Plugins can implement methods matching these specifications to integrate with the CLI's lifecycle and command execution flow.

Attributes:

Initializes the CoreSpec.

Parameters:

  • dependency_injector (DIContainer) –

    The DI container for resolving services like the logger.

Source code in src/bijux_cli/services/plugins/hooks.py 
40
41
42
43
44
45
46
47
def __init__(self, dependency_injector: DIContainer) -> None:
    """Initializes the `CoreSpec`.

    Args:
        dependency_injector (DIContainer): The DI container for resolving
            services like the logger.
    """
    self._log = dependency_injector.resolve(ObservabilityProtocol)

health 

health() -> bool | str

A hook to check the health of a plugin.

This hook is called by the bijux plugins check command. A plugin can return a boolean or a string to indicate its status.

Returns:

  • bool | str –

    bool | str: True for healthy, False for unhealthy, or a string with a descriptive status message.

Source code in src/bijux_cli/services/plugins/hooks.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
@hookspec
def health(self) -> bool | str:
    """A hook to check the health of a plugin.

    This hook is called by the `bijux plugins check` command. A plugin can
    return a boolean or a string to indicate its status.

    Returns:
        bool | str: `True` for healthy, `False` for unhealthy, or a string
            with a descriptive status message.
    """
    self._log.log("debug", "Hook health called", extra={})
    return True

post_execute async 

post_execute(name: str, result: Any) -> None

A hook that is called immediately after a command has executed.

Parameters:

  • name (str) –

    The name of the command that was executed.

  • result (Any) –

    The result object returned from the command.

Source code in src/bijux_cli/services/plugins/hooks.py 
84
85
86
87
88
89
90
91
92
93
94
95
96
@hookspec
async def post_execute(self, name: str, result: Any) -> None:
    """A hook that is called immediately after a command has executed.

    Args:
        name (str): The name of the command that was executed.
        result (Any): The result object returned from the command.
    """
    self._log.log(
        "debug",
        "Hook post_execute called",
        extra={"name": name, "result": repr(result)},
    )

pre_execute async 

pre_execute(
    name: str, args: tuple[Any, ...], kwargs: dict[str, Any]
) -> None

A hook that is called immediately before a command is executed.

Parameters:

  • name (str) –

    The name of the command to be executed.

  • args (tuple[Any, ...]) –

    The positional arguments passed to the command.

  • kwargs (dict[str, Any]) –

    The keyword arguments passed to the command.

Source code in src/bijux_cli/services/plugins/hooks.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@hookspec
async def pre_execute(
    self, name: str, args: tuple[Any, ...], kwargs: dict[str, Any]
) -> None:
    """A hook that is called immediately before a command is executed.

    Args:
        name (str): The name of the command to be executed.
        args (tuple[Any, ...]): The positional arguments passed to the command.
        kwargs (dict[str, Any]): The keyword arguments passed to the command.
    """
    self._log.log(
        "debug",
        "Hook pre_execute called",
        extra={"name": name, "args": args, "kwargs": kwargs},
    )

shutdown async 

shutdown() -> None

A hook that is called once when the CLI engine shuts down.

Plugins can use this hook to perform cleanup tasks, such as releasing resources or flushing buffers.

Source code in src/bijux_cli/services/plugins/hooks.py 
58
59
60
61
62
63
64
65
@hookspec
async def shutdown(self) -> None:
    """A hook that is called once when the CLI engine shuts down.

    Plugins can use this hook to perform cleanup tasks, such as releasing
    resources or flushing buffers.
    """
    self._log.log("debug", "Hook shutdown called", extra={})

startup async 

startup() -> None

A hook that is called once when the CLI engine starts up.

Plugins can use this hook to perform initialization tasks, such as setting up resources or starting background tasks.

Source code in src/bijux_cli/services/plugins/hooks.py 
49
50
51
52
53
54
55
56
@hookspec
async def startup(self) -> None:
    """A hook that is called once when the CLI engine starts up.

    Plugins can use this hook to perform initialization tasks, such as
    setting up resources or starting background tasks.
    """
    self._log.log("debug", "Hook startup called", extra={})