Python API

method libtmux latest

Session.show_hooks

Return a dict of hooks for the target.

Source and package

Qualified name: libtmux.Session.show_hooks
Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/hooks.py
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp RubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala OCamlfunction F# Clojure

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

Examples#

>>> 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($...)

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.

The tmux commands behind show_hooks.

The C declarations in tmux that implement these commands.

Events that run tmux commands, with the scope each hook belongs to and where tmux fires it.

Read a session's hooks

Equivalents of Read a session's hooks in other languages
Language	Equivalent
Ruby	`LibTmux::Session#hooks`
Lua	`libtmux.Session:list_hooks`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.showHooks`
Rust	`session.Session.hooks`
Go	`tmux.Session.Hooks`
Java	`io.github.libtmux.Session.hooks`
C#	`LibTmux.Session.Hooks`
C++	`libtmux::Session::hooks`
Swift	`Server.hooks(_:)`
OCaml	`Libtmux_unix.Client.capture_hooks` Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl	`LibTmux::Server::show_hooks` Use an explicit session target ID; raw bytes preserve sparse hook indexes and tmux quoting.

No equivalent is recorded in PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.