tmuxp.workspace.options.WorkspaceBuilderOptions.from_config

Python

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

tmuxp.workspace.options.WorkspaceBuilderOptions.from_config ( cls , session_config : dict[str, t.Any] ) → WorkspaceBuilderOptions methodclassmethod [source] ¶ methodclassmethod [source] ¶ tmuxp.workspace.options.WorkspaceBuilderOptions.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