[graphql-pydantic-converter] Deduplication of interface response object

Author: Jozef Volak

inventory/python/docker-compose.yml

@@ -34,7 +34,7 @@ services:
       start_period: 40s
 
   converter:
-    image: frinx/graphql-pydantic-converter:0.1.0
+    image: frinx/graphql-pydantic-converter:0.1.1
     depends_on:
       inventory:
         condition: service_healthy

resource-manager/python/docker-compose.yml

@@ -29,7 +29,7 @@ services:
       retries: 5
 
   converter:
-    image: frinx/graphql-pydantic-converter:0.1.0
+    image: frinx/graphql-pydantic-converter:0.1.1
     depends_on:
       resource-manager:
         condition: service_healthy

schellar/python/docker-compose.yml

@@ -35,7 +35,7 @@ services:
       start_period: 20s
 
   converter:
-    image: frinx/graphql-pydantic-converter:0.1.0
+    image: frinx/graphql-pydantic-converter:0.1.1
     depends_on:
       schellar:
         condition: service_healthy

topology-discovery/python/docker-compose.yml

@@ -33,7 +33,7 @@ services:
       VIEWER: viewer-1,viewer-2,viewer-3
 
   converter:
-    image: frinx/graphql-pydantic-converter:0.1.0
+    image: frinx/graphql-pydantic-converter:0.1.1
     depends_on:
       topology-discovery:
         condition: service_healthy

utils/graphql-pydantic-converter/graphql_pydantic_converter/schema_converter.py

@@ -460,30 +460,38 @@ def __create_specific_response(self, payload: Type) -> None:
                 if field.name and field.type:
 
                     if field.args:
+
+                        class_name = field.name[0].upper() + field.name[1:]
+
                         self.__result += self.__class_template.substitute(
-                            name=f'{field.name[0].upper() + field.name[1:] + payload.name}Response',
+                            name=f'{class_name + payload.name}Response',
                             type='BaseModel',
                         )
 
                         self.__refs += self.__refs_template.substitute(
-                            class_name=f'{field.name[0].upper() + field.name[1:] + payload.name}Response'
+                            class_name=f'{class_name + payload.name}Response'
                         )
 
-                        self.__result += kv_template.substitute(
-                            indent=self.__INDENT,
-                            name='data',
-                            val=f'typing.Optional[{field.name[0].upper() + field.name[1:]}Data]'
-                        )
+                        if class_name not in (self.__enums + self.__interfaces):
+                            self.__result += kv_template.substitute(
+                                indent=self.__INDENT,
+                                name='data',
+                                val=f'typing.Optional[{class_name}Data]'
+                            )
+                        else:
+                            self.__result += kv_template.substitute(
+                                indent=self.__INDENT,
+                                name='data',
+                                val=f'typing.Optional[{class_name}]'
+                            )
 
                         self.__result += kv_template.substitute(
                             indent=self.__INDENT,
                             name='errors',
                             val='typing.Optional[typing.Any]'
                         )
 
