Session.show_hook
Return value for a hook.
Source and package
- Qualified name
-
libtmux.Session. show _hook - Module
- libtmux
- Declared in
Session- Package
- libtmux
- Source
- src/libtmux/hooks.py
-
Inherited from
libtmux.hooks.HooksMixinDescription#
For array hooks (e.g.,
session-renamed), returns aSparseArraywith hook values at their original indices. Use.keys()for indices and.values()for values.Examples#
>>> session.set_hook('session-renamed[0]', 'display-message "test"')Session($...)>>> hooks = session.show_hook('session-renamed')>>> isinstance(hooks, SparseArray)True>>> sorted(hooks.keys())[0]>>> session.unset_hook('session-renamed')Session($...)- Parameters
- Returns
-
str | int | SparseArray[str] | None Hook value. For array hooks, returns SparseArray.
- Raises
tmux command#
The tmux commands behind show_hook.
tmux C API#
The C declarations in tmux that implement these commands.