Merge branch 'master' into remove-logging-configuration

Author: phillipdupuis

README.md

@@ -17,6 +17,7 @@ $ pip install pydantic-to-typescript
 |:----------|:-----------|
 |‑‑module|name or filepath of the python module you would like to convert. All the pydantic models within it will be converted to typescript interfaces. Discoverable submodules will also be checked.|
 |‑‑output|name of the file the typescript definitions should be written to. Ex: './frontend/apiTypes.ts'|
+|‑‑exclude|name of a pydantic model which should be omitted from the resulting typescript definitions. This option can be defined multiple times, ex: `--exclude Foo --exclude Bar` to exclude both the Foo and Bar models from the output.|
 |‑‑json2ts‑cmd|optional, the command used to invoke json2ts. The default is 'json2ts'. Specify this if you have it installed in a strange location and need to provide the exact path (ex: /myproject/node_modules/bin/json2ts)|
 ---
 ### Usage

pydantic2ts/cli/script.py

@@ -8,7 +8,7 @@
 from importlib.util import spec_from_file_location, module_from_spec
 from tempfile import mkdtemp
 from types import ModuleType
-from typing import Type, Dict, Any, List
+from typing import Type, Dict, Any, List, Tuple
 from uuid import uuid4
 
 import click
@@ -139,14 +139,16 @@ def generate_json_schema(models: List[Type[BaseModel]]) -> str:
     '[k: string]: any' from being added to every interface. This change is reverted
     once the schema has been generated.
     """
-    model_extras = [getattr(m.Config, 'extra', None) for m in models]
+    model_extras = [getattr(m.Config, "extra", None) for m in models]
 
     try:
         for m in models:
-            if getattr(m.Config, 'extra', None) != Extra.allow:
+            if getattr(m.Config, "extra", None) != Extra.allow:
                 m.Config.extra = Extra.forbid
 
-        master_model = create_model("_Master_", **{m.__name__: (m, ...) for m in models})
+        master_model = create_model(
+            "_Master_", **{m.__name__: (m, ...) for m in models}
+        )
         master_model.Config.extra = Extra.forbid
         master_model.Config.schema_extra = staticmethod(clean_schema)
 
@@ -164,13 +166,14 @@ def generate_json_schema(models: List[Type[BaseModel]]) -> str:
 
 
 def generate_typescript_defs(
-    module: str, output: str, json2ts_cmd: str = "json2ts"
+    module: str, output: str, exclude: Tuple[str] = (), json2ts_cmd: str = "json2ts"
 ) -> None:
     """
     Convert the pydantic models in a python module into typescript interfaces.
 
     :param module: python module containing pydantic model definitions, ex: my_project.api.schemas
     :param output: file that the typescript definitions will be written to
+    :param exclude: optional, a tuple of names for pydantic models which should be omitted from the typescript output.
     :param json2ts_cmd: optional, the command that will execute json2ts. Use this if it's installed in a strange spot.
     """
     if not shutil.which(json2ts_cmd):
@@ -183,6 +186,9 @@ def generate_typescript_defs(
 
     models = extract_pydantic_models(import_module(module))
 
+    if exclude:
+        models = [m for m in models if m.__name__ not in exclude]
+
     logger.info("Generating JSON schema from pydantic models...")
 
     schema = generate_json_schema(models)
@@ -214,16 +220,27 @@ def generate_typescript_defs(
 
 
 @click.command()
-@click.option("--module")
-@click.option("--output")
+@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, json2ts_cmd: str = "json2ts") -> None:
+def main(
+    module: str, output: str, exclude: Tuple[str], json2ts_cmd: str = "json2ts"
+) -> 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, json2ts_cmd)
+    return generate_typescript_defs(module, output, exclude, json2ts_cmd)
 
 
 if __name__ == "__main__":

setup.py

@@ -24,7 +24,7 @@ def readme():
 
 setup(
     name="pydantic-to-typescript",
-    version="1.0.6",
+    version="1.0.7",
     description="Convert pydantic models to typescript interfaces",
     license="MIT",
     long_description=readme(),

tests/expected_results/excluding_models/input.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel
+from typing import Optional, List
+
+
+class LoginCredentials(BaseModel):
+    username: str
+    password: str
+
+
+class Profile(BaseModel):
+    username: str
+    age: Optional[int]
+    hobbies: List[str]
+
+
+class LoginResponseData(BaseModel):
+    token: str
+    profile: Profile

tests/expected_results/excluding_models/output.ts

@@ -0,0 +1,12 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+/* This file was automatically generated from pydantic models by running pydantic2ts.
+/* Do not modify it by hand - just update the pydantic models and then re-run the script
+*/
+
+export interface Profile {
+  username: string;
+  age?: number;
+  hobbies: string[];
+}

tests/expected_results/generics/output.ts

@@ -1,4 +1,5 @@
 /* tslint:disable */
+/* eslint-disable */
 /**
 /* This file was automatically generated from pydantic models by running pydantic2ts.
 /* Do not modify it by hand - just update the pydantic models and then re-run the script

tests/expected_results/single_module/output.ts

@@ -1,4 +1,5 @@
 /* tslint:disable */
+/* eslint-disable */
 /**
 /* This file was automatically generated from pydantic models by running pydantic2ts.
 /* Do not modify it by hand - just update the pydantic models and then re-run the script

tests/expected_results/submodules/output.ts

@@ -1,4 +1,5 @@
 /* tslint:disable */
+/* eslint-disable */
 /**
 /* This file was automatically generated from pydantic models by running pydantic2ts.
 /* Do not modify it by hand - just update the pydantic models and then re-run the script

tests/test_script.py

@@ -16,7 +16,9 @@ def get_expected_output(test_name: str) -> str:
         return f.read()
 
 
-def run_test(tmpdir, test_name, *, module_path=None, call_from_python=False):
+def run_test(
+    tmpdir, test_name, *, module_path=None, call_from_python=False, exclude=()
+):
     """
     Execute pydantic2ts logic for converting pydantic models into tyepscript definitions.
     Compare the output with the expected output, verifying it is identical.
@@ -25,9 +27,12 @@ def run_test(tmpdir, test_name, *, module_path=None, call_from_python=False):
     output_path = tmpdir.join(f"cli_{test_name}.ts").strpath
 
     if call_from_python:
-        generate_typescript_defs(module_path, output_path)
+        generate_typescript_defs(module_path, output_path, exclude)
     else:
-        os.system(f"pydantic2ts --module {module_path} --output {output_path}")
+        cmd = f"pydantic2ts --module {module_path} --output {output_path}"
+        for model_to_exclude in exclude:
+            cmd += f" --exclude {model_to_exclude}"
+        os.system(cmd)
 
     with open(output_path, "r") as f:
         output = f.read()
@@ -46,6 +51,12 @@ def test_generics(tmpdir):
     run_test(tmpdir, "generics")
 
 
+def test_excluding_models(tmpdir):
+    run_test(
+        tmpdir, "excluding_models", exclude=("LoginCredentials", "LoginResponseData")
+    )
+
+
 def test_relative_filepath(tmpdir):
     test_name = "single_module"
     relative_path = os.path.join(".", "expected_results", test_name, "input.py")
@@ -58,3 +69,9 @@ def test_calling_from_python(tmpdir):
     run_test(tmpdir, "single_module", call_from_python=True)
     run_test(tmpdir, "submodules", call_from_python=True)
     run_test(tmpdir, "generics", call_from_python=True)
+    run_test(
+        tmpdir,
+        "excluding_models",
+        call_from_python=True,
+        exclude=("LoginCredentials", "LoginResponseData"),
+    )