Removed click dependency, since the built-in argparse module is sufficient (phillipdupuis#22)

Also added tests for CLI argument parsing

Author: phillipdupuis

.github/workflows/cicd.yml

@@ -73,7 +73,7 @@ jobs:
           python -m pip install -U pip wheel
       - name: Build dist
         run: |
-          python setup.py sdist bdist_wheel
+          python setup.py sdist bdist_wheel bdist_egg
       - name: Publish package
         uses: pypa/gh-action-pypi-publish@v1.5.0
         with:

pydantic2ts/cli/script.py

@@ -1,17 +1,17 @@
+import argparse
 import importlib
 import inspect
 import json
 import logging
 import os
 import shutil
 import sys
-from importlib.util import spec_from_file_location, module_from_spec
+from importlib.util import module_from_spec, spec_from_file_location
 from tempfile import mkdtemp
 from types import ModuleType
-from typing import Type, Dict, Any, List, Tuple
+from typing import Any, Dict, List, Tuple, Type
 from uuid import uuid4
 
-import click
 from pydantic import BaseModel, Extra, create_model
 
 try:
@@ -217,28 +217,52 @@ def generate_typescript_defs(
     logger.info(f"Saved typescript definitions to {output}.")
 
 
-@click.command()
-@click.option(
-    "--module",
-    help="name or filepath of the python module. Discoverable submodules will also be checked",
-)
-@click.option(
-    "--output", help="name of the file the typescript definitions should be written to"
-)
-@click.option(
-    "--exclude",
-    multiple=True,
-    help="name of a pydantic model which should be omitted from the results. This option can be defined multiple times",
-)
-@click.option("--json2ts-cmd", default="json2ts")
-def main(
-    module: str, output: str, exclude: Tuple[str], json2ts_cmd: str = "json2ts"
-) -> None:
+def parse_cli_args(args: List[str] = None) -> argparse.Namespace:
+    """
+    Parses the command-line arguments passed to pydantic2ts.
+    """
+    parser = argparse.ArgumentParser(
+        prog="pydantic2ts",
+        description=main.__doc__,
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+    parser.add_argument(
+        "--module",
+        help="name or filepath of the python module.\n"
+        "Discoverable submodules will also be checked.",
+    )
+    parser.add_argument(
+        "--output",
+        help="name of the file the typescript definitions should be written to.",
+    )
+    parser.add_argument(
+        "--exclude",
+        action="append",
+        default=[],
+        help="name of a pydantic model which should be omitted from the results.\n"
+        "This option can be defined multiple times.",
+    )
+    parser.add_argument(
+        "--json2ts-cmd",
+        dest="json2ts_cmd",
+        default="json2ts",
+        help="path to the json-schema-to-typescript executable.\n" "(default: json2ts)",
+    )
+    return parser.parse_args(args)
+
+
+def main() -> None:
     """
     CLI entrypoint to run :func:`generate_typescript_defs`
     """
     logging.basicConfig(level=logging.DEBUG, format="%(asctime)s %(message)s")
-    return generate_typescript_defs(module, output, exclude, json2ts_cmd)
+    args = parse_cli_args()
+    return generate_typescript_defs(
+        args.module,
+        args.output,
+        tuple(args.exclude),
+        args.json2ts_cmd,
+    )
 
 
 if __name__ == "__main__":

setup.py

@@ -20,13 +20,12 @@ def readme():
 ]
 
 install_requires = [
-    "click",
     "pydantic",
 ]
 
 setup(
     name="pydantic-to-typescript",
-    version="1.0.8",
+    version="1.0.9",
     description="Convert pydantic models to typescript interfaces",
     license="MIT",
     long_description=readme(),

tests/test_script.py

@@ -1,8 +1,11 @@
 import os
-import sys
 import subprocess
+import sys
+
 import pytest
+
 from pydantic2ts import generate_typescript_defs
+from pydantic2ts.cli.script import parse_cli_args
 
 
 def _results_directory() -> str:
@@ -114,3 +117,24 @@ def test_error_if_invalid_module_path(tmpdir):
         generate_typescript_defs(
             "fake_module", tmpdir.join(f"fake_module_output.ts").strpath
         )
+
+
+def test_parse_cli_args():
+    args_basic = parse_cli_args(["--module", "my_module.py", "--output", "myOutput.ts"])
+    assert args_basic.module == "my_module.py"
+    assert args_basic.output == "myOutput.ts"
+    assert args_basic.exclude == []
+    assert args_basic.json2ts_cmd == "json2ts"
+    args_with_excludes = parse_cli_args(
+        [
+            "--module",
+            "my_module.py",
+            "--output",
+            "myOutput.ts",
+            "--exclude",
+            "Foo",
+            "--exclude",
+            "Bar",
+        ]
+    )
+    assert args_with_excludes.exclude == ["Foo", "Bar"]