Merge branch 'master' into pr/29

Author: dbanty

CHANGELOG.md

@@ -4,6 +4,13 @@ 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.3.0 - Unreleased
+### Additions
+- Link to the GitHub repository from PyPI (#26). Thanks @theY4Kman!
+
+### Fixes
+- Fixed some typing issues in generated clients and incorporate mypy into end to end tests (#32). Thanks @acgray!
+
 ## 0.2.1 - 2020-03-22
 ### Fixes
 - Fixed import of errors.py in generated api modules

openapi_python_client/openapi_parser/openapi.py

@@ -191,10 +191,10 @@ def dict(d: Dict[str, Dict[str, Any]], /) -> Dict[str, Schema]:
 
 @dataclass
 class OpenAPI:
-    """ Top level OpenAPI spec """
+    """ Top level OpenAPI document """
 
     title: str
-    description: str
+    description: Optional[str]
     version: str
     schemas: Dict[str, Schema]
     endpoint_collections_by_tag: Dict[str, EndpointCollection]
@@ -243,7 +243,7 @@ def from_dict(d: Dict[str, Dict[str, Any]], /) -> OpenAPI:
 
         return OpenAPI(
             title=d["info"]["title"],
-            description=d["info"]["description"],
+            description=d["info"].get("description"),
             version=d["info"]["version"],
             endpoint_collections_by_tag=endpoint_collections_by_tag,
             schemas=schemas,

openapi_python_client/openapi_parser/properties.py

@@ -172,7 +172,10 @@ def transform(self) -> str:
 
     def constructor_from_dict(self, dict_name: str) -> str:
         """ How to load this property from a dict (used in generated model from_dict function """
-        return f'{self.reference.class_name}({dict_name}["{self.name}"]) if "{self.name}" in {dict_name} else None'
+        constructor = f'{self.reference.class_name}({dict_name}["{self.name}"])'
+        if not self.required:
+            constructor += f' if "{self.name}" in {dict_name} else None'
+        return constructor
 
     @staticmethod
     def values_from_list(l: List[str], /) -> Dict[str, str]:
@@ -213,15 +216,15 @@ def transform(self) -> str:
 class DictProperty(Property):
     """ Property that is a general Dict """
 
-    _type_string: ClassVar[str] = "Dict"
+    _type_string: ClassVar[str] = "Dict[Any, Any]"
 
 
 _openapi_types_to_python_type_strings = {
     "string": "str",
     "number": "float",
     "integer": "int",
     "boolean": "bool",
-    "object": "Dict",
+    "object": "Dict[Any, Any]",
 }
 
 

openapi_python_client/openapi_parser/responses.py

@@ -33,7 +33,7 @@ def return_string(self) -> str:
 
     def constructor(self) -> str:
         """ How the return value of this response should be constructed """
-        return f"[{self.reference.class_name}.from_dict(item) for item in response.json()]"
+        return f"[{self.reference.class_name}.from_dict(item) for item in cast(List[Dict[str, Any]], response.json())]"
 
 
 @dataclass
@@ -48,7 +48,7 @@ def return_string(self) -> str:
 
     def constructor(self) -> str:
         """ How the return value of this response should be constructed """
-        return f"{self.reference.class_name}.from_dict(response.json())"
+        return f"{self.reference.class_name}.from_dict(cast(Dict[str, Any], response.json()))"
 
 
 @dataclass

openapi_python_client/templates/async_endpoint_module.pyi

@@ -1,5 +1,5 @@
 from dataclasses import asdict
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, cast
 
 import httpx
 
@@ -65,8 +65,8 @@ async def {{ endpoint.name | snakecase }}(
     {% endfor %}
     {% endif %}
 
-    with httpx.AsyncClient() as client:
-        response = await client.{{ endpoint.method }}(
+    async with httpx.AsyncClient() as _client:
+        response = await _client.{{ endpoint.method }}(
             url=url,
             headers=client.get_headers(),
             {% if endpoint.form_body_reference %}

openapi_python_client/templates/endpoint_module.pyi

@@ -1,5 +1,5 @@
 from dataclasses import asdict
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, cast
 
 import httpx
 

openapi_python_client/templates/model.pyi

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from datetime import datetime
-from typing import Dict, List, Optional, cast
+from typing import Any, Dict, List, Optional, cast
 
 {% for relative in schema.relative_imports %}
 {{ relative }}
@@ -16,7 +16,7 @@ class {{ schema.reference.class_name }}:
     {{ property.to_string() }}
     {% endfor %}
 
-    def to_dict(self) -> Dict:
+    def to_dict(self) -> Dict[str, Any]:
         return {
             {% for property in schema.required_properties %}
             "{{ property.name }}": self.{{ property.transform() }},
@@ -27,7 +27,7 @@ class {{ schema.reference.class_name }}:
         }
 
     @staticmethod
-    def from_dict(d: Dict) -> {{ schema.reference.class_name }}:
+    def from_dict(d: Dict[str, Any]) -> {{ schema.reference.class_name }}:
         {% for property in schema.required_properties + schema.optional_properties %}
 
         {% if property.constructor_template %}

poetry.lock

@@ -2,6 +2,7 @@
 name = "openapi-python-client"
 version = "0.2.1"
 description = "Generate modern Python clients from OpenAPI"
+repository = "https://github.com./triaxtec/openapi-python-client"
 
 authors = [
     "Dylan Anthony <[email protected]>",
@@ -36,7 +37,7 @@ mypy = ">=0.761"
 taskipy = "^1.1.3"
 safety = "^1.8.5"
 pytest-cov = "^2.8.1"
-fastapi = "^0.52.0"
+fastapi = "^0.54.1"
 
 [tool.taskipy.tasks]
 check = "isort --recursive --apply && black . && safety check && mypy openapi_python_client"

pyproject.toml

@@ -1,5 +1,5 @@
 from dataclasses import asdict
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, cast
 
 import httpx
 
@@ -19,6 +19,6 @@ def ping_ping_get(
     response = httpx.get(url=url, headers=client.get_headers(),)
 
     if response.status_code == 200:
-        return ABCResponse.from_dict(response.json())
+        return ABCResponse.from_dict(cast(Dict[str, Any], response.json()))
     else:
         raise ApiResponseError(response=response)

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

@@ -1,5 +1,5 @@
 from dataclasses import asdict
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, cast
 
 import httpx
 
@@ -25,8 +25,8 @@ def get_list_tests__get(
     response = httpx.get(url=url, headers=client.get_headers(), params=params,)
 
     if response.status_code == 200:
-        return [AModel.from_dict(item) for item in response.json()]
+        return [AModel.from_dict(item) for item in cast(List[Dict[str, Any]], response.json())]
     if response.status_code == 422:
-        return HTTPValidationError.from_dict(response.json())
+        return HTTPValidationError.from_dict(cast(Dict[str, Any], response.json()))
     else:
         raise ApiResponseError(response=response)

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

@@ -1,5 +1,5 @@
 from dataclasses import asdict
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, cast
 
 import httpx
 
@@ -16,10 +16,10 @@ async def ping_ping_get(
     """ A quick check to see if the system is running  """
     url = f"{client.base_url}/ping"
 
-    with httpx.AsyncClient() as client:
-        response = await client.get(url=url, headers=client.get_headers(),)
+    async with httpx.AsyncClient() as _client:
+        response = await _client.get(url=url, headers=client.get_headers(),)
 
     if response.status_code == 200:
-        return ABCResponse.from_dict(response.json())
+        return ABCResponse.from_dict(cast(Dict[str, Any], response.json()))
     else:
         raise ApiResponseError(response=response)

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

@@ -1,5 +1,5 @@
 from dataclasses import asdict
-from typing import Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, cast
 
 import httpx
 
@@ -22,12 +22,12 @@ async def get_list_tests__get(
         "statuses": statuses,
     }
 
-    with httpx.AsyncClient() as client:
-        response = await client.get(url=url, headers=client.get_headers(), params=params,)
+    async with httpx.AsyncClient() as _client:
+        response = await _client.get(url=url, headers=client.get_headers(), params=params,)
 
     if response.status_code == 200:
-        return [AModel.from_dict(item) for item in response.json()]
+        return [AModel.from_dict(item) for item in cast(List[Dict[str, Any]], response.json())]
     if response.status_code == 422:
-        return HTTPValidationError.from_dict(response.json())
+        return HTTPValidationError.from_dict(cast(Dict[str, Any], response.json()))
     else:
         raise ApiResponseError(response=response)

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

@@ -2,7 +2,7 @@
 
 from dataclasses import dataclass
 from datetime import datetime
-from typing import Dict, List, Optional, cast
+from typing import Any, Dict, List, Optional, cast
 
 from .a_list_of_enums import AListOfEnums
 from .an_enum_value import AnEnumValue
@@ -18,7 +18,7 @@ class AModel:
     a_list_of_strings: List[str]
     a_list_of_objects: List[OtherModel]
 
-    def to_dict(self) -> Dict:
+    def to_dict(self) -> Dict[str, Any]:
         return {
             "an_enum_value": self.an_enum_value.value,
             "a_list_of_enums": self.a_list_of_enums,
@@ -27,9 +27,9 @@ def to_dict(self) -> Dict:
         }
 
     @staticmethod
-    def from_dict(d: Dict) -> AModel:
+    def from_dict(d: Dict[str, Any]) -> AModel:
 
-        an_enum_value = AnEnumValue(d["an_enum_value"]) if "an_enum_value" in d else None
+        an_enum_value = AnEnumValue(d["an_enum_value"])
 
         a_list_of_enums = []
         for a_list_of_enums_item in d.get("a_list_of_enums", []):