types(workspace-imports) Example typings via NotRequried

Author: tony

src/tmuxp/_internal/types.py

@@ -35,3 +35,63 @@ 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[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[str | bool]
+    suppress_history: NotRequired[bool]
+    panes: NotRequired[list[PaneValue]]
+
+
+class WorkspaceConfig(TypedDict, total=False):
+    """Complete tmuxp workspace configuration."""
+
+    session_name: 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[str | PluginConfigSchema]]
+    suppress_history: NotRequired[bool]
+    windows: list[WindowConfig]

src/tmuxp/workspace/importers.py

@@ -4,8 +4,11 @@
 
 import typing as t
 
+if t.TYPE_CHECKING:
+    from tmuxp._internal.types import WindowConfig, WorkspaceConfig
 
-def import_tmuxinator(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
+
+def import_tmuxinator(workspace_dict: dict[str, t.Any]) -> WorkspaceConfig:
     """Return tmuxp workspace from a `tmuxinator`_ yaml workspace.
 
     .. _tmuxinator: https://github.com/aziz/tmuxinator
@@ -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: WorkspaceConfig = {"windows": []}  # type: ignore[typeddict-item]
 
     if "project_name" in workspace_dict:
         tmuxp_workspace["session_name"] = workspace_dict.pop("project_name")
@@ -51,7 +55,6 @@ def import_tmuxinator(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
     if "socket_name" in workspace_dict:
         tmuxp_workspace["socket_name"] = workspace_dict["socket_name"]
 
-    tmuxp_workspace["windows"] = []
 
     if "tabs" in workspace_dict:
         workspace_dict["windows"] = workspace_dict.pop("tabs")
@@ -76,33 +79,33 @@ def import_tmuxinator(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
             "rbenv shell {}".format(workspace_dict["rbenv"]),
         )
 
-    for window_dict in workspace_dict["windows"]:
-        for k, v in window_dict.items():
-            window_dict = {"window_name": k}
+    for window_item in workspace_dict["windows"]:
+        for k, v in window_item.items():
+            new_window: WindowConfig = {"window_name": k}
 
             if isinstance(v, str) or v is None:
-                window_dict["panes"] = [v]
-                tmuxp_workspace["windows"].append(window_dict)
+                new_window["panes"] = [v]
+                tmuxp_workspace["windows"].append(new_window)
                 continue
             if isinstance(v, list):
-                window_dict["panes"] = v
-                tmuxp_workspace["windows"].append(window_dict)
+                new_window["panes"] = v
+                tmuxp_workspace["windows"].append(new_window)
                 continue
 
             if "pre" in v:
-                window_dict["shell_command_before"] = v["pre"]
+                new_window["shell_command_before"] = v["pre"]
             if "panes" in v:
-                window_dict["panes"] = v["panes"]
+                new_window["panes"] = v["panes"]
             if "root" in v:
-                window_dict["start_directory"] = v["root"]
+                new_window["start_directory"] = v["root"]
 
             if "layout" in v:
-                window_dict["layout"] = v["layout"]
-            tmuxp_workspace["windows"].append(window_dict)
+                new_window["layout"] = v["layout"]
+            tmuxp_workspace["windows"].append(new_window)
     return tmuxp_workspace
 
 
-def import_teamocil(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
+def import_teamocil(workspace_dict: dict[str, t.Any]) -> WorkspaceConfig:
     """Return tmuxp workspace from a `teamocil`_ yaml workspace.
 
     .. _teamocil: https://github.com/remiprev/teamocil
@@ -112,6 +115,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 +130,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: WorkspaceConfig = {"windows": []}  # type: ignore[typeddict-item]
 
     if "session" in workspace_dict:
         workspace_dict = workspace_dict["session"]
@@ -132,21 +140,20 @@ def import_teamocil(workspace_dict: dict[str, t.Any]) -> dict[str, t.Any]:
     if "root" in workspace_dict:
         tmuxp_workspace["start_directory"] = workspace_dict.pop("root")
 
-    tmuxp_workspace["windows"] = []
 
     for w in workspace_dict["windows"]:
-        window_dict = {"window_name": w["name"]}
+        window_dict: WindowConfig = {"window_name": w["name"]}
 
         if "clear" in w:
-            window_dict["clear"] = w["clear"]
+            # TODO: handle clear attribute
+            pass
 
         if "filters" in w:
             if "before" in w["filters"]:
-                for _b in w["filters"]["before"]:
-                    window_dict["shell_command_before"] = w["filters"]["before"]
+                window_dict["shell_command_before"] = w["filters"]["before"]
             if "after" in w["filters"]:
-                for _b in w["filters"]["after"]:
-                    window_dict["shell_command_after"] = w["filters"]["after"]
+                # TODO: handle shell_command_after
+                pass
 
         if "root" in w:
             window_dict["start_directory"] = w.pop("root")