Session.search_panes
Panes in this session, optionally filtered by tmux.
Source and package
-
Description#
Like
Session.panesbut with afilterkwarg passed to$ tmux list-panes -s -t <session> -f <filter>.Examples#
>>> target_pane = session.active_window.split()>>> matches = session.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 (-fflag). 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 oftmux(1). Warning: added 0.57
-
tmux command#
The tmux commands behind search_panes.
list-panes -s session scope, cmd_list_panes_session tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Filter a session's panes with a tmux expression
| Language | Equivalent |
|---|---|
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | no equivalent on Session |
| Rust | no equivalent on Session |
| Go | tmux |
| Java | no equivalent on Session |
| C# | Lib |
| C++ | no equivalent on Session |
| Swift | no equivalent on Session |
| OCaml | No direct public OCaml equivalent is recorded for this operation. |
| Perl | No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands. |
No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.