Python API

libtmux.Pane.show_hooks

Python

show_hooks ( self , global_ : bool | None = False , scope : OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE ) → HookDict method [source] ¶ method [source] ¶ show_hooks

Return a dict of hooks for the target.

Parameters

global_ ( bool | None ) – Pass -g flag for global hooks, default False.
scope ( OptionScope | _DefaultOptionScope | None ) – Hook scope (Server/Session/Window/Pane), defaults to object's scope.

Returns

HookDict Dictionary mapping hook names to their values.

In other ports Read a pane's hooks

Examples

Python TypeScript

>>> session.set_hook('session-renamed[0]', 'display-message "test"')
Session($...)

>>> hooks = session.show_hooks()
>>> isinstance(hooks, dict)
True

>>> 'session-renamed[0]' in hooks
True

>>> session.unset_hook('session-renamed')
Session($...)

const hooks = await pane.showHooks();
hooks.get("pane-title-changed")?.[0];

0 declared, 0 inherited