Python API

libtmux.Session.search_windows

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust
Go
Java Unavailable
.NET
C++ Unavailable
Swift Unavailable

Module: libtmux
Declared in: Session
Package: libtmux
Source: src/libtmux/session.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++ Swift

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>.

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

In other ports Filter a session's windows with a tmux expression

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript no equivalent on Session
Rust session.Session.search_windows
Go tmux.Session.SearchWindows
Java no equivalent on Session
.NET LibTmux.Session.SearchWindowsAsync
C++ no equivalent on Session
Swift no equivalent on Session

Examples

Python Rust

>>> _ = 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']

use libtmux::query::Filterable as _;

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("searched").await?;
session.new_window("build").await?;

let fields = libtmux::Window::filter_fields();
let found = session.search_windows(&fields.window_name.eq("build")).await?;
assert_eq!(found.len(), 1);

guard.shutdown().await?;

0 declared, 0 inherited