tmuxp.workspace.options.WorkspaceBuilderOptions

Python

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

class tmuxp.workspace.options.WorkspaceBuilderOptions class [source] ¶ class [source] ¶ class tmuxp.workspace.options.WorkspaceBuilderOptions: Parsed workspace_builder_options catalog.

An absent workspace_builder_options catalog uses the defaults, whose PaneReadiness.AUTO policy waits for a pane's prompt only when the session shell is zsh: zsh workspaces build as before, while bash, sh, and other shells skip the wait. Set pane_readiness: always to restore the previous wait-everywhere behavior.

Members

pane_readiness

pane_readiness : PaneReadiness = PaneReadiness.AUTO attribute [source] ¶ attribute [source] ¶ pane_readiness: pane-prompt wait policy; defaults to PaneReadiness.AUTO

from_config

from_config ( cls , session_config : dict[str, t.Any] ) → WorkspaceBuilderOptions methodclassmethod [source] ¶ methodclassmethod [source] ¶ from_config

Build options from a full workspace session_config dict.

Reads the optional workspace_builder_options catalog; an absent or empty catalog yields the defaults (see the class docstring for how the default PaneReadiness.AUTO policy affects non-zsh shells).

Examples

>>> WorkspaceBuilderOptions.from_config({}).pane_readiness
<PaneReadiness.AUTO: 'auto'>

>>> cfg = {"workspace_builder_options": {"pane_readiness": "always"}}
>>> WorkspaceBuilderOptions.from_config(cfg).pane_readiness
<PaneReadiness.ALWAYS: 'always'>

Parameters

session_config ( dict[str, t.Any] ) – the expanded workspace configuration

Returns

WorkspaceBuilderOptions