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

property libtmux stable

Client.attached_session

Return the Session this client is currently attached to.

Source and package
Qualified name
libtmux.Client.attached_session
Module
libtmux
Declared in
Client
Package
libtmux
Source
src/libtmux/client.py
attached_session (self) → Session | None

Description#

Re-reads the client from list-clients before resolving, so the returned Session reflects the client's live attachment rather than the snapshot captured when this Client was read. Returns None when tmux no longer reports this client_name through list-clients, when the client is not attached to any session, or when the snapshot session_id no longer names a live session.

Examples#

>>> with control_mode() as ctl:
... client = server.clients.get(client_name=ctl.client_name)
... attached = client.attached_session
>>> attached is not None
True
Esc

Type to search.

Reference preview Open reference