tmuxp.workspace.options.PaneReadiness
- Bases:
Policy for whether the builder waits for a pane's shell prompt.
Description#
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 defaultAUTOpolicy waits only when the session's interactive shell is zsh.
Members
- from_config (cls, value: t
.Any ) PaneReadiness -
Parse a
pane_readinessconfig value into a policy.Description#
Accepts the canonical
auto/always/neverstrings, plus the truthy/falsy aliases users expect from boolean-like config keys.Examples#
>>> PaneReadiness.from_config(None) is PaneReadiness.AUTOTrue>>> PaneReadiness.from_config("auto") is PaneReadiness.AUTOTrue>>> PaneReadiness.from_config(True) is PaneReadiness.ALWAYSTrue>>> PaneReadiness.from_config("on") is PaneReadiness.ALWAYSTrue>>> PaneReadiness.from_config(1) is PaneReadiness.ALWAYSTrue>>> PaneReadiness.from_config(False) is PaneReadiness.NEVERTrue>>> PaneReadiness.from_config("never") is PaneReadiness.NEVERTrueUnknown 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