Merge pull request #107 from pappasam/migrate-to-argparse

Migrate to argparse

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.28.8
+
+### Changed
+
+- Updated cli to use `argparse` instead of `click`.
+- Required pygls version updated to `0.10.2` to accommodate recent bugfixes / prevent users from filing issues based on old version.
+
+### Removed
+
+- Removed `click` from dependencies.
+
 ## 0.28.7
 
 ### Changed

jedi_language_server/cli.py

@@ -1,17 +1,51 @@
 """Jedi Language Server command line interface."""
 
-import click
+
+import argparse
+import sys
 
 from .server import SERVER
 
 
-@click.command()
-@click.version_option()
-def cli() -> None:
-    """Jedi language server.
+def get_version() -> str:
+    """Get the program version."""
+    # pylint: disable=import-outside-toplevel
+    try:
+        # Type checker for Python < 3.8 fails.
+        # Since this ony happens here, we just ignore.
+        from importlib.metadata import version  # type: ignore
+    except ImportError:
+        try:
+            # Below ignored both because this a redefinition from above, and
+            # because importlib_metadata isn't known by mypy. Ignored because
+            # this is intentional.
+            from importlib_metadata import version  # type: ignore
+        except ImportError:
+            print(
+                "Error: unable to get version. "
+                "If using Python < 3.8, you must install "
+                "`importlib_metadata` to get the version.",
+                file=sys.stderr,
+            )
+            sys.exit(1)
+    return version("jedi-language-server")
 
-    Examples:
 
-        Run from stdio : jedi-language-server
-    """
-    SERVER.start_io()  # type: ignore
+def cli() -> None:
+    """Jedi language server cli entrypoint."""
+    parser = argparse.ArgumentParser(
+        prog="jedi-language-server",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="Jedi language server: an LSP wrapper for jedi.",
+        epilog="""\
+Examples:
+
+    Run from stdio: jedi-language-server
+""",
+    )
+    parser.add_argument("--version", action="store_true")
+    args = parser.parse_args()
+    if args.version:
+        print(get_version())
+        sys.exit(0)
+    SERVER.start_io()

pyproject.toml

@@ -11,7 +11,7 @@ line_length = 79
 
 [tool.poetry]
 name = "jedi-language-server"
-version = "0.28.7"
+version = "0.28.8"
 description = "A language server for Jedi!"
 authors = ["Sam Roeca <[email protected]>"]
 readme = "README.md"
@@ -41,9 +41,8 @@ license = "MIT"
 
 [tool.poetry.dependencies]
 python = "^3.6.1"
-click = ">=7.0"
 jedi = "0.18.0"
-pygls = "^0.10.0"
+pygls = "^0.10.2"
 pydantic = "^1.7"
 docstring-to-markdown = "0.*"
 

tests/test_cli.py

@@ -1,6 +1,11 @@
 """Test the CLI."""
 
-from jedi_language_server.cli import cli
+from jedi_language_server.cli import cli, get_version
+
+
+def test_get_version() -> None:
+    """Test that the get_version function returns a string."""
+    assert isinstance(get_version(), str)
 
 
 def test_cli() -> None: