On this page

libtmux.Server.search_sessions

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

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

Sessions, optionally filtered by tmux before rows are returned.

Like Server.sessions but adds an optional filter kwarg passed to $ tmux list-sessions -f <filter>.

Examples

>>> server.new_session(session_name='gap7_alpha')
Session($... gap7_alpha)
>>> server.new_session(session_name='other_beta')
Session($... other_beta)
>>> matches = server.search_sessions(filter='#{m:gap7_*,#{session_name}}')
>>> [s.session_name for s in matches]
['gap7_alpha']

Parameters

filter ( str | None ) – tmux format expression (-f flag). tmux omits sessions whose expanded expression is false before libtmux builds objects. 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

Returns

QueryList of Session

0 declared, 0 inherited