.. This page is generated by scripts/generate_dataclass_docs.py.
   Do not edit manually.


Hook
====

.. automodule:: teksi_hooks.hook

HookContext
-----------

.. autoclass:: teksi_hooks.hook.HookContext
   :members:

Fields
~~~~~~

``parameters``
   Type: ``dict[str, Any]``

   Runtime parameters passed to the hook. These may come from configuration, command-line options or the calling workflow.

``logger``
   Type: ``logging.Logger``

   Logger that hook implementations should use for runtime messages.

``capabilities``
   Type: ``dict[type[Any], Any]``

   Available capabilities keyed by their capability type. Hooks declare required capability types via `required_capabilities` and retrieve them with `capability(...)`.


HookMetadata
------------

.. autoclass:: teksi_hooks.hook.HookMetadata
   :members:

Fields
~~~~~~

``name``
   Type: ``str``

   Human-readable hook name used in logs and diagnostics.

``description``
   Type: ``str``

   Short description of what the hook does.