On this page

libtmux.Session.search_windows

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

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

Windows in this session, optionally filtered by tmux.

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

Examples

>>> _ = session.new_window(window_name='gap7s_target')
>>> _ = session.new_window(window_name='other_window')
>>> matches = session.search_windows(filter='#{m:gap7s_*,#{window_name}}')
>>> [w.window_name for w in matches]
['gap7s_target']

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