On this page

libtmux.Server.search_windows

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

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

All windows across sessions, optionally filtered by tmux.

Like Server.windows but with a filter kwarg passed to $ tmux list-windows -a -f <filter>.

Examples

>>> sess = server.new_session(session_name='gap7_win_demo')
>>> _ = sess.new_window(window_name='gap7_target')
>>> _ = sess.new_window(window_name='other_window')
>>> matches = server.search_windows(filter='#{m:gap7_*,#{window_name}}')
>>> any(w.window_name == 'gap7_target' for w in matches)
True
>>> any(w.window_name == 'other_window' for w in matches)
False

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