Core LibrarystableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

method libtmux stable

Session.search_panes

Panes in this session, optionally filtered by tmux.

Source and package
Qualified name
libtmux.Session.search_panes
Module
libtmux
Declared in
Session
Package
libtmux
Source
src/libtmux/session.py
Other languages
PowerShell Julia Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala F#
search_panes ( self, filter: str | None = None, # noqa: A002 ) → QueryList[Pane]

Description#

Like Session.panes but with a filter kwarg 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 (-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

  • # noqa: A002 #

In other ports Filter a session's panes with a tmux expression
  • PowerShell
    No source-verified PowerShell equivalent is recorded for this operation.
  • Julia
    No source-verified Julia equivalent is recorded for this operation.
  • 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
    no equivalent on Session
  • Go
  • Java
    no equivalent on Session
  • C#
  • C++
    no equivalent on Session
  • Swift
    no equivalent on Session
  • Kotlin
    No source-verified Kotlin equivalent is recorded for this operation.
  • Scala
    No source-verified Scala equivalent is recorded for this operation.
  • F#
    No source-verified F# equivalent is recorded for this operation.
Esc

Type to search.

Reference preview Open reference