Add support for no response or unsupported content types (closes #141)

Author: dbanty

CHANGELOG.md

@@ -30,6 +30,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - It's now possible to include custom headers and cookies in requests, as well as set a custom timeout. This can be done
   either by directly setting those parameters on a `Client` (e.g. `my_client.headers = {"Header": "Value"}`) or using
   a fluid api (e.g. `my_endpoint.sync(my_client.with_cookies({"MyCookie": "cookie"}).with_timeout(10.0))`).
+- Unsupported content types or no responses at all will no longer result in an endpoint being completely skipped. Instead, 
+  only the `detailed` versions of the endpoint will be generated, where the resulting `Response.parsed` is always `None`.
+  (#141)
+  
+### Changes
+
+- The format of any errors/warnings has been spaced out a bit.
 
 ## 0.5.4 - 2020-08-29
 

end_to_end_tests/fastapi_app/__init__.py

@@ -98,8 +98,8 @@ def json_body(body: AModel):
     return
 
 
-@test_router.post("/test_defaults")
-def test_defaults(
+@test_router.post("/defaults")
+def defaults(
     string_prop: str = Query(default="the default string"),
     datetime_prop: datetime = Query(default=datetime(1010, 10, 10)),
     date_prop: date = Query(default=date(1010, 10, 10)),
@@ -115,14 +115,27 @@ def test_defaults(
 
 
 @test_router.get(
-    "/test_octet_stream",
+    "/octet_stream",
     response_class=FileResponse,
     responses={200: {"content": {"application/octet-stream": {"schema": {"type": "string", "format": "binary"}}}}},
 )
-def test_octet_stream():
+def octet_stream():
     return
 
 
+@test_router.get("/no_response")
+def no_response():
+    pass
+
+
+@test_router.get(
+    "/unsupported_content",
+    responses={200: {"content": {"not_real/content-type": {"schema": {"type": "string", "format": "binary"}}}}},
+)
+def unsupported_content():
+    pass
+
+
 app.include_router(test_router, prefix="/tests", tags=["tests"])
 
 

end_to_end_tests/fastapi_app/openapi.json

@@ -289,13 +289,13 @@
                 }
             }
         },
-        "/tests/test_defaults": {
+        "/tests/defaults": {
             "post": {
                 "tags": [
                     "tests"
                 ],
-                "summary": "Test Defaults",
-                "operationId": "test_defaults_tests_test_defaults_post",
+                "summary": "Defaults",
+                "operationId": "defaults_tests_defaults_post",
                 "parameters": [
                     {
                         "required": false,
@@ -439,13 +439,13 @@
                 }
             }
         },
-        "/tests/test_octet_stream": {
+        "/tests/octet_stream": {
             "get": {
                 "tags": [
                     "tests"
                 ],
-                "summary": "Test Octet Stream",
-                "operationId": "test_octet_stream_tests_test_octet_stream_get",
+                "summary": "Octet Stream",
+                "operationId": "octet_stream_tests_octet_stream_get",
                 "responses": {
                     "200": {
                         "description": "Successful Response",
@@ -460,6 +460,50 @@
                     }
                 }
             }
+        },
+        "/tests/no_response": {
+            "get": {
+                "tags": [
+                    "tests"
+                ],
+                "summary": "No Response",
+                "operationId": "no_response_tests_no_response_get",
+                "responses": {
+                    "200": {
+                        "description": "Successful Response",
+                        "content": {
+                            "application/json": {
+                                "schema": {}
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "/tests/unsupported_content": {
+            "get": {
+                "tags": [
+                    "tests"
+                ],
+                "summary": "Unsupported Content",
+                "operationId": "unsupported_content_tests_unsupported_content_get",
+                "responses": {
+                    "200": {
+                        "description": "Successful Response",
+                        "content": {
+                            "application/json": {
+                                "schema": {}
+                            },
+                            "not_real/content-type": {
+                                "schema": {
+                                    "type": "string",
+                                    "format": "binary"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
         }
     },
     "components": {

end_to_end_tests/golden-record/my_test_api_client/api/tests/test_defaults_tests_test_defaults_post.py renamed to end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py

@@ -24,7 +24,7 @@ def _get_kwargs(
     union_prop: Optional[Union[Optional[float], Optional[str]]] = "not a float",
     enum_prop: Optional[AnEnum] = None,
 ) -> Dict[str, Any]:
-    url = "{}/tests/test_defaults".format(client.base_url)
+    url = "{}/tests/defaults".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
 

end_to_end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py

@@ -0,0 +1,61 @@
+from dataclasses import asdict
+from typing import Any, Dict, List, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    client: Client,
+) -> Dict[str, Any]:
+    url = "{}/tests/no_response".format(client.base_url)
+
+    headers: Dict[str, Any] = client.get_headers()
+
+    return {
+        "url": url,
+        "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
+    }
+
+
+def _build_response(*, response: httpx.Response) -> Response[None]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=None,
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+    )
+
+    response = httpx.get(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+    )
+
+    async with httpx.AsyncClient() as _client:
+        response = await _client.get(**kwargs)
+
+    return _build_response(response=response)

end_to_end_tests/golden-record/my_test_api_client/api/tests/test_octet_stream_tests_test_octet_stream_get.py renamed to end_to_end_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_get.py

@@ -11,7 +11,7 @@ def _get_kwargs(
     *,
     client: Client,
 ) -> Dict[str, Any]:
-    url = "{}/tests/test_octet_stream".format(client.base_url)
+    url = "{}/tests/octet_stream".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
 

end_to_end_tests/golden-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py

@@ -0,0 +1,61 @@
+from dataclasses import asdict
+from typing import Any, Dict, List, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    client: Client,
+) -> Dict[str, Any]:
+    url = "{}/tests/unsupported_content".format(client.base_url)
+
+    headers: Dict[str, Any] = client.get_headers()
+
+    return {
+        "url": url,
+        "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
+    }
+
+
+def _build_response(*, response: httpx.Response) -> Response[None]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=None,
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+    )
+
+    response = httpx.get(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+    )
+
+    async with httpx.AsyncClient() as _client:
+        response = await _client.get(**kwargs)
+
+    return _build_response(response=response)

openapi_python_client/cli.py

@@ -43,40 +43,41 @@ def cli(
 
 def _print_parser_error(e: GeneratorError, color: str) -> None:
     typer.secho(e.header, bold=True, fg=color, err=True)
+    typer.echo()
     if e.detail:
         typer.secho(e.detail, fg=color, err=True)
+        typer.echo()
 
     if isinstance(e, ParseError) and e.data is not None:
         formatted_data = pformat(e.data)
         typer.secho(formatted_data, fg=color, err=True)
 
-    typer.secho()
+    typer.echo()
 
 
 def handle_errors(errors: Sequence[GeneratorError]) -> None:
     """ Turn custom errors into formatted error messages """
     if len(errors) == 0:
         return
+    error_level = ErrorLevel.WARNING
+    message = "Warning(s) encountered while generating. Client was generated, but some pieces may be missing"
+    header_color = typer.colors.BRIGHT_YELLOW
     color = typer.colors.YELLOW
     for error in errors:
         if error.level == ErrorLevel.ERROR:
-            typer.secho(
-                "Error(s) encountered while generating, client was not created",
-                underline=True,
-                bold=True,
-                fg=typer.colors.BRIGHT_RED,
-                err=True,
-            )
+            error_level = ErrorLevel.ERROR
+            message = "Error(s) encountered while generating, client was not created"
             color = typer.colors.RED
+            header_color = typer.colors.BRIGHT_RED
             break
-    else:
-        typer.secho(
-            "Warning(s) encountered while generating. Client was generated, but some pieces may be missing",
-            underline=True,
-            bold=True,
-            fg=typer.colors.BRIGHT_YELLOW,
-            err=True,
-        )
+    typer.secho(
+        message,
+        underline=True,
+        bold=True,
+        fg=header_color,
+        err=True,
+    )
+    typer.echo()
 
     for err in errors:
         _print_parser_error(err, color)
@@ -90,7 +91,9 @@ def handle_errors(errors: Sequence[GeneratorError]) -> None:
         fg=typer.colors.BLUE,
         err=True,
     )
-    raise typer.Exit(code=1)
+
+    if error_level == ErrorLevel.ERROR:
+        raise typer.Exit(code=1)
 
 
 @app.command()