tmuxp.workspace.options.WorkspaceBuilderOptions
-
Parsed
workspace_builder_optionscatalog.Description#
An absent
workspace_builder_optionscatalog uses the defaults, whosePaneReadiness.AUTOpolicy 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. Setpane_readiness: alwaysto restore the previous wait-everywhere behavior.
Members
- pane_readiness : Pane
Readiness = PaneReadiness.AUTO -
pane-prompt wait policy; defaults to
PaneReadiness.AUTO
- from_config ( cls, session_config: dict[str, t
.Any ] ) WorkspaceBuilder Options -
Build options from a full workspace
session_configdict.Description#
Reads the optional
workspace_builder_optionscatalog; an absent or empty catalog yields the defaults (see the class docstring for how the defaultPaneReadiness.AUTOpolicy 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