Added config file option

- Allows overriding class names, closing #9

Author: dbanty

README.md

@@ -51,13 +51,37 @@ get an error.
     for endpoints without a tag.  Each of these modules in turn contains one function for calling each endpoint.
     1. A `models` module which has all the classes defined by the various schemas in your OpenAPI spec
 
+For a full example you can look at tests/test_end_to_end which has a declared [FastAPI](https://fastapi.tiangolo.com/) 
+server and the resulting openapi.json file in the "fastapi" directory.  "golden-master" is the generated client from that 
+OpenAPI document.
+    
 ## OpenAPI features supported
 1. All HTTP Methods
 1. JSON and form bodies, path and query parameters
 1. float, string, int, datetimes, string enums, and custom schemas or lists containing any of those
 1. html/text or application/json responses containing any of the previous types
 1. Bearer token security
 
+## Configuration
+You can pass a YAML (or JSON) file to openapi-python-client in order to change some behavior.  The following parameters 
+are supported:
+
+### class_overrides
+Used to change the name of generated model classes, especially useful if you have a name like ABCModel which, when 
+converted to snake case for module naming will be a_b_c_model.  This param should be a mapping of existing class name 
+(usually a key in the "schemas" section of your OpenAPI document) to class_name and module_name.
+
+Example:
+```yaml
+class_overrides:
+    ABCModel:
+      class_name: ABCModel
+      module_name: abc_model
+```
+
+The easiest way to find what needs to be overridden is probably to generate your client and go look at everything in the
+ models folder.
+
 
 ## Contributors 
  - Dylan Anthony <[email protected]> (Owner)

openapi_python_client/__init__.py

@@ -9,6 +9,7 @@
 from typing import Any, Dict, Optional
 
 import httpx
+import yaml
 from jinja2 import Environment, PackageLoader
 
 from .openapi_parser import OpenAPI, import_string_from_reference
@@ -22,6 +23,17 @@ def _get_project_for_url_or_path(url: Optional[str], path: Optional[Path]) -> _P
     return _Project(openapi=openapi)
 
 
+def load_config(*, path: Path) -> None:
+    """ Loads config from provided Path """
+    config_data = yaml.safe_load(path.read_text())
+
+    if "class_overrides" in config_data:
+        from .openapi_parser import reference
+
+        for class_name, class_data in config_data["class_overrides"].items():
+            reference.class_overrides[class_name] = reference.Reference(**class_data)
+
+
 def create_new_client(*, url: Optional[str], path: Optional[Path]) -> None:
     """ Generate the client library """
     project = _get_project_for_url_or_path(url=url, path=path)

openapi_python_client/cli.py

@@ -14,10 +14,25 @@ def _version_callback(value: bool) -> None:
         raise typer.Exit()
 
 
+def _process_config(path: Optional[pathlib.Path]) -> None:
+    from openapi_python_client import load_config
+
+    if not path:
+        return
+
+    try:
+        load_config(path=path)
+    except:
+        raise typer.BadParameter("Unable to parse config")
+
+
 # noinspection PyUnusedLocal
 @app.callback(name="openapi-python-client")
 def cli(
     version: bool = typer.Option(False, "--version", callback=_version_callback, help="Print the version and exit"),
+    config: Optional[pathlib.Path] = typer.Option(
+        None, callback=_process_config, help="Path to the config file to use"
+    ),
 ) -> None:
     """ Generate a Python client from an OpenAPI JSON document """
     pass

openapi_python_client/openapi_parser/reference.py

@@ -3,9 +3,12 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from typing import Dict
 
 import stringcase
 
+class_overrides: Dict[str, Reference] = {}
+
 
 @dataclass
 class Reference:
@@ -18,4 +21,9 @@ class Reference:
     def from_ref(ref: str) -> Reference:
         """ Get a Reference from the openapi #/schemas/blahblah string """
         ref_value = ref.split("/")[-1]
-        return Reference(class_name=stringcase.pascalcase(ref_value), module_name=stringcase.snakecase(ref_value),)
+        class_name = stringcase.pascalcase(ref_value)
+
+        if class_name in class_overrides:
+            return class_overrides[class_name]
+
+        return Reference(class_name=class_name, module_name=stringcase.snakecase(ref_value),)

poetry.lock

@@ -24,6 +24,7 @@ shellingham = "^1.3.2"
 httpx = "^0.12.1"
 black = "^19.10b0"
 isort = "^4.3.21"
+pyyaml = "^5.3.1"
 
 [tool.poetry.scripts]
 openapi-python-client = "openapi_python_client.cli:app"

pyproject.toml

@@ -437,3 +437,21 @@ def test__reformat(mocker):
             mocker.call("black .", cwd=project.project_dir, shell=True),
         ]
     )
+
+
+def test_load_config(mocker):
+    my_data = {"class_overrides": {"_MyCLASSName": {"class_name": "MyClassName", "module_name": "my_module_name"}}}
+    safe_load = mocker.patch("yaml.safe_load", return_value=my_data)
+    fake_path = mocker.MagicMock(autospec=pathlib.Path)
+
+    from openapi_python_client import load_config
+
+    load_config(path=fake_path)
+
+    fake_path.read_text.assert_called_once()
+    safe_load.assert_called_once_with(fake_path.read_text())
+    from openapi_python_client.openapi_parser import reference
+
+    assert reference.class_overrides == {
+        "_MyCLASSName": reference.Reference(class_name="MyClassName", module_name="my_module_name")
+    }

