Workspace ManagerstableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

tmuxp.workspace.options.WorkspaceBuilderOptions.from_config

tmuxp.workspace.options.WorkspaceBuilderOptions.from_config ( cls, session_config: dict[str, t.Any] ) → WorkspaceBuilderOptions

Build options from a full workspace session_config dict.

Description#

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
Returns

WorkspaceBuilderOptions

Esc

Type to search.

Reference preview Open reference