Ran checks and addressed some comments for PR #32

Author: dbanty

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]
@@ -236,9 +236,7 @@ def _iterate_properties() -> Generator[Property, None, None]:
 
     @staticmethod
     def from_dict(d: Dict[str, Dict[str, Any]], /) -> OpenAPI:
-        """ Create an OpenAPI from dict 
-        :rtype: object
-        """
+        """ Create an OpenAPI from dict """
         schemas = Schema.dict(d["components"]["schemas"])
         endpoint_collections_by_tag = EndpointCollection.from_dict(d["paths"])
         enums = OpenAPI._check_enums(schemas.values(), endpoint_collections_by_tag.values())

openapi_python_client/templates/async_endpoint_module.pyi

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

openapi_python_client/templates/endpoint_module.pyi

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

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"
@@ -38,7 +38,8 @@ def test_end_to_end(capsys):
     _compare_directories(gm_path, output_path)
 
     import mypy.api
+
     out, err, status = mypy.api.run([str(output_path), "--strict"])
-    assert status == 0, f"Hello Type checking client failed: {err}"
+    assert status == 0, f"Type checking client failed: {err}"
 
     shutil.rmtree(output_path)

tests/test_openapi_parser/test_properties.py

@@ -167,21 +167,15 @@ 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"])'
-        )
+        assert enum_property.constructor_from_dict("my_dict") == 'MyTestEnum(my_dict["test_enum"])'
 
-        enum_property = EnumProperty(name="test_enum", required=False,
-                                     default=None, values={})
+        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'
+            enum_property.constructor_from_dict("my_dict")
+            == 'MyTestEnum(my_dict["test_enum"]) if "test_enum" in my_dict else None'
         )
 
-
-
     def test_values_from_list(self):
         from openapi_python_client.openapi_parser.properties import EnumProperty
 
@@ -402,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[Any, Any]"),],
+        [
+            ("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()

tests/test_openapi_parser/test_responses.py

@@ -32,7 +32,10 @@ def test_constructor(self, mocker):
 
         r = ListRefResponse(200, reference=mocker.MagicMock(class_name="SuperCoolClass"))
 
-        assert r.constructor() == "[SuperCoolClass.from_dict(item) for item in cast(List[Dict[str, Any]], response.json())]"
+        assert (
+            r.constructor()
+            == "[SuperCoolClass.from_dict(item) for item in cast(List[Dict[str, Any]], response.json())]"
+        )
 
 
 class TestRefResponse: