Python API

method libtmux stable

Pane._refresh

Refresh dataclass fields from a single list-* row.

Source and package

Qualified name: libtmux.Pane._refresh
Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/neo.py

_refresh ( self, obj_key: str, obj_id: str, list_cmd: ListCmd = "list-panes", list_extra_args: ListExtraArgs = None, ) → None method [source] ¶

Inherited from libtmux.neo.Obj

Description#

Used by the public refresh() methods on Pane , Window , Session , and Client . Each subclass guards its identity field (pane_id, window_id, session_id, client_name) against None before delegating here; this base method enforces the same precondition explicitly so the guarantee survives python -O, where an assert would be stripped.

Parameters

obj_key (str) #
obj_id (str) #
list_cmd (ListCmd) #
list_extra_args (ListExtraArgs) #

Raises

ValueError – When obj_id is None. Surfaces a clear error under python -O, matching the contract of the public refresh() methods.

Scripting & web

Compiled & native

JVM

.NET

tmux

Pane._refresh

Description#

Description#

Related types#