Python workspace builder behavior
tmuxp 1.74.0 · Source
The CLI separates configuration processing, construction, and attachment. These Python implementation interfaces have no stability guarantee.
Expand before buildingLink to section
The loader reads YAML or JSON, expands command shorthand, variables, and paths, then applies inherited defaults. The builder expects the expanded configuration. The internal example shows this sequence with an isolated libtmux server.
Select a builderLink to section
ClassicWorkspaceBuilder is the default builder. workspace_builder selects
an importable class or a registered entry point; workspace_builder_paths
adds explicitly configured import directories. Plugins and custom builders
run inside the Python process. Those extension imports are not portable
workspace data for the other language ports.
The classic builder accepts an optional existing session and an append choice. Failure handling depends on the operation and CLI path; a workspace build does not have universal transactional rollback. The CLI owns its existing-session prompts and the attachment or client-switching workflow.
See the upstream custom builder guide for extension configuration and the API for interface contracts.