tmuxp.workspace.options.PaneReadiness.from_config

API reference · Markdown

tmuxp.workspace.options.PaneReadiness.from_config ( cls , value : t.Any ) → PaneReadiness

methodclassmethod [source] ¶

methodclassmethod [source] ¶

tmuxp.workspace.options.PaneReadiness.from_config

Parse a pane_readiness config value into a policy.

Accepts the canonical auto / always / never strings, plus the truthy/falsy aliases users expect from boolean-like config keys.

Examples

>>> PaneReadiness.from_config(None) is PaneReadiness.AUTO
True
>>> PaneReadiness.from_config("auto") is PaneReadiness.AUTO
True
>>> PaneReadiness.from_config(True) is PaneReadiness.ALWAYS
True
>>> PaneReadiness.from_config("on") is PaneReadiness.ALWAYS
True
>>> PaneReadiness.from_config(1) is PaneReadiness.ALWAYS
True
>>> PaneReadiness.from_config(False) is PaneReadiness.NEVER
True
>>> PaneReadiness.from_config("never") is PaneReadiness.NEVER
True

Unknown 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

Parameters

• value ( t.Any ) – value from workspace_builder_options.pane_readiness; None (key absent) resolves to AUTO

Returns

PaneReadiness