Switch CLI to Typer from Click

Author: dbanty

openapi_python_client/__init__.py

@@ -9,23 +9,23 @@
 from .openapi_parser import OpenAPI, import_string_from_reference
 
 
-def main(*, url: Optional[str], path: Optional[str]) -> None:
+def main(*, url: Optional[str], path: Optional[Path]) -> None:
     """ Generate the client library """
     data_dict = _get_json(url=url, path=path)
     openapi = OpenAPI.from_dict(data_dict)
     project = _Project(openapi=openapi)
     project.build()
 
 
-def _get_json(*, url: Optional[str], path: Optional[str]) -> Dict[str, Any]:
+def _get_json(*, url: Optional[str], path: Optional[Path]) -> Dict[str, Any]:
     json_bytes: bytes
     if url is not None and path is not None:
         raise ValueError("Provide URL or Path, not both.")
     elif url is not None:
         response = requests.get(url)
         json_bytes = response.content
     elif path is not None:
-        json_bytes = Path(path).read_bytes()
+        json_bytes = path.read_bytes()
     else:
         raise ValueError("No URL or Path provided")
     return json.loads(json_bytes)

openapi_python_client/cli.py

@@ -1,27 +1,29 @@
-from importlib.metadata import version
+import pathlib
 from typing import Optional
 
-import click
+import typer
 
 from . import main
 
+app = typer.Typer()
 
-@click.group()
-@click.version_option(version(__package__), prog_name="OpenAPI Python Client")
+
+@app.callback()
 def cli() -> None:
-    """ Entrypoint into CLI """
+    """ Generate a Python client from an OpenAPI JSON document """
     pass
 
 
-@cli.command()
-@click.option("--url", help="The URL to the openapi.json file")
-@click.option("--path", help="The path to the openapi.json file")
-def generate(url: Optional[str], path: Optional[str]) -> None:
+@app.command()
+def generate(
+    url: Optional[str] = typer.Option(None, help="A URL to read the JSON from"),
+    path: Optional[pathlib.Path] = typer.Option(None, help="A path to the JSON file")
+) -> None:
     """ Generate a new OpenAPI Client library """
     if not url and not path:
-        click.secho("You must either provide --url or --path", fg="red")
-        exit(1)
+        typer.secho("You must either provide --url or --path", fg=typer.colors.RED)
+        raise typer.Exit(code=1)
     elif url and path:
-        click.secho("Provide either --url or --path, not both", fg="red")
-        exit(1)
+        typer.secho("Provide either --url or --path, not both", fg=typer.colors.RED)
+        raise typer.Exit(code=1)
     main(url=url, path=path)

poetry.lock

@@ -19,10 +19,11 @@ python = "==3.*,>=3.8.0"
 requests = "^2.22.0"
 jinja2 = "^2.11.1"
 stringcase = "^1.2.0"
-click = "^7.0"
+typer = "^0.0.8"
+colorama = {version = "^0.4.3", markers = "sys_platform == 'win32'"}
 
 [tool.poetry.scripts]
-openapi-python-client = "openapi_python_client.cli:cli"
+openapi-python-client = "openapi_python_client.cli:app"
 
 [tool.poetry.dev-dependencies]
 pytest = "*"

pyproject.toml

@@ -65,7 +65,6 @@ def test__get_json_url_no_path(self, mocker):
 
     def test__get_json_path_no_url(self, mocker):
         get = mocker.patch("requests.get")
-        Path = mocker.patch("openapi_python_client.Path")
         loads = mocker.patch("json.loads")
 
         from openapi_python_client import _get_json
@@ -74,8 +73,8 @@ def test__get_json_path_no_url(self, mocker):
         _get_json(url=None, path=path)
 
         get.assert_not_called()
-        Path.assert_called_once_with(path)
-        loads.assert_called_once_with(Path().read_bytes())
+        path.read_bytes.assert_called_once()
+        loads.assert_called_once_with(path.read_bytes())
 
 
 class TestProject:

tests/test___init__.py

@@ -1,27 +1,22 @@
-from click.testing import CliRunner
+import pytest
+import typer
 
 
 def test_generate_no_params(mocker):
     main = mocker.patch("openapi_python_client.cli.main")
     from openapi_python_client.cli import generate
-
-    runner = CliRunner()
-    result = runner.invoke(generate)
-
-    assert result.exit_code == 1
-    assert result.output == "You must either provide --url or --path\n"
+    with pytest.raises(typer.Exit) as exc_info:
+        generate()
+        assert exc_info.value.exit_code == 1
     main.assert_not_called()
 
 
 def test_generate_url_and_path(mocker):
     main = mocker.patch("openapi_python_client.cli.main")
     from openapi_python_client.cli import generate
-
-    runner = CliRunner()
-    result = runner.invoke(generate, ["--url=blah", "--path=blahblah"])
-
-    assert result.exit_code == 1
-    assert result.output == "Provide either --url or --path, not both\n"
+    with pytest.raises(typer.Exit) as exc_info:
+        generate(url="blah", path="other_blah")
+        assert exc_info.value.exit_code == 1
     main.assert_not_called()
 
 
@@ -30,41 +25,16 @@ def test_generate_url(mocker):
     url = mocker.MagicMock()
     from openapi_python_client.cli import generate
 
-    runner = CliRunner()
-    result = runner.invoke(generate, [f"--url={url}"])
+    generate(url=url, path=None)
 
-    assert result.exit_code == 0
-    main.assert_called_once_with(url=str(url), path=None)
+    main.assert_called_once_with(url=url, path=None)
 
 
 def test_generate_path(mocker):
     main = mocker.patch("openapi_python_client.cli.main")
     path = mocker.MagicMock()
     from openapi_python_client.cli import generate
 
-    runner = CliRunner()
-    result = runner.invoke(generate, [f"--path={path}"])
-
-    assert result.exit_code == 0
-    main.assert_called_once_with(path=str(path), url=None)
-
-
-def test_version():
-    from importlib.metadata import version
-    from openapi_python_client.cli import cli
-
-    runner = CliRunner()
-    result = runner.invoke(cli, ["--version"])
-
-    assert result.exit_code == 0
-    assert result.output == f"OpenAPI Python Client, version {version('openapi-python-client')}\n"
-
-
-def test_no_params():
-    from openapi_python_client.cli import cli
-
-    runner = CliRunner()
-    result = runner.invoke(cli, [])
+    generate(url=None, path=path)
 
-    assert result.exit_code == 0
-    assert "Usage" in result.output
+    main.assert_called_once_with(url=None, path=path)