Merge pull request #35 from triaxtec/feature/type-checking

Run mypy in end to end test

Author: dbanty

CHANGELOG.md

@@ -6,7 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## 0.3.0 - Unreleased
 ### Additions
-- Link to the GitHub repository from PyPI (#26) (Thanks @theY4Kman)
+- 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 @agray!
 
 ## 0.2.1 - 2020-03-22
 ### Fixes

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

@@ -167,7 +167,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]:
@@ -208,15 +211,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
 
@@ -60,8 +60,8 @@ async def {{ endpoint.name }}(
     {% 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 %}

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
 
@@ -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/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
 
@@ -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/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
 
@@ -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/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
 
@@ -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/models/a_model.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", []):

tests/test_end_to_end/golden-master/my_test_api_client/models/abc_response.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
 
 
 @dataclass
@@ -11,13 +11,13 @@ class ABCResponse:
 
     success: bool
 
-    def to_dict(self) -> Dict:
+    def to_dict(self) -> Dict[str, Any]:
         return {
             "success": self.success,
         }
 
     @staticmethod
-    def from_dict(d: Dict) -> ABCResponse:
+    def from_dict(d: Dict[str, Any]) -> ABCResponse:
 
         success = d["success"]
 

tests/test_end_to_end/golden-master/my_test_api_client/models/h_t_t_p_validation_error.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 .validation_error import ValidationError
 
@@ -13,13 +13,13 @@ class HTTPValidationError:
 
     detail: Optional[List[ValidationError]] = None
 
-    def to_dict(self) -> Dict:
+    def to_dict(self) -> Dict[str, Any]:
         return {
             "detail": self.detail if self.detail is not None else None,
         }
 
     @staticmethod
-    def from_dict(d: Dict) -> HTTPValidationError:
+    def from_dict(d: Dict[str, Any]) -> HTTPValidationError:
 
         detail = []
         for detail_item in d.get("detail", []):

tests/test_end_to_end/golden-master/my_test_api_client/models/other_model.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
 
 
 @dataclass
@@ -11,13 +11,13 @@ class OtherModel:
 
     a_value: str
 
-    def to_dict(self) -> Dict:
+    def to_dict(self) -> Dict[str, Any]:
         return {
             "a_value": self.a_value,
         }
 
     @staticmethod
-    def from_dict(d: Dict) -> OtherModel:
+    def from_dict(d: Dict[str, Any]) -> OtherModel:
 
         a_value = d["a_value"]
 

tests/test_end_to_end/golden-master/my_test_api_client/models/validation_error.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
 
 
 @dataclass
@@ -13,15 +13,15 @@ class ValidationError:
     msg: str
     type: str
 
-    def to_dict(self) -> Dict:
+    def to_dict(self) -> Dict[str, Any]:
         return {
             "loc": self.loc,
             "msg": self.msg,
             "type": self.type,
         }
 
     @staticmethod
-    def from_dict(d: Dict) -> ValidationError:
+    def from_dict(d: Dict[str, Any]) -> ValidationError:
 
         loc = d.get("loc", [])
 

tests/test_end_to_end/test_end_to_end.py

@@ -24,7 +24,7 @@ def _compare_directories(first: Path, second: Path, /):
         _compare_directories(first / sub_path, second / sub_path)
 
 
-def test_end_to_end(capsys):
+def test_end_to_end():
     runner = CliRunner()
     openapi_path = Path(__file__).parent / "fastapi" / "openapi.json"
     config_path = Path(__file__).parent / "config.yml"
@@ -36,4 +36,10 @@ def test_end_to_end(capsys):
     if result.exit_code != 0:
         raise result.exception
     _compare_directories(gm_path, output_path)
+
+    import mypy.api
+
+    out, err, status = mypy.api.run([str(output_path), "--strict"])
+    assert status == 0, f"Type checking client failed: {err}"
+
     shutil.rmtree(output_path)

tests/test_openapi_parser/test_properties.py

@@ -167,6 +167,10 @@ def test_constructor_from_dict(self, mocker):
 
         enum_property = EnumProperty(name="test_enum", required=True, default=None, values={})
 
+        assert enum_property.constructor_from_dict("my_dict") == 'MyTestEnum(my_dict["test_enum"])'
+
+        enum_property = EnumProperty(name="test_enum", required=False, default=None, values={})
+
         assert (
             enum_property.constructor_from_dict("my_dict")
             == 'MyTestEnum(my_dict["test_enum"]) if "test_enum" in my_dict else None'
@@ -392,7 +396,13 @@ def test_property_from_dict_enum_array(self, mocker):
 
     @pytest.mark.parametrize(
         "openapi_type,python_type",
-        [("string", "str"), ("number", "float"), ("integer", "int"), ("boolean", "bool"), ("object", "Dict"),],
+        [
+            ("string", "str"),
+            ("number", "float"),
+            ("integer", "int"),
+            ("boolean", "bool"),
+            ("object", "Dict[Any, Any]"),
+        ],
     )
     def test_property_from_dict_simple_array(self, mocker, openapi_type, python_type):
         name = mocker.MagicMock()