`tmuxp.workspace.builder.resolve_builder_class`

tmuxp.workspace.builder.resolve_builder_class ( session_config: dict[str, t.Any], ) → type[WorkspaceBuilderProtocol] function [source] ¶

Resolve the workspace builder class selected by session_config.

Description#

Resolution of the workspace_builder value:

absent/empty → the classic ClassicWorkspaceBuilder (no import, no entry-point scan);
contains : → a module:attr object reference;
no . and no : → an entry-point name in the tmuxp.workspace_builders group;
dotted, no : → an entry-point name if registered, otherwise a module.attr dotted path.

Examples#

The default resolves to the classic builder without importing anything:

>>> from tmuxp.workspace.builder.classic import ClassicWorkspaceBuilder
>>> resolve_builder_class({}) is ClassicWorkspaceBuilder
True

A dotted module:attr reference is imported and validated:

>>> resolve_builder_class(
...     {
...         "workspace_builder": (
...             "tmuxp.workspace.builder.classic:ClassicWorkspaceBuilder"
...         )
...     }
... ) is ClassicWorkspaceBuilder
True

Parameters

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

Returns

type a workspace builder class (or builder factory) satisfying WorkspaceBuilderProtocol

Scripting & web

Compiled & native

JVM

.NET

tmux

`tmuxp.workspace.builder.resolve_builder_class`

Description#

Examples#