Server(feat[new_session]): Add StrPath type support for start_directory

tony · tony · commit 7998363d793f · 2025-05-26T06:32:37.000-05:00
why: Standardize path handling to accept both str and PathLike objects

what:
- Import StrPath from libtmux._internal.types
- Update start_directory parameter type annotation to StrPath | None
- Update docstring to reflect str or PathLike support
- Maintain existing if start_directory: logic for proper command building
diff --git a/src/libtmux/server.py b/src/libtmux/server.py
@@ -15,14 +15,15 @@
 import typing as t
 import warnings
 
+from libtmux import exc, formats
 from libtmux._internal.query_list import QueryList
+from libtmux._internal.types import StrPath
 from libtmux.common import tmux_cmd
 from libtmux.neo import fetch_objs
 from libtmux.pane import Pane
 from libtmux.session import Session
 from libtmux.window import Window
 
-from . import exc, formats
 from .common import (
     EnvironmentMixin,
     PaneDict,
@@ -431,7 +432,7 @@ def new_session(
         session_name: str | None = None,
         kill_session: bool = False,
         attach: bool = False,
-        start_directory: str | None = None,
+        start_directory: StrPath | None = None,
         window_name: str | None = None,
         window_command: str | None = None,
         x: int | DashLiteral | None = None,
@@ -466,7 +467,7 @@ def new_session(
         kill_session : bool, optional
             Kill current session if ``$ tmux has-session``.
             Useful for testing workspaces.
-        start_directory : str, optional
+        start_directory : str or PathLike, optional
             specifies the working directory in which the
             new session is created.
         window_name : str, optional
@@ -542,7 +543,9 @@ def new_session(
             tmux_args += ("-d",)
 
         if start_directory:
-            tmux_args += ("-c", start_directory)
+            # as of 2014-02-08 tmux 1.9-dev doesn't expand ~ in new-session -c.
+            start_directory = pathlib.Path(start_directory).expanduser()
+            tmux_args += ("-c", str(start_directory))
 
         if window_name:
             tmux_args += ("-n", window_name)
