refactor!(click -> argparse)

Author: tony

src/tmuxp/cli/__init__.py

@@ -4,50 +4,92 @@
 ~~~~~~~~~
 
 """
+import argparse
 import logging
 import os
 import sys
 
-import click
-
 from libtmux.__about__ import __version__ as libtmux_version
 from libtmux.common import has_minimum_version
 from libtmux.exc import TmuxCommandNotFound
-from tmuxp.cli.ls import command_ls
 
 from .. import exc
 from ..__about__ import __version__
 from ..log import setup_logger
-from .convert import command_convert
-from .debug_info import command_debug_info
-from .edit import command_edit
-from .freeze import command_freeze
-from .import_config import command_import
-from .load import command_load
-from .shell import command_shell
+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 .import_config import (
+    command_import_teamocil,
+    command_import_tmuxinator,
+    create_import_subparser,
+)
+from .load import command_load, create_load_subparser
+from .ls import command_ls, create_ls_subparser
+from .shell import command_shell, create_shell_subparser
 from .utils import tmuxp_echo
 
 logger = logging.getLogger(__name__)
 
 
-@click.group(context_settings={"obj": {}, "help_option_names": ["-h", "--help"]})
-@click.version_option(
-    __version__,
-    "-V",
-    "--version",
-    message=f"%(prog)s %(version)s, libtmux {libtmux_version}",
-)
-@click.option(
-    "--log-level",
-    default="INFO",
-    help="Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
-)
-def cli(log_level):
+def create_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(prog="tmuxp")
+    parser.add_argument(
+        "--version",
+        "-V",
+        action="version",
+        version=f"%(prog)s {__version__}, libtmux {libtmux_version}",
+    )
+    parser.add_argument(
+        "--log-level",
+        action="store",
+        default="INFO",
+        help="log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
+    )
+    subparsers = parser.add_subparsers(dest="subparser_name")
+    load_parser = subparsers.add_parser("load", help="load tmuxp workspaces")
+    create_load_subparser(load_parser)
+    shell_parser = subparsers.add_parser(
+        "shell", help="launch python shell for tmux server, session, window and pane"
+    )
+    create_shell_subparser(shell_parser)
+    import_parser = subparsers.add_parser(
+        "import", help="import configurations from teamocil and tmuxinator."
+    )
+    create_import_subparser(import_parser)
+
+    convert_parser = subparsers.add_parser(
+        "convert", help="convert configs between yaml and json."
+    )
+    create_convert_subparser(convert_parser)
+
+    debug_info_parser = subparsers.add_parser(
+        "debug-info", help="print out all diagnostic info"
+    )
+    create_debug_info_subparser(debug_info_parser)
+
+    ls_parser = subparsers.add_parser("ls", help="list sessions in config directory")
+    create_ls_subparser(ls_parser)
+
+    edit_parser = subparsers.add_parser("edit", help="run $EDITOR on config")
+    create_edit_subparser(edit_parser)
+
+    freeze_parser = subparsers.add_parser(
+        "freeze", help="freeze a live tmux session to a tmuxp config"
+    )
+    create_freeze_subparser(freeze_parser)
+
+    return parser
+
+
+def cli(args=None):
     """Manage tmux sessions.
 
     Pass the "--help" argument to any command to see detailed help.
     See detailed documentation and examples at:
     http://tmuxp.git-pull.com/"""
+
     try:
         has_minimum_version()
     except TmuxCommandNotFound:
@@ -56,7 +98,84 @@ def cli(log_level):
     except exc.TmuxpException as e:
         tmuxp_echo(e, err=True)
         sys.exit()
-    setup_logger(logger=logger, level=log_level.upper())
+
+    parser = create_parser()
+    args = parser.parse_args(args)
+
+    setup_logger(logger=logger, level=args.log_level.upper())
+
+    if args.subparser_name is None:
+        parser.print_help()
+        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,
+            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,
+            parser=parser,
+        )
+    elif args.subparser_name == "import":
+        import_subparser_name = getattr(args, "import_subparser_name", None)
+        if import_subparser_name is None:
+            parser.print_help()
+            return
+        elif import_subparser_name == "teamocil":
+            command_import_teamocil(
+                config_file=args.config_file,
+                parser=parser,
+            )
+        elif import_subparser_name == "tmuxinator":
+            command_import_tmuxinator(
+                config_file=args.config_file,
+                parser=parser,
+            )
+    elif args.subparser_name == "convert":
+        command_convert(
+            config_file=args.config_file,
+            answer_yes=args.answer_yes,
+            parser=parser,
+        )
+    elif args.subparser_name == "debug-info":
+        command_debug_info(parser=parser)
+
+    elif args.subparser_name == "edit":
+        command_edit(
+            config_file=args.config_file,
+            parser=parser,
+        )
+    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,
+            parser=parser,
+        )
+    elif args.subparser_name == "ls":
+        command_ls(parser=parser)
 
 
 def startup(config_dir):
@@ -70,14 +189,3 @@ def startup(config_dir):
 
     if not os.path.exists(config_dir):
         os.makedirs(config_dir)
