On this page

libtmux.Session.search_panes

Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/session.py

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

Panes in this session, optionally filtered by tmux.

Like Session.panes but with a filter kwarg passed to $ tmux list-panes -s -t <session> -f <filter>.

Examples

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

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

0 declared, 0 inherited