On this page

libtmux.Server.search_panes

Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py

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

All panes across the server, optionally filtered by tmux.

Like Server.panes but with a filter kwarg passed to $ tmux list-panes -a -f <filter>. tmux drops non-matching panes before libtmux builds objects.

Examples

>>> sess = server.new_session(session_name='gap7_pane_demo')
>>> window = sess.active_window
>>> target_pane = window.split()
>>> matches = server.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). Example: '#{m:%5,#{pane_id}}' (id match) or '#{C/i:libtmux,#{pane_current_command}}' (case-insensitive substring on the current command). 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