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

Server.search_sessions

Sessions, optionally filtered by tmux before rows are returned.

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

Description#

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

  • # noqa: A002 #

Returns

QueryList of Session

Discussed in Filtering and queries

In other ports Filter the sessions 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
  • TypeScript
    no equivalent on Server
  • Rust
    no equivalent on Server
  • Go
  • Java
    no equivalent on Server
  • C#
  • C++
    no equivalent on Server
  • Swift
    no equivalent on Server
  • 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