refactor: Basic typings and namespaces

Author: tony

conftest.py

@@ -25,7 +25,7 @@
 
 @pytest.mark.skipif(USING_ZSH, reason="Using ZSH")
 @pytest.fixture(autouse=USING_ZSH, scope="session")
-def zshrc(user_path: pathlib.Path):
+def zshrc(user_path: pathlib.Path) -> pathlib.Path:
     """This quiets ZSH default message.
 
     Needs a startup file .zshenv, .zprofile, .zshrc, .zlogin.
@@ -41,7 +41,7 @@ def home_path_default(monkeypatch: pytest.MonkeyPatch, user_path: pathlib.Path)
 
 
 @pytest.fixture(scope="function")
-def monkeypatch_plugin_test_packages(monkeypatch):
+def monkeypatch_plugin_test_packages(monkeypatch: pytest.MonkeyPatch) -> None:
     paths = [
         "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bwb/",
         "tests/fixtures/pluginsystem/plugins/tmuxp_test_plugin_bs/",
@@ -55,7 +55,7 @@ def monkeypatch_plugin_test_packages(monkeypatch):
 
 
 @pytest.fixture(scope="function")
-def socket_name(request) -> str:
+def socket_name(request: pytest.FixtureRequest) -> str:
     return "tmuxp_test%s" % next(namer)
 
 

src/tmuxp/cli/__init__.py

@@ -7,7 +7,9 @@
 import argparse
 import logging
 import os
+import pathlib
 import sys
+import typing as t
 
 from libtmux.__about__ import __version__ as libtmux_version
 from libtmux.common import has_minimum_version
@@ -19,19 +21,28 @@
 from .convert import command_convert, create_convert_subparser
 from .debug_info import command_debug_info, create_debug_info_subparser
 from .edit import command_edit, create_edit_subparser
-from .freeze import command_freeze, create_freeze_subparser
+from .freeze import CLIFreezeNamespace, command_freeze, create_freeze_subparser
 from .import_config import (
     command_import_teamocil,
     command_import_tmuxinator,
     create_import_subparser,
 )
-from .load import command_load, create_load_subparser
+from .load import CLILoadNamespace, command_load, create_load_subparser
 from .ls import command_ls, create_ls_subparser
-from .shell import command_shell, create_shell_subparser
+from .shell import CLIShellNamespace, command_shell, create_shell_subparser
 from .utils import tmuxp_echo
 
 logger = logging.getLogger(__name__)
 
+if t.TYPE_CHECKING:
+    from typing_extensions import Literal, TypeAlias
+
+    CLIVerbosity: TypeAlias = Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
+    CLISubparserName: TypeAlias = Literal[
+        "ls", "load", "convert", "edit", "import", "shell", "debug-info"
+    ]
+    CLIImportSubparserName: TypeAlias = Literal["teamocil", "tmuxinator"]
+
 
 def create_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(prog="tmuxp")
@@ -83,7 +94,17 @@ def create_parser() -> argparse.ArgumentParser:
     return parser
 
 
-def cli(args=None):
+class CLINamespace(argparse.Namespace):
+    log_level: "CLIVerbosity"
+    subparser_name: "CLISubparserName"
+    import_subparser_name: t.Optional["CLIImportSubparserName"]
+    version: bool
+
+
+ns = CLINamespace()
+
+
+def cli(_args: t.Optional[t.List[str]] = None) -> None:
     """Manage tmux sessions.
 
     Pass the "--help" argument to any command to see detailed help.
@@ -96,11 +117,11 @@ def cli(args=None):
         tmuxp_echo("tmux not found. tmuxp requires you install tmux first.")
         sys.exit()
     except exc.TmuxpException as e:
-        tmuxp_echo(e, err=True)
+        tmuxp_echo(str(e))
         sys.exit()
 
     parser = create_parser()
-    args = parser.parse_args(args)
+    args = parser.parse_args(_args, namespace=ns)
 
     setup_logger(logger=logger, level=args.log_level.upper())
 
