types(workspace-imports) Example typings via NotRequried

Author: tony

src/tmuxp/_internal/types.py

@@ -35,3 +35,61 @@ class PluginConfigSchema(TypedDict):
     tmuxp_min_version: NotRequired[str]
     tmuxp_max_version: NotRequired[str]
     tmuxp_version_incompatible: NotRequired[list[str]]
+
+
+class ShellCommandConfig(TypedDict):
+    """Shell command configuration."""
+
+    cmd: str
+    enter: NotRequired[bool]
+    suppress_history: NotRequired[bool]
+
+
+ShellCommandValue = t.Union[str, ShellCommandConfig, list[t.Union[str, ShellCommandConfig]]]
+
+
+class PaneConfig(TypedDict, total=False):
+    """Pane configuration."""
+
+    shell_command: NotRequired[ShellCommandValue]
+    shell_command_before: NotRequired[ShellCommandValue]
+    start_directory: NotRequired[str]
+    environment: NotRequired[dict[str, str]]
+    focus: NotRequired[t.Union[str, bool]]
+    suppress_history: NotRequired[bool]
+
+
+PaneValue = t.Union[str, PaneConfig]
+
+
+class WindowConfig(TypedDict, total=False):
+    """Window configuration."""
+
+    window_name: str
+    start_directory: NotRequired[str]
+    shell_command_before: NotRequired[ShellCommandValue]
+    layout: NotRequired[str]
+    options: NotRequired[dict[str, t.Any]]
+    options_after: NotRequired[dict[str, t.Any]]
+    environment: NotRequired[dict[str, str]]
+    focus: NotRequired[t.Union[str, bool]]
+    suppress_history: NotRequired[bool]
+    panes: NotRequired[list[PaneValue]]
+
+
+class WorkspaceConfig(TypedDict, total=False):
+    """Complete tmuxp workspace configuration."""
+
+    session_name: t.Union[str, None]  # Can be None during import
+    start_directory: NotRequired[str]
+    before_script: NotRequired[str]
+    shell_command_before: NotRequired[ShellCommandValue]
+    shell_command: NotRequired[ShellCommandValue]  # Used in import
+    environment: NotRequired[dict[str, str]]
+    global_options: NotRequired[dict[str, t.Any]]
+    options: NotRequired[dict[str, t.Any]]
+    config: NotRequired[str]  # tmux config file path
+    socket_name: NotRequired[str]  # tmux socket name
+    plugins: NotRequired[list[t.Union[str, PluginConfigSchema]]]
+    suppress_history: NotRequired[bool]
+    windows: list[WindowConfig]

src/tmuxp/workspace/importers.py

@@ -4,6 +4,9 @@
 
 import typing as t
 
+if t.TYPE_CHECKING:
+    from tmuxp._internal.types import WorkspaceConfig
+
 
 def import_tmuxinator(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
     """Return tmuxp workspace from a `tmuxinator`_ yaml workspace.
@@ -18,8 +21,9 @@ def import_tmuxinator(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
     Returns
     -------
     dict
+        A dictionary conforming to WorkspaceConfig structure.
     """
-    tmuxp_workspace: dict[str, t.Any] = {}
+    tmuxp_workspace: dict[str, t.Any] = {}  # Will conform to WorkspaceConfig at the end
 
     if "project_name" in workspace_dict:
         tmuxp_workspace["session_name"] = workspace_dict.pop("project_name")
@@ -112,6 +116,11 @@ def import_teamocil(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
     workspace_dict : dict
         python dict for tmuxp workspace
 
+    Returns
+    -------
+    dict
+        A dictionary conforming to WorkspaceConfig structure.
+
     Notes
     -----
     Todos:
@@ -122,7 +131,7 @@ def import_teamocil(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
     - clear
     - cmd_separator
     """
-    tmuxp_workspace: dict[str, t.Any] = {}
+    tmuxp_workspace: dict[str, t.Any] = {}  # Will conform to WorkspaceConfig at the end
 
     if "session" in workspace_dict:
         workspace_dict = workspace_dict["session"]