tests/test___init__.py

@@ -1,4 +1,5 @@
 from pathlib import PosixPath
+from unittest.mock import MagicMock
 
 import pytest
 from typer.testing import CliRunner
@@ -18,17 +19,46 @@ def test_version(mocker):
 
 
 @pytest.fixture
-def _create_new_client(mocker):
+def _create_new_client(mocker) -> MagicMock:
     return mocker.patch("openapi_python_client.create_new_client")
 
 
+def test_config(mocker, _create_new_client):
+    load_config = mocker.patch("openapi_python_client.load_config")
+    from openapi_python_client.cli import app
+
+    config_path = "config/path"
+    path = "cool/path"
+
+    result = runner.invoke(app, [f"--config={config_path}", "generate", f"--path={path}"], catch_exceptions=False)
+
+    assert result.exit_code == 0
+    load_config.assert_called_once_with(path=PosixPath(config_path))
+    _create_new_client.assert_called_once_with(url=None, path=PosixPath(path))
+
+
+def test_bad_config(mocker, _create_new_client):
+    load_config = mocker.patch("openapi_python_client.load_config", side_effect=ValueError("Bad Config"))
+    from openapi_python_client.cli import app
+
+    config_path = "config/path"
+    path = "cool/path"
+
+    result = runner.invoke(app, [f"--config={config_path}", "generate", f"--path={path}"])
+
+    assert result.exit_code == 2
+    assert "Unable to parse config" in result.stdout
+    load_config.assert_called_once_with(path=PosixPath(config_path))
+    _create_new_client.assert_not_called()
+
+
 class TestGenerate:
     def test_generate_no_params(self, _create_new_client):
         from openapi_python_client.cli import app
 
         result = runner.invoke(app, ["generate"])
 
-        assert result.exit_code == 1
+        assert result.exit_code == 1, result.output
         _create_new_client.assert_not_called()
 
     def test_generate_url_and_path(self, _create_new_client):

tests/test_cli.py

@@ -0,0 +1,4 @@
+class_overrides:
+  _ABCResponse:
+    class_name: ABCResponse
+    module_name: abc_response

tests/test_end_to_end/config.yml

@@ -8,11 +8,11 @@
 app = FastAPI(title="My Test API", description="An API for testing openapi-python-client",)
 
 
-class PingResponse(BaseModel):
+class _ABCResponse(BaseModel):
     success: bool
 
 
-@app.get("/ping", response_model=PingResponse)
+@app.get("/ping", response_model=_ABCResponse)
 async def ping():
     """ A quick check to see if the system is running """
     return {"success": True}

tests/test_end_to_end/fastapi/__init__.py

@@ -1 +1 @@
-{"openapi": "3.0.2", "info": {"title": "My Test API", "description": "An API for testing openapi-python-client", "version": "0.1.0"}, "paths": {"/ping": {"get": {"summary": "Ping", "description": "A quick check to see if the system is running ", "operationId": "ping_ping_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/PingResponse"}}}}}}}}, "components": {"schemas": {"PingResponse": {"title": "PingResponse", "required": ["success"], "type": "object", "properties": {"success": {"title": "Success", "type": "boolean"}}}}}}
+{"openapi": "3.0.2", "info": {"title": "My Test API", "description": "An API for testing openapi-python-client", "version": "0.1.0"}, "paths": {"/ping": {"get": {"summary": "Ping", "description": "A quick check to see if the system is running ", "operationId": "ping_ping_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/_ABCResponse"}}}}}}}}, "components": {"schemas": {"_ABCResponse": {"title": "_ABCResponse", "required": ["success"], "type": "object", "properties": {"success": {"title": "Success", "type": "boolean"}}}}}}

tests/test_end_to_end/fastapi/openapi.json

@@ -4,21 +4,21 @@
 import httpx
 
 from ..client import AuthenticatedClient, Client
-from ..models.ping_response import PingResponse
+from ..models.abc_response import ABCResponse
 from .errors import ApiResponseError
 
 
 def ping_ping_get(
     *, client: Client,
 ) -> Union[
-    PingResponse,
+    ABCResponse,
 ]:
     """ A quick check to see if the system is running  """
     url = f"{client.base_url}/ping"
 
     response = httpx.get(url=url, headers=client.get_headers(),)
 
     if response.status_code == 200:
-        return PingResponse.from_dict(response.json())
+        return ABCResponse.from_dict(response.json())
     else:
         raise ApiResponseError(response=response)

tests/test_end_to_end/golden-master/my_test_api_client/api/default.py

@@ -4,14 +4,14 @@
 import httpx
 
 from ..client import AuthenticatedClient, Client