@@ -109,28 +130,12 @@ def cli(args=None):
         return
     elif args.subparser_name == "load":
         command_load(
-            config_file=args.config_file,
-            socket_name=args.socket_name,
-            socket_path=args.socket_path,
-            tmux_config_file=args.tmux_config_file,
-            new_session_name=args.new_session_name,
-            answer_yes=args.answer_yes,
-            detached=args.detached,
-            append=args.append,
-            colors=args.colors,
-            log_file=args.log_file,
+            args=CLILoadNamespace(**vars(args)),
             parser=parser,
         )
     elif args.subparser_name == "shell":
         command_shell(
-            session_name=args.session_name,
-            window_name=args.window_name,
-            socket_name=args.socket_name,
-            socket_path=args.socket_path,
-            command=args.command,
-            shell=args.shell,
-            use_pythonrc=args.use_pythonrc,
-            use_vi_mode=args.use_vi_mode,
+            args=CLIShellNamespace(**vars(args)),
             parser=parser,
         )
     elif args.subparser_name == "import":
@@ -164,21 +169,14 @@ def cli(args=None):
         )
     elif args.subparser_name == "freeze":
         command_freeze(
-            session_name=args.session_name,
-            socket_name=args.socket_name,
-            socket_path=args.socket_path,
-            config_format=args.config_format,
-            save_to=args.save_to,
-            answer_yes=args.answer_yes,
-            quiet=args.quiet,
-            force=args.force,
+            args=CLIFreezeNamespace(**vars(args)),
             parser=parser,
         )
     elif args.subparser_name == "ls":
         command_ls(parser=parser)
 
 