-                        class_name = field.name[0].upper() + field.name[1:]
-
-                        if class_name not in self.__interfaces:
+                        if class_name not in (self.__enums + self.__interfaces):
                             self.__result += self.__class_template.substitute(
                                 name=f'{class_name}Data',
                                 type='BaseModel',

utils/graphql-pydantic-converter/pyproject.toml

@@ -19,7 +19,7 @@ packages = [{ include = "graphql_pydantic_converter" }]
 name = "graphql-pydantic-converter"
 description = "Convert pydantic schema to pydantic datamodel and build request from it"
 authors = ["Jozef Volak <[email protected]>"]
-version = '0.1.0'
+version = '0.1.1'
 readme = ["README.md", "CHANGELOG.md"]
 keywords = ["graphql", "pydantic"]
 license = "Apache 2.0"

utils/graphql-pydantic-converter/tests/model.py

@@ -166,7 +166,7 @@ class UpdateBlueprintMutation(Mutation):
     payload: UpdateBlueprintPayload
 
 
-class AddBlueprintResponse(BaseModel):
+class AddBlueprintMutationResponse(BaseModel):
     data: typing.Optional[AddBlueprintData]
     errors: typing.Optional[typing.Any]
 
@@ -175,7 +175,7 @@ class AddBlueprintData(BaseModel):
     add_blueprint: AddBlueprintPayloadPayload = Field(alias='addBlueprint')
 
 
-class DeleteBlueprintResponse(BaseModel):
+class DeleteBlueprintMutationResponse(BaseModel):
     data: typing.Optional[DeleteBlueprintData]
     errors: typing.Optional[typing.Any]
 
@@ -184,7 +184,7 @@ class DeleteBlueprintData(BaseModel):
     delete_blueprint: DeleteBlueprintPayloadPayload = Field(alias='deleteBlueprint')
 
 
-class UpdateBlueprintResponse(BaseModel):
+class UpdateBlueprintMutationResponse(BaseModel):
     data: typing.Optional[UpdateBlueprintData]
     errors: typing.Optional[typing.Any]
 
@@ -228,7 +228,7 @@ class BlueprintsQuery(Query):
     payload: BlueprintConnection
 
 
-class BlueprintsResponse(BaseModel):
+class BlueprintsQueryResponse(BaseModel):
     data: typing.Optional[BlueprintsData]
     errors: typing.Optional[typing.Any]
 
@@ -245,7 +245,7 @@ class UniconfigShellSubscription(Subscription):
     payload: Boolean
 
 
-class UniconfigShellResponse(BaseModel):
+class UniconfigShellSubscriptionResponse(BaseModel):
     data: typing.Optional[UniconfigShellData]
     errors: typing.Optional[typing.Any]
 
@@ -283,21 +283,21 @@ class UpdateBlueprintPayloadPayload(BaseModel):
 AddBlueprintMutation.update_forward_refs()
 DeleteBlueprintMutation.update_forward_refs()
 UpdateBlueprintMutation.update_forward_refs()
-AddBlueprintResponse.update_forward_refs()
+AddBlueprintMutationResponse.update_forward_refs()
 AddBlueprintData.update_forward_refs()
-DeleteBlueprintResponse.update_forward_refs()
+DeleteBlueprintMutationResponse.update_forward_refs()
 DeleteBlueprintData.update_forward_refs()
-UpdateBlueprintResponse.update_forward_refs()
+UpdateBlueprintMutationResponse.update_forward_refs()
 UpdateBlueprintData.update_forward_refs()
 GraphNodeInterface.update_forward_refs()
 GraphNodeInterfacePayload.update_forward_refs()
 PageInfo.update_forward_refs()
 PageInfoPayload.update_forward_refs()
 BlueprintsQuery.update_forward_refs()
-BlueprintsResponse.update_forward_refs()
+BlueprintsQueryResponse.update_forward_refs()
 BlueprintsData.update_forward_refs()
 UniconfigShellSubscription.update_forward_refs()
-UniconfigShellResponse.update_forward_refs()
+UniconfigShellSubscriptionResponse.update_forward_refs()
 UniconfigShellData.update_forward_refs()
 UpdateBlueprintPayload.update_forward_refs()
 UpdateBlueprintPayloadPayload.update_forward_refs()

utils/graphql-pydantic-converter/tests/test_graphql_generator.py

@@ -175,7 +175,7 @@ def test_render_input_advanced(self) -> None:
         assert reference == query_render
 
     def test_parse_response(self) -> None:
-        from model import BlueprintsResponse
+        from model import BlueprintsQueryResponse
 
         response: typing.Any = {
             'data': {
@@ -192,7 +192,7 @@ def test_parse_response(self) -> None:
             }
         }
 
-        response = BlueprintsResponse(**response)
+        response = BlueprintsQueryResponse(**response)
 
         assert 'cli_device_import' == response.data.blueprints.edges[0].node.name