-from ..models.ping_response import PingResponse
+from ..models.abc_response import ABCResponse
 from .errors import ApiResponseError
 
 
 async def ping_ping_get(
     *, client: Client,
 ) -> Union[
-    PingResponse,
+    ABCResponse,
 ]:
     """ A quick check to see if the system is running  """
     url = f"{client.base_url}/ping"
@@ -20,6 +20,6 @@ async def ping_ping_get(
         response = await client.get(url=url, headers=client.get_headers(),)
 
     if response.status_code == 200:
-        return PingResponse.from_dict(response.json())
+        return ABCResponse.from_dict(response.json())
     else:
         raise ApiResponseError(response=response)

tests/test_end_to_end/golden-master/my_test_api_client/async_api/default.py

@@ -1,3 +1,3 @@
 """ Contains all the data models used in inputs/outputs """
 
-from .ping_response import PingResponse
+from .abc_response import ABCResponse

tests/test_end_to_end/golden-master/my_test_api_client/models/__init__.py

@@ -6,7 +6,7 @@
 
 
 @dataclass
-class PingResponse:
+class ABCResponse:
     """  """
 
     success: bool
@@ -17,7 +17,7 @@ def to_dict(self) -> Dict:
         }
 
     @staticmethod
-    def from_dict(d: Dict) -> PingResponse:
+    def from_dict(d: Dict) -> ABCResponse:
 
         success = d["success"]
-        return PingResponse(success=success,)
+        return ABCResponse(success=success,)

tests/test_end_to_end/golden-master/my_test_api_client/models/ping_response.py renamed to tests/test_end_to_end/golden-master/my_test_api_client/models/abc_response.py

@@ -10,9 +10,11 @@
     runner = CliRunner()
     openapi_path = Path(__file__).parent / "fastapi" / "openapi.json"
     gm_path = Path(__file__).parent / "golden-master"
-    shutil.rmtree(gm_path)
+    shutil.rmtree(gm_path, ignore_errors=True)
     output_path = Path.cwd() / "my-test-api-client"
+    shutil.rmtree(output_path, ignore_errors=True)
+    config_path = Path(__file__).parent / "config.yml"
 
-    runner.invoke(app, ["generate", f"--path={openapi_path}"])
+    runner.invoke(app, [f"--config={config_path}", "generate", f"--path={openapi_path}"])
 
     output_path.rename(gm_path)

tests/test_end_to_end/regen-golden-master.py

@@ -27,10 +27,11 @@ def _compare_directories(first: Path, second: Path, /):
 def test_end_to_end(capsys):
     runner = CliRunner()
     openapi_path = Path(__file__).parent / "fastapi" / "openapi.json"
+    config_path = Path(__file__).parent / "config.yml"
     gm_path = Path(__file__).parent / "golden-master"
     output_path = Path.cwd() / "my-test-api-client"
 
-    result = runner.invoke(app, ["generate", f"--path={openapi_path}"])
+    result = runner.invoke(app, [f"--config={config_path}", "generate", f"--path={openapi_path}"])
 
     if result.exit_code != 0:
         raise result.exception

tests/test_end_to_end/test_end_to_end.py

@@ -248,11 +248,11 @@ def test_add_body_happy(self, mocker):
         from openapi_python_client.openapi_parser.openapi import Endpoint, Reference, RefProperty
 
         request_body = mocker.MagicMock()
-        form_body_reference = Reference(ref="a")
+        form_body_reference = Reference.from_ref(ref="a")
         parse_request_form_body = mocker.patch.object(
             Endpoint, "parse_request_form_body", return_value=form_body_reference
         )
-        json_body = RefProperty(name="name", required=True, default=None, reference=Reference("b"))
+        json_body = RefProperty(name="name", required=True, default=None, reference=Reference.from_ref("b"))
         parse_request_json_body = mocker.patch.object(Endpoint, "parse_request_json_body", return_value=json_body)
         import_string_from_reference = mocker.patch(
             f"{MODULE_NAME}.import_string_from_reference", side_effect=["import_1", "import_2"]
@@ -294,8 +294,8 @@ def test__add_responses(self, mocker):
             tag="tag",
             relative_imports={"import_3"},
         )
-        ref_1 = Reference(ref="ref_1")
-        ref_2 = Reference(ref="ref_2")
+        ref_1 = Reference.from_ref(ref="ref_1")
+        ref_2 = Reference.from_ref(ref="ref_2")
         response_1 = RefResponse(status_code=200, reference=ref_1)
         response_2 = RefResponse(status_code=404, reference=ref_2)
         response_from_dict = mocker.patch(f"{MODULE_NAME}.response_from_dict", side_effect=[response_1, response_2])

tests/test_openapi_parser/test_openapi.py

@@ -5,3 +5,12 @@ def test_from_ref():
 
     assert r.class_name == "PingResponse"
     assert r.module_name == "ping_response"
+
+
+def test_from_ref_class_overrides():
+    from openapi_python_client.openapi_parser.reference import Reference, class_overrides
+
+    ref = "#/components/schemas/_MyResponse"
+    class_overrides["_MyResponse"] = Reference(class_name="MyResponse", module_name="my_response")
+
+    assert Reference.from_ref(ref) == class_overrides["_MyResponse"]