Python API

libtmux.Session.set_hooks

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust
Go
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift Unavailable

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

set_hooks ( self , hook : str , values : HookValues , clear_existing : bool = False , global_ : bool | None = None , scope : OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE ) → Self method [source] ¶ method [source] ¶ set_hooks

Inherited from libtmux.hooks.HooksMixin

Set multiple indexed hooks at once.

Parameters

hook ( str ) – Hook name, e.g. 'session-renamed'
values ( HookValues ) – Values to set. Can be: - dict[int, str]: {0: 'cmd1', 1: 'cmd2'} - explicit indices - SparseArray[str]: preserves indices from another hook - list[str]: ['cmd1', 'cmd2'] - sequential indices starting at 0
clear_existing ( bool ) – If True, unset all existing hook values first
global_ ( bool | None ) – Use global hooks
scope ( OptionScope | _DefaultOptionScope | None ) – Scope for the hook

Returns

Self Returns self for method chaining.

In other ports Write a session hook and its indexed commands at once

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript no equivalent on Session
Rust session.Session.set_hooks
Go tmux.Session.SetHooks
Java no equivalent on Session
.NET no equivalent on Session
C++ no equivalent on Session
Swift no equivalent on Session

Examples

Python Rust

Set hooks with explicit indices:

>>> session.set_hooks('session-renamed', {
...     0: 'display-message "hook 0"',
...     1: 'display-message "hook 1"',
... })
Session($...)

>>> hooks = session.show_hook('session-renamed')
>>> sorted(hooks.keys())
[0, 1]

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

Set hooks from a list (sequential indices):

>>> session.set_hooks('after-new-window', [
...     'select-pane -t 0',
...     'send-keys "clear" Enter',
... ])
Session($...)

>>> hooks = session.show_hook('after-new-window')
>>> sorted(hooks.keys())
[0, 1]

Replace all existing hooks with clear_existing=True:

>>> session.set_hooks(
...     'session-renamed',
...     {0: 'display-message "new"'},
...     clear_existing=True,
... )
Session($...)

>>> hooks = session.show_hook('session-renamed')
>>> sorted(hooks.keys())
[0]

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

>>> session.unset_hook('after-new-window')
Session($...)

use std::collections::BTreeMap;
use libtmux::{IndexedHooks, ReplaceMode, TmuxText};

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

let mut entries = BTreeMap::new();
entries.insert(0, TmuxText::from(b"display-message first".to_vec()));
entries.insert(3, TmuxText::from(b"display-message fourth".to_vec()));

session
    .set_hooks("alert-bell", &IndexedHooks::from(entries), ReplaceMode::Replace)
    .await?;

let written = session.hook("alert-bell").await?.expect("the hook is set");
assert_eq!(written.len(), 2);
assert!(written.get(1).is_none(), "the gap is kept");

guard.shutdown().await?;

0 declared, 0 inherited