-def startup(config_dir):
+def startup(config_dir: pathlib.Path) -> None:
     """
     Initialize CLI.
 

src/tmuxp/cli/convert.py

@@ -31,7 +31,7 @@ def command_convert(
     config_file: t.Union[str, pathlib.Path],
     answer_yes: bool,
     parser: t.Optional[argparse.ArgumentParser] = None,
-):
+) -> None:
     """Convert a tmuxp config between JSON and YAML."""
     config_file = scan_config(config_file, config_dir=get_config_dir())
 

src/tmuxp/cli/debug_info.py

@@ -25,7 +25,7 @@ def create_debug_info_subparser(
 
 def command_debug_info(
     parser: t.Optional[argparse.ArgumentParser] = None,
-):
+) -> None:
     """
     Print debug info to submit with Issues.
     """

src/tmuxp/cli/edit.py

@@ -12,8 +12,9 @@ def create_edit_subparser(
 ) -> argparse.ArgumentParser:
     parser.add_argument(
         dest="config_file",
+        metavar="config-file",
         type=str,
-        help="checks current tmuxp and current directory for yaml files.",
+        help="checks current tmuxp and current directory for config files.",
     )
     return parser
 

src/tmuxp/cli/freeze.py

@@ -10,12 +10,28 @@
 
 from .. import config, util
 from ..workspacebuilder import freeze
-from .utils import _validate_choices, get_config_dir, prompt, prompt_yes_no
+from .utils import get_config_dir, prompt, prompt_choices, prompt_yes_no
+
+if t.TYPE_CHECKING:
+    from typing_extensions import Literal, TypeAlias, TypeGuard
+
+    CLIOutputFormatLiteral: TypeAlias = Literal["yaml", "json"]
+
+
+class CLIFreezeNamespace(argparse.Namespace):
+    session_name: str
+    socket_name: t.Optional[str]
+    socket_path: t.Optional[str]
+    config_format: t.Optional["CLIOutputFormatLiteral"]
+    save_to: t.Optional[str]
+    answer_yes: t.Optional[bool]
+    quiet: t.Optional[bool]
+    force: t.Optional[bool]
 
 
 def session_completion(ctx, params, incomplete):
-    t = Server()
-    choices = [session.name for session in t.list_sessions()]
+    server = Server()
+    choices = [session.name for session in server.list_sessions()]
     return sorted(str(c) for c in choices if str(c).startswith(incomplete))
 
 
@@ -69,28 +85,20 @@ def create_freeze_subparser(
 
 
 def command_freeze(
-    session_name: t.Optional[str] = None,
-    socket_name: t.Optional[str] = None,
-    config_format: t.Optional[str] = None,
-    save_to: t.Optional[str] = None,
-    socket_path: t.Optional[str] = None,
-    answer_yes: t.Optional[bool] = None,
-    quiet: t.Optional[bool] = None,
-    force: t.Optional[bool] = None,
+    args: CLIFreezeNamespace,
     parser: t.Optional[argparse.ArgumentParser] = None,
 ) -> None:
     """Snapshot a session into a config.
 
     If SESSION_NAME is provided, snapshot that session. Otherwise, use the
     current session."""
-
-    t = Server(socket_name=socket_name, socket_path=socket_path)
+    server = Server(socket_name=args.socket_name, socket_path=args.socket_path)
 
     try:
-        if session_name:
-            session = t.find_where({"session_name": session_name})
+        if args.session_name:
+            session = server.find_where({"session_name": args.session_name})
         else:
-            session = util.get_session(t)
+            session = util.get_session(server)
 
         if not session:
             raise TmuxpException("Session not found.")
@@ -102,54 +110,67 @@ def command_freeze(
     newconfig = config.inline(sconf)
     configparser = ConfigReader(newconfig)
 
-    if not quiet:
+    if not args.quiet:
         print(
             "---------------------------------------------------------------"
             "\n"
             "Freeze does its best to snapshot live tmux sessions.\n"
         )
     if not (
-        answer_yes
+        args.answer_yes
         or prompt_yes_no(
             "The new config *WILL* require adjusting afterwards. Save config?"
         )
     ):
-        if not quiet:
+        if not args.quiet:
             print(
                 "tmuxp has examples in JSON and YAML format at "
                 "<http://tmuxp.git-pull.com/examples.html>\n"
                 "View tmuxp docs at <http://tmuxp.git-pull.com/>."
             )
         sys.exit()
 
-    dest = save_to
+    dest = args.save_to
     while not dest:
         save_to = os.path.abspath(
             os.path.join(
                 get_config_dir(),
-                "{}.{}".format(sconf.get("session_name"), config_format or "yaml"),
+                "{}.{}".format(sconf.get("session_name"), args.config_format or "yaml"),
             )
         )
         dest_prompt = prompt(
             "Save to: %s" % save_to,
             default=save_to,
         )
-        if not force and os.path.exists(dest_prompt):
+        if not args.force and os.path.exists(dest_prompt):
             print("%s exists. Pick a new filename." % dest_prompt)
             continue
 
         dest = dest_prompt
     dest = os.path.abspath(os.path.relpath(os.path.expanduser(dest)))
+    config_format = args.config_format
+
+    valid_config_formats: t.List["CLIOutputFormatLiteral"] = ["json", "yaml"]
+
+    def is_valid_ext(stem: t.Optional[str]) -> "TypeGuard[CLIOutputFormatLiteral]":
+        return stem in valid_config_formats
+
+    if not is_valid_ext(config_format):
+
+        def extract_config_format(val: str) -> t.Optional["CLIOutputFormatLiteral"]:
+            suffix = pathlib.Path(val).suffix
+            if isinstance(suffix, str):
+                suffix = suffix.lower().lstrip(".")
+                if is_valid_ext(suffix):
+                    return suffix
+            return None
 
-    if config_format is None or config_format == "":
-        valid_config_formats = ["json", "yaml"]
-        _, config_format = os.path.splitext(dest)
-        config_format = config_format[1:].lower()
-        if config_format not in valid_config_formats:
-            config_format = prompt(
+        config_format = extract_config_format(dest)
+        if not is_valid_ext(config_format):
+            config_format = prompt_choices(
                 "Couldn't ascertain one of [%s] from file name. Convert to"
                 % ", ".join(valid_config_formats),
-                value_proc=_validate_choices(["yaml", "json"]),
+                choices=valid_config_formats,
                 default="yaml",
             )
 
@@ -160,13 +181,13 @@ def command_freeze(
     elif config_format == "json":
         newconfig = configparser.dump(format="json", indent=2)
 
-    if answer_yes or prompt_yes_no("Save to %s?" % dest):
+    if args.answer_yes or prompt_yes_no("Save to %s?" % dest):
         destdir = os.path.dirname(dest)
         if not os.path.isdir(destdir):
             os.makedirs(destdir)
         buf = open(dest, "w")
         buf.write(newconfig)
         buf.close()
 
-        if not quiet:
+        if not args.quiet:
             print("Saved to %s." % dest)