🐛 Don't add types generated from error response declarations to functions' return types.

Author: rafalkrupinski

src/lapidary/render/model/openapi_conv.py

@@ -246,7 +246,11 @@ def process_operation(
         security = self.process_security(value.security, stack.push('security'))
 
         return_types = set()
-        for response in responses.values():
+        for status_code, response in responses.items():
+            # Don't include error responses in the return type
+            if status_code[0] in ('4', '5'):
+                continue
+
             body_type = type_hint.union_of(*response.content.values())
             return_types.add(type_hint.tuple_of(body_type, response.headers_type))
 

tests/e2e/expected/petstore/gen/test_petstore/client.py

@@ -46,7 +46,7 @@ async def addPet(
             }),
         ],
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[test_petstore.components.schemas.Pet.schema.Pet, None]],
+        tuple[test_petstore.components.schemas.Pet.schema.Pet, None],
         Responses({
             '200': Response(
                 Body({
@@ -71,7 +71,7 @@ async def updatePet(
             }),
         ],
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[test_petstore.components.schemas.Pet.schema.Pet, None]],
+        tuple[test_petstore.components.schemas.Pet.schema.Pet, None],
         Responses({
             '200': Response(
                 Body({
@@ -100,7 +100,7 @@ async def findPetsByStatus(
         *,
         status_q: typing.Annotated[typing.Union[None, str], Query('status', style=FormExplode,)] = None,
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[list[test_petstore.components.schemas.Pet.schema.Pet], None]],
+        tuple[list[test_petstore.components.schemas.Pet.schema.Pet], None],
         Responses({
             '200': Response(
                 Body({
@@ -121,7 +121,7 @@ async def findPetsByTags(
         *,
         tags_q: typing.Annotated[typing.Union[None, list[str]], Query('tags', style=FormExplode,)] = None,
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[list[test_petstore.components.schemas.Pet.schema.Pet], None]],
+        tuple[list[test_petstore.components.schemas.Pet.schema.Pet], None],
         Responses({
             '200': Response(
                 Body({
@@ -142,7 +142,7 @@ async def getPetById(
         *,
         petId_p: typing.Annotated[int, Path('petId', )],
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[test_petstore.components.schemas.Pet.schema.Pet, None]],
+        tuple[test_petstore.components.schemas.Pet.schema.Pet, None],
         Responses({
             '200': Response(
                 Body({
@@ -169,7 +169,7 @@ async def updatePetWithForm(
         name_q: typing.Annotated[typing.Union[None, str], Query('name', )] = None,
         status_q: typing.Annotated[typing.Union[None, str], Query('status', )] = None,
     ) -> typing.Annotated[
-        tuple[None, None],
+        None,
         Responses({
             '405': Response(
                 Body({
@@ -186,7 +186,7 @@ async def deletePet(
         petId_p: typing.Annotated[int, Path('petId', )],
         meta: typing.Annotated[typing.Union[None, test_petstore.paths.u_lpetu_lu_1zpetIdu_21.delete.parameters.meta.RequestMetadata], Metadata()] = None,
     ) -> typing.Annotated[
-        tuple[None, None],
+        None,
         Responses({
             '400': Response(
                 Body({
@@ -239,7 +239,7 @@ async def placeOrder(
             }),
         ],
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[test_petstore.components.schemas.Order.schema.Order, None]],
+        tuple[test_petstore.components.schemas.Order.schema.Order, None],
         Responses({
             '200': Response(
                 Body({
@@ -260,7 +260,7 @@ async def getOrderById(
         *,
         orderId_p: typing.Annotated[int, Path('orderId', )],
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[test_petstore.components.schemas.Order.schema.Order, None]],
+        tuple[test_petstore.components.schemas.Order.schema.Order, None],
         Responses({
             '200': Response(
                 Body({
@@ -285,7 +285,7 @@ async def deleteOrder(
         *,
         orderId_p: typing.Annotated[int, Path('orderId', )],
     ) -> typing.Annotated[
-        tuple[None, None],
+        None,
         Responses({
             '400': Response(
                 Body({
@@ -352,7 +352,7 @@ async def loginUser(
         username_q: typing.Annotated[typing.Union[None, str], Query('username', )] = None,
         password_q: typing.Annotated[typing.Union[None, str], Query('password', )] = None,
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[str, test_petstore.paths.u_luseru_llogin.get.responses.u_o00.headers.ResponseMetadata]],
+        tuple[str, test_petstore.paths.u_luseru_llogin.get.responses.u_o00.headers.ResponseMetadata],
         Responses({
             '200': Response(
                 Body({
@@ -388,7 +388,7 @@ async def getUserByName(
         *,
         username_p: typing.Annotated[str, Path('username', )],
     ) -> typing.Annotated[
-        typing.Union[tuple[None, None], tuple[test_petstore.components.schemas.User.schema.User, None]],
+        tuple[test_petstore.components.schemas.User.schema.User, None],
         Responses({
             '200': Response(
                 Body({
@@ -435,7 +435,7 @@ async def deleteUser(
         *,
         username_p: typing.Annotated[str, Path('username', )],
     ) -> typing.Annotated[
-        tuple[None, None],
+        None,
         Responses({
             '400': Response(
                 Body({