-
-
-# Register sub-commands here
-cli.add_command(command_convert)
-cli.add_command(command_edit)
-cli.add_command(command_debug_info)
-cli.add_command(command_load)
-cli.add_command(command_ls)
-cli.add_command(command_freeze)
-cli.add_command(command_shell)
-cli.add_command(command_import)

src/tmuxp/cli/convert.py

@@ -1,43 +1,64 @@
+import argparse
 import os
 import pathlib
-
-import click
+import typing as t
 
 from tmuxp.config_reader import ConfigReader
 
-from .utils import ConfigPath
+from .utils import get_config_dir, prompt_yes_no, scan_config
+
 
+def create_convert_subparser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
+    parser.add_argument(
+        dest="config_file",
+        type=str,
+        metavar="config-file",
+        help="checks tmuxp and current directory for config files.",
+    )
+    parser.add_argument(
+        "--yes",
+        "-y",
+        dest="answer_yes",
+        action="store_true",
+        help="always answer yes",
+    )
+    return parser
 
-@click.command(name="convert")
-@click.option(
-    "--yes", "-y", "confirmed", help='Auto confirms with "yes".', is_flag=True
-)
-@click.argument("config", type=ConfigPath(exists=True), nargs=1)
-def command_convert(confirmed, config):
+
+def command_convert(
+    config_file: t.Union[str, pathlib.Path],
+    answer_yes: bool,
+    parser: t.Optional[argparse.ArgumentParser] = None,
+):
     """Convert a tmuxp config between JSON and YAML."""
+    config_file = scan_config(config_file, config_dir=get_config_dir())
+
+    if isinstance(config_file, str):
+        config_file = pathlib.Path(config_file)
 
-    _, ext = os.path.splitext(config)
+    _, ext = os.path.splitext(config_file)
     ext = ext.lower()
     if ext == ".json":
         to_filetype = "yaml"
     elif ext in [".yaml", ".yml"]:
         to_filetype = "json"
     else:
-        raise click.BadParameter(
-            f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])"
-        )
+        raise Exception(f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])")
 
-    configparser = ConfigReader.from_file(pathlib.Path(config))
-    newfile = config.replace(ext, f".{to_filetype}")
+    configparser = ConfigReader.from_file(config_file)
+    newfile = config_file.parent / (str(config_file.stem) + f".{to_filetype}")
 
-    new_config = configparser.dump(format=to_filetype)
+    export_kwargs = {"default_flow_style": False} if to_filetype == "yaml" else {}
+    new_config = configparser.dump(format=to_filetype, indent=2, **export_kwargs)
 
-    if not confirmed:
-        if click.confirm(f"convert to <{config}> to {to_filetype}?"):
-            if click.confirm(f"Save config to {newfile}?"):
-                confirmed = True
+    if not answer_yes:
+        if prompt_yes_no(f"Convert to <{config_file}> to {to_filetype}?"):
+            if prompt_yes_no("Save config to %s?" % newfile):
+                answer_yes = True
 
-    if confirmed:
+    if answer_yes:
         buf = open(newfile, "w")
         buf.write(new_config)
         buf.close()

src/tmuxp/cli/debug_info.py

@@ -1,12 +1,14 @@
+import argparse
 import os
 import pathlib
 import platform
 import shutil
 import sys
+import typing as t
 
-import click
+from colorama import Fore
 
-from libtmux import __version__ as libtmux_version
+from libtmux.__about__ import __version__ as libtmux_version
 from libtmux.common import get_version, tmux_cmd
 
 from ..__about__ import __version__
@@ -15,8 +17,15 @@
 tmuxp_path = pathlib.Path(__file__).parent.parent
 
 
-@click.command(name="debug-info", short_help="Print out all diagnostic info")
-def command_debug_info():
+def create_debug_info_subparser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
+    return parser
+
+
+def command_debug_info(
+    parser: t.Optional[argparse.ArgumentParser] = None,
+):
     """
     Print debug info to submit with Issues.
     """
@@ -40,7 +49,9 @@ def format_tmux_resp(std_resp):
         return "\n".join(
             [
                 "\n".join(prepend_tab(std_resp.stdout)),
-                click.style("\n".join(prepend_tab(std_resp.stderr)), fg="red"),
+                Fore.RED,
+                "\n".join(prepend_tab(std_resp.stderr)),
+                Fore.RESET,
             ]
         )
 

src/tmuxp/cli/edit.py

@@ -1,15 +1,28 @@
+import argparse
 import os
+import pathlib
 import subprocess
+import typing as t
 
-import click
+from .utils import scan_config
 
-from .utils import ConfigPath, scan_config
 
+def create_edit_subparser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
+    parser.add_argument(
+        dest="config_file",
+        type=str,
+        help="checks current tmuxp and current directory for yaml files.",
+    )
+    return parser
 
-@click.command(name="edit", short_help="Run $EDITOR on config.")
-@click.argument("config", type=ConfigPath(exists=True), nargs=1)
-def command_edit(config):
-    config = scan_config(config)
+
+def command_edit(
+    config_file: t.Union[str, pathlib.Path],
+    parser: t.Optional[argparse.ArgumentParser] = None,
+):
+    config_file = scan_config(config_file)
 
     sys_editor = os.environ.get("EDITOR", "vim")
-    subprocess.call([sys_editor, config])
+    subprocess.call([sys_editor, config_file])