Added CHANGELOG entry for #231, updated formatting and fixed some typing errors.

Author: dbanty

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.7.0 - Unreleased
+
+### Additions
+
+- Added a `--custom-template-path` option for providing custom jinja2 templates (#231 - Thanks @erichulburd!).
+
 ## 0.6.2 - 2020-11-03
 
 ### Fixes

README.md

@@ -54,10 +54,9 @@ get an error.
 
 > For more usage details run `openapi-python-client --help` or read [usage](usage.md)
 
-
 ### Using custom templates
 
-This feature leverages Jinja2's [ChoiceLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.ChoiceLoader) and [FileSystemLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.FileSystemLoader). This means you do _not_ need to customize every template. Simply copy the template(s) you want to customize from [the default template directory](openapi_python_client/templates) to your own custom template directory (file names _must_ match exactly) and pass the template directory through the `custom_template_path` flag to the `generate` and `update` commands. For instance, 
+This feature leverages Jinja2's [ChoiceLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.ChoiceLoader) and [FileSystemLoader](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.FileSystemLoader). This means you do _not_ need to customize every template. Simply copy the template(s) you want to customize from [the default template directory](openapi_python_client/templates) to your own custom template directory (file names _must_ match exactly) and pass the template directory through the `custom-template-path` flag to the `generate` and `update` commands. For instance,
 
 ```
 openapi-python-client update \

end_to_end_tests/golden-record-custom/my_test_api_client/__init__.py

@@ -1 +1,2 @@
 """ A client library for accessing My Test API """
+from .client import AuthenticatedClient, Client

end_to_end_tests/golden-record-custom/my_test_api_client/models/__init__.py

@@ -1 +1,9 @@
 """ Contains all the data models used in inputs/outputs """
+
+from .a_model import AModel
+from .an_enum import AnEnum
+from .an_int_enum import AnIntEnum
+from .body_upload_file_tests_upload_post import BodyUploadFileTestsUploadPost
+from .different_enum import DifferentEnum
+from .http_validation_error import HTTPValidationError
+from .validation_error import ValidationError

end_to_end_tests/regen_golden_record.py

@@ -12,7 +12,9 @@
     openapi_path = Path(__file__).parent / "openapi.json"
 
     output_path = Path.cwd() / "my-test-api-client"
-    if sys.argv[1] == "custom":
+
+    custom = len(sys.argv) >= 2 and sys.argv[1] == "custom"
+    if custom:
         gr_path = Path(__file__).parent / "golden-record-custom"
     else:
         gr_path = Path(__file__).parent / "golden-record"
@@ -21,7 +23,7 @@
     shutil.rmtree(output_path, ignore_errors=True)
     config_path = Path(__file__).parent / "config.yml"
 
-    if sys.argv[1] == "custom":
+    if custom:
         result = runner.invoke(
             app,
             [

end_to_end_tests/test_custom_templates/endpoint_module.pyi

@@ -1,6 +1,6 @@
-import httpx
 from typing import Optional
 
+import httpx
 
 Client = httpx.Client
 

openapi_python_client/__init__.py

@@ -9,7 +9,7 @@
 import httpcore
 import httpx
 import yaml
-from jinja2 import Environment, PackageLoader, ChoiceLoader, FileSystemLoader
+from jinja2 import BaseLoader, ChoiceLoader, Environment, FileSystemLoader, PackageLoader
 
 from openapi_python_client import utils
 
@@ -35,6 +35,7 @@ def __init__(self, *, openapi: GeneratorData, custom_template_path: Optional[Pat
         self.openapi: GeneratorData = openapi
 
         package_loader = PackageLoader(__package__)
+        loader: BaseLoader
         if custom_template_path is not None:
             loader = ChoiceLoader(
                 [

openapi_python_client/cli.py

@@ -109,7 +109,7 @@ def handle_errors(errors: Sequence[GeneratorError]) -> None:
 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"),
-    custom_template_path: Optional[pathlib.Path] = typer.Option(None, **custom_template_path_options),
+    custom_template_path: Optional[pathlib.Path] = typer.Option(None, **custom_template_path_options),  # type: ignore
 ) -> None:
     """ Generate a new OpenAPI Client library """
     from . import create_new_client
@@ -128,7 +128,7 @@ def generate(
 def update(
     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"),
-    custom_template_path: Optional[pathlib.Path] = typer.Option(None, **custom_template_path_options),
+    custom_template_path: Optional[pathlib.Path] = typer.Option(None, **custom_template_path_options),  # type: ignore
 ) -> None:
     """ Update an existing OpenAPI Client library """
     from . import update_existing_client

pyproject.toml

@@ -58,9 +58,11 @@ isort .\
  && pytest --cov openapi_python_client tests\
 """
 regen = "python -m end_to_end_tests.regen_golden_record"
+regen_custom = "python -m end_to_end_tests.regen_golden_record custom"
 e2e = "pytest openapi_python_client end_to_end_tests"
 re = """
 task regen\
+&& task regen_custom\
 && task e2e\
 """