Add return types in generated API client code

Author: yugokato

.gitignore

@@ -162,7 +162,8 @@ cython_debug/
 .DS_Store
 
 # terminalizer
-images/*.yml
+images/*
+!images/*.gif
 
 # Unofficial tests
 tests/_*/**

README.md

@@ -326,15 +326,15 @@ from .api.users import UsersAPI
 class DemoAppAPIClient(OpenAPIClient):
     """API client for demo_app"""
 
-    def __init__(self, env: str = "dev"):
+    def __init__(self, env: str = "dev") -> None:
         super().__init__("demo_app", env=env, doc="openapi.json")
 
     @cached_property
-    def Auth(self):
+    def Auth(self) -> AuthAPI:
         return AuthAPI(self)
 
     @cached_property
-    def Users(self):
+    def Users(self) -> UsersAPI:
         return UsersAPI(self)
 ```
 

images/generate.gif

@@ -16,13 +16,13 @@ class DemoAppAPIClient(OpenAPIClient):
     >>> token = r.response["token"]
     """
 
-    def __init__(self, env: str = "dev"):
+    def __init__(self, env: str = "dev") -> None:
         super().__init__("demo_app", env=env, doc="openapi.json")
 
     @cached_property
-    def Auth(self):
+    def Auth(self) -> AuthAPI:
         return AuthAPI(self)
 
     @cached_property
-    def Users(self):
+    def Users(self) -> UsersAPI:
         return UsersAPI(self)

src/openapi_test_client/clients/demo_app/demo_app_client.py

@@ -610,7 +610,7 @@ def generate_api_client(temp_api_client: OpenAPIClient, show_generated_code: boo
     api_client_code = (
         f"class {api_client_class_name}({OpenAPIClient.__name__}):\n"
         f'{TAB}"""API client for {app_name}"""\n\n'
-        f'{TAB}def __init__(self, env: str = "dev"):\n'
+        f'{TAB}def __init__(self, env: str = "dev") -> None:\n'
         f'{TAB}{TAB}super().__init__("{app_name}", env=env, doc="{temp_api_client.api_spec.doc_path}")\n\n'
     )
 
@@ -623,7 +623,9 @@ def generate_api_client(temp_api_client: OpenAPIClient, show_generated_code: boo
         imports_code += f"from .{API_CLASS_DIR_NAME}.{Path(mod.__file__).stem} import {api_class.__name__}\n"
         property_name = api_class.__name__.removesuffix("API")
         api_client_code += (
-            f"{TAB}@cached_property\n{TAB}def {property_name}(self):\n{TAB}{TAB}return {api_class.__name__}(self)\n\n"
+            f"{TAB}@cached_property\n"
+            f"{TAB}def {property_name}(self) -> {api_class.__name__}:\n"
+            f"{TAB}{TAB}return {api_class.__name__}(self)\n\n"
         )
 
     code = format_code(imports_code + api_client_code)