tmuxp.workspace.options.PaneReadiness

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust Unavailable
Go Unavailable
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift Unavailable

class tmuxp.workspace.options.PaneReadiness class [source] ¶ class [source] ¶ class tmuxp.workspace.options.PaneReadiness

Bases:

enum.Enum

Policy for whether the builder waits for a pane's shell prompt.

tmuxp waits for each default-shell pane to draw its prompt before dispatching layout and commands, which avoids a zsh prompt-redraw artifact (see tmuxp.workspace.builder.classic._wait_for_pane_ready). The wait is only needed for zsh, so the default AUTO policy waits only when the session's interactive shell is zsh.

Members

AUTO

AUTO = "auto" attribute [source] ¶ attribute [source] ¶ AUTO

ALWAYS

ALWAYS = "always" attribute [source] ¶ attribute [source] ¶ ALWAYS

NEVER

NEVER = "never" attribute [source] ¶ attribute [source] ¶ NEVER

from_config

from_config ( cls , value : t.Any ) → PaneReadiness methodclassmethod [source] ¶ methodclassmethod [source] ¶ from_config

Parse a pane_readiness config value into a policy.

Accepts the canonical auto / always / never strings, plus the truthy/falsy aliases users expect from boolean-like config keys.

Examples

>>> PaneReadiness.from_config(None) is PaneReadiness.AUTO
True
>>> PaneReadiness.from_config("auto") is PaneReadiness.AUTO
True
>>> PaneReadiness.from_config(True) is PaneReadiness.ALWAYS
True
>>> PaneReadiness.from_config("on") is PaneReadiness.ALWAYS
True
>>> PaneReadiness.from_config(1) is PaneReadiness.ALWAYS
True
>>> PaneReadiness.from_config(False) is PaneReadiness.NEVER
True
>>> PaneReadiness.from_config("never") is PaneReadiness.NEVER
True

Unknown values raise an actionable error:

>>> PaneReadiness.from_config("sometimes")
Traceback (most recent call last):
...
ValueError: invalid pane_readiness value: 'sometimes'; expected one of:
auto, always/true/on/yes/1, never/false/off/no/0

Parameters

value ( t.Any ) – value from workspace_builder_options.pane_readiness; None (key absent) resolves to AUTO

Returns

PaneReadiness