Initial commit

Author: phillipdupuis

.gitignore

@@ -0,0 +1,142 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# my stuff
+.idea
+.private.txt

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2020 Phillip Dupuis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pydantic2ts/__init__.py

@@ -0,0 +1,103 @@
+import click
+import inspect
+import importlib
+import os
+import shutil
+from pydantic import BaseModel, create_model
+from typing import Type, Dict, Any
+from types import ModuleType
+
+
+def remove_property_titles(schema: Dict[str, Any], model: Type[BaseModel]) -> None:
+    """
+    Monkey-patched method for removing titles from JSON schema properties.
+    If we don't do this, each property will have its own interface in the
+    resulting typescript file (which is a LOT of unnecessary noise).
+    """
+    for prop in schema.get('properties', {}).values():
+        prop.pop('title', None)
+
+
+def extract_pydantic_models(module: ModuleType):
+    """
+    Given a module, return a list of the pydantic models contained within it.
+    """
+    models = []
+    for name in dir(module):
+        obj = getattr(module, name)
+        if (not name.startswith('_'))\
+                and inspect.isclass(obj)\
+                and issubclass(obj, BaseModel)\
+                and obj != BaseModel:
+            models.append(obj)
+    return models
+
+
+def remove_master_model_from_output(output: str) -> None:
+    """
+    A faux 'master model' with references to all the pydantic models is necessary for generating
+    clean typescript definitions without any duplicates, but we don't actually want it in the
+    output. This function handles removing it from the generated typescript file.
+    """
+    with open(output, 'r') as f:
+        lines = f.readlines()
+
+    start, end = None, None
+    for i, line in enumerate(lines):
+        if line.rstrip('\r\n') == 'export interface _Master_ {':
+            start = i
+        elif (start is not None) and line.rstrip('\r\n') == '}':
+            end = i
+            break
+
+    new_lines = lines[:start] + lines[(end + 1):]
+    with open(output, 'w') as f:
+        f.writelines(new_lines)
+
+
+@click.command()
+@click.option('--module')
+@click.option('--output')
+@click.option('--json2ts-cmd', default='json2ts')
+def main(
+    module: str,
+    output: 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 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):
+        raise Exception('json2ts must be installed. Instructions can be found here: '
+                        'https://www.npmjs.com/package/json-schema-to-typescript')
+
+    models = extract_pydantic_models(importlib.import_module(module))
+
+    for m in models:
+        m.Config.schema_extra = staticmethod(remove_property_titles)
+
+    master_model = create_model('_Master_', **{m.__name__: (m, ...) for m in models})
+    master_model.Config.schema_extra = staticmethod(remove_property_titles)
+
+    with open('schema.json', 'w') as f:
+        f.write(master_model.schema_json(indent=2))
+
+    banner_comment = '\n'.join([
+        '/* tslint: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',
+        '*/',
+    ])
+
+    os.system(f'{json2ts_cmd} -i schema.json -o {output} --bannerComment "{banner_comment}"')
+    os.remove('schema.json')
+    remove_master_model_from_output(output)
+
+
+if __name__ == '__main__':
+    main()

pydantic2ts/cli/__init__.py

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pydantic2ts --module pydantic2ts.examples.pydantic_models --output output.ts

pydantic2ts/cli/script.py

@@ -0,0 +1,16 @@
+/* tslint: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 Athlete {
+  name: string;
+  age: number;
+  sports: ("football" | "basketball" | "running" | "swimming")[];
+}
+export interface Team {
+  name: string;
+  sport: "football" | "basketball" | "running" | "swimming";
+  athletes: Athlete[];
+}

pydantic2ts/examples/__init__.py

@@ -0,0 +1,28 @@
+from pydantic import BaseModel, Extra
+from enum import Enum
+from typing import List
+
+
+class NoUnspecifiedProps:
+    extra = Extra.forbid
+
+
+class Sport(str, Enum):
+    football = 'football'
+    basketball = 'basketball'
+    running = 'running'
+    swimming = 'swimming'
+
+
+class Athlete(BaseModel):
+    name: str
+    age: int
+    sports: List[Sport]
+    Config = NoUnspecifiedProps
+
+
+class Team(BaseModel):
+    name: str
+    sport: Sport
+    athletes: List[Athlete]
+    Config = NoUnspecifiedProps

pydantic2ts/examples/convert.sh

@@ -0,0 +1,2 @@
+click
+pydantic