refactor!: click -> argparse (#400)

click is an additional dependency, introduces complicated bugs,
sphinx-click is difficult to place commands into document sections.

On the other hand, argparse is stable, battle-tested, predictable.

Author: tony

CHANGES

@@ -19,6 +19,18 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
 
 - _Add your latest changes from PRs here_
 
+**Maintenance release, no features or fixes**
+
+### Internal
+
+- Move from click to :mod:{argparse}
+
+  Click was more difficult to control and workwith, ironically.
+
+### Packaging
+
+- Drop click dependency (#400)
+
 ## vcspull v1.14.0 (2022-10-01)
 
 **Maintenance release, no features or fixes**
@@ -230,7 +242,7 @@ Patch branch: [`v1.12.x`](https://github.com/vcs-python/vcspull/tree/v1.12.x)
 
 ### Fix
 
-- Tab-completion for repository names and configurations
+- Tab-completion for repository names and configurations (retracted in v1.15)
 
 ## vcspull 1.11.1 (2022-03-12)
 
@@ -272,7 +284,7 @@ Patch branch: [`v1.12.x`](https://github.com/vcs-python/vcspull/tree/v1.12.x)
 
 ### Improvements
 
-- Experimental completion, see {ref}`completion`:
+- Experimental completion (retracted in v1.15):
 
   - Completion for sync:
 
@@ -281,7 +293,7 @@ Patch branch: [`v1.12.x`](https://github.com/vcs-python/vcspull/tree/v1.12.x)
 
 ### Documentation
 
-- Added {ref}`completion`:
+- Added completion:
 
 ## vcspull 1.9.0 (2022-02-26)
 

docs/cli/completion.md

@@ -14,10 +14,3 @@ vcspull
 
 sync
 ```
-
-```{toctree}
-:caption: More
-:maxdepth: 1
-
-completion
-```

docs/cli/index.md

@@ -4,6 +4,16 @@
 
 # vcspull sync
 
+## Command
+
+```{eval-rst}
+.. argparse::
+    :module: vcspull.cli
+    :func: create_parser
+    :prog: vcspull
+    :path: sync
+```
+
 ## Filtering repos
 
 As of 1.13.x, `$ vcspull sync` with no args passed will show a help dialog:
@@ -80,10 +90,3 @@ Print traceback for errored repos:
 ```console
 $ vcspull --log-level DEBUG sync --exit-on-error grako django
 ```
-
-```{eval-rst}
-.. click:: vcspull.cli.sync:sync
-    :prog: vcspull sync
-    :commands: sync
-    :nested: full
-```

docs/cli/sync.md

@@ -5,7 +5,12 @@
 # vcspull
 
 ```{eval-rst}
-.. click:: vcspull.cli:cli
-    :prog: Usage
-    :nested: none
+.. argparse::
+    :module: vcspull.cli
+    :func: create_parser
+    :prog: vcspull
+    :nosubcommands:
+
+    subparser_name : @replace
+        See :ref:`cli-sync`
 ```

docs/cli/vcspull.md

@@ -23,7 +23,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.napoleon",
     "sphinx.ext.linkcode",
-    "sphinx_click.ext",  # sphinx-click
+    "sphinxarg.ext",  # sphinx-argparse
     "sphinx_inline_tabs",
     "sphinx_copybutton",
     "sphinxext.opengraph",

docs/conf.py

@@ -59,7 +59,6 @@ vcspull = 'vcspull:cli.cli'
 
 [tool.poetry.dependencies]
 python = "^3.9"
-click = "~8"
 libvcs = "~0.17.0"
 colorama = ">=0.3.9"
 
@@ -70,7 +69,6 @@ furo = "*"
 gp-libs = "0.0.1a16"
 sphinx-autobuild = "*"
 sphinx-autodoc-typehints = "*"
-sphinx-click = "*"
 sphinx-inline-tabs = "*"
 sphinxext-opengraph = "*"
 sphinx-copybutton = "*"
@@ -105,7 +103,6 @@ types-colorama = "*"
 [tool.poetry.extras]
 docs = [
   "sphinx",
-  "sphinx-click",
   "sphinx-autodoc-typehints",
   "sphinx-autobuild",
   "sphinxext-rediraffe",
@@ -129,6 +126,9 @@ lint = [
   "types-colorama",
 ]
 
+[tool.poetry.group.dev.dependencies]
+sphinx-argparse = "^0.3.1"
+
 [tool.mypy]
 python_version = 3.9
 warn_unused_configs = true

poetry.lock

@@ -4,39 +4,52 @@
 ~~~~~~~~~~~
 
 """
+import argparse
 import logging
 
-import click
-
 from libvcs.__about__ import __version__ as libvcs_version
 
 from ..__about__ import __version__
 from ..log import setup_logger
-from .sync import sync
+from .sync import create_sync_subparser, sync
 
 log = logging.getLogger(__name__)
 
 
-@click.group(
-    context_settings={
-        "obj": {},
-        "help_option_names": ["-h", "--help"],
-    }
-)
-@click.option(
-    "--log-level",
-    default="INFO",
-    help="Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
-)
-@click.version_option(
-    __version__,
-    "-V",
-    "--version",
-    message=f"%(prog)s %(version)s, libvcs {libvcs_version}",
-)
-def cli(log_level):
-    setup_logger(log=log, level=log_level.upper())
-
-
-# Register sub-commands here
-cli.add_command(sync)
+def create_parser():
+    parser = argparse.ArgumentParser(prog="vcspull")
+    parser.add_argument(
+        "--version",
+        "-V",
+        action="version",
+        version=f"%(prog)s {__version__}, libvcs {libvcs_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")
+    sync_parser = subparsers.add_parser("sync")
+    create_sync_subparser(sync_parser)
+
+    return parser
+
+
+def cli(args=None):
+    parser = create_parser()
+    args = parser.parse_args(args)
+
+    setup_logger(log=log, level=args.log_level.upper())
+
+    if args.subparser_name is None:
+        parser.print_help()
+        return
+    elif args.subparser_name == "sync":
+        sync(
+            repo_terms=args.repo_terms,
+            config=args.config,
+            exit_on_error=args.exit_on_error,
+            parser=parser,
+        )