libtmux.Session.show_hook
Python
- Python
- Ruby Unavailable
- Lua Unavailable
- TypeScript Unavailable
- Rust Unavailable
- Go Unavailable
- Java Unavailable
- .NET Unavailable
- C++ Unavailable
- Swift Unavailable
- Module
- libtmux
- Declared in
- Session
- Package
- libtmux
- Source
- src/libtmux/hooks.py
- show_hook ( self , hook : str , global_ : bool = False , scope : OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE ) str | int | SparseArray[str] | None
-
Inherited from
libtmux.hooks.HooksMixinReturn value for a hook.
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
-
-
hook ( str ) – Hook name to query
-
- Returns
-
str | int | SparseArray[str] | None Hook value. For array hooks, returns SparseArray.
- Raises
0 declared, 0 inherited