Python API

libtmux.Session.show_hooks

Python

Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/hooks.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++Swift

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

Inherited from libtmux.hooks.HooksMixin

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 session's hooks

Ruby LibTmux::Session#hooks
Lua libtmux.Session:list_hooks
TypeScript session.Session.showHooks
Rust session.Session.hooks
Go tmux.Session.Hooks
Java io.github.libtmux.Session.Session.hooks
.NET LibTmux.Session.Hooks
C++ libtmux::Session::hooks
Swift Server.hooks(_:)

Examples

Python TypeScript Rust

>>> 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 session.showHooks();
hooks.get("window-linked")?.[0];

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("hooked").await?;

session.set_hook("alert-bell", "display-message rang").await?;
let hooks = session.hooks().await?;
assert!(hooks.contains_key("alert-bell"));

guard.shutdown().await?;

0 declared, 0 inherited