Python API

libtmux.Window.search_panes

Python

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

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

search_panes ( self , filter : str | None = None , # noqa: A002 ) → QueryList[Pane] method [source] ¶ method [source] ¶ search_panes

Panes in this window, optionally filtered by tmux.

Like Window.panes but with a filter kwarg passed to $ tmux list-panes -t <window> -f <filter>.

Parameters

filter ( str | None ) – tmux format expression (-f flag). tmux silently expands a malformed filter (unclosed #{...}, unknown format token) to empty, which the filter treats as false — every row is suppressed and no stderr is emitted. A bad filter is indistinguishable from "filter matched nothing"; verify filter syntax against the FORMATS section of tmux(1). Warning: added 0.57

In other ports Filter a window's panes with a tmux expression

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 Window
Rust window.Window.search_panes
Go tmux.Window.SearchPanes
Java no equivalent on Window
.NET LibTmux.Window.SearchPanesAsync
C++ no equivalent on Window
Swift no equivalent on Window

Examples

Python Rust

>>> target_pane = window.split()
>>> matches = window.search_panes(
...     filter=f'#{{m:{target_pane.pane_id},#{{pane_id}}}}'
... )
>>> [p.pane_id for p in matches] == [target_pane.pane_id]
True

use libtmux::query::Filterable as _;

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("searched").await?;
let window = session.active_window().await?.expect("a window");

let fields = libtmux::Pane::filter_fields();
let found = window.search_panes(&fields.pane_active.eq(true)).await?;
assert_eq!(found.len(), 1);

guard.shutdown().await?;

0 declared, 0 inherited