Renderer Fixes (see desc) (#17)

* Fix TODOs

* Fix README example

* Fix use of “pass”

* nicer code

* Nicer sort objects code

* Nicer handling of fields rendering

* Unused code

Author: ekampf

README.md

@@ -23,7 +23,7 @@ Then go to your project folder and run `gql init`
 
 ## Quick Start
 
-`gql` works by parsing query files (`**/*.graphql` by default) into their own Python module where 
+`gql` works by parsing query files (`**/*.graphql` by default) into their own Python module where
 an class, named after the operation defined in the file, allows you to make that query and get a typed
 response.
 
@@ -53,18 +53,17 @@ from gql.clients import Client, AsyncIOClient
 class GetFilm:
     @dataclass_json
     @dataclass
-    class GetFilmData():
+    class GetFilmData:
         @dataclass_json
         @dataclass
-        class Film():
-            pass
+        class Film:
             title: str
             director: str
         film: Film = None
-    
+
     data: GetFilmData = None
     errors: Any = None
-    
+
     @classmethod
     def execute(cls, id: str, on_before_callback: Callable[[Mapping[str, str], Mapping[str, str]], None] = None) -> GetFilm:
         ...

gql/renderer_dataclasses.py

@@ -5,12 +5,6 @@
 from gql.query_parser import ParsedQuery, ParsedField, ParsedObject, ParsedEnum, ParsedOperation, ParsedVariableDefinition
 
 
-CLASS_TEMPLATE = """
-@dataclass_json
-@dataclass(frozen=True)
-"""
-
-
 class DataclassesRenderer:
 
     def __init__(self, schema: GraphQLSchema, config: Config):
@@ -42,8 +36,8 @@ def render(self, parsed_query: ParsedQuery):
             for enum in parsed_query.enums:
                 self.__render_enum(buffer, enum)
 
-        # Iterate in reverse so that operation is last
-        for obj in parsed_query.objects[::-1]:
+        sorted_objects = sorted(parsed_query.objects, key=lambda obj: 1 if isinstance(obj, ParsedOperation) else 0)
+        for obj in sorted_objects:
             if isinstance(obj, ParsedObject):
                 self.__render_object(parsed_query, buffer, obj)
             elif isinstance(obj, ParsedOperation):
@@ -73,21 +67,26 @@ def __render_datetime_field(buffer: CodeChunk):
         buffer.write('')
 
     def __render_object(self, parsed_query: ParsedQuery, buffer: CodeChunk, obj: ParsedObject):
+        class_parents = '' if not obj.parents else f'({", ".join(obj.parents)})'
+
         buffer.write('@dataclass_json')
         buffer.write('@dataclass')
-        with buffer.write_block(f'class {obj.name}({", ".join(obj.parents)}):'):
+        with buffer.write_block(f'class {obj.name}{class_parents}:'):
             # render child objects
-            if not obj.children:
-                buffer.write('pass')
-            else:
-                for child_object in obj.children:
-                    self.__render_object(parsed_query, buffer, child_object)
+            for child_object in obj.children:
+                self.__render_object(parsed_query, buffer, child_object)
 
             # render fields
             sorted_fields = sorted(obj.fields, key=lambda f: 1 if f.nullable else 0)
             for field in sorted_fields:
                 self.__render_field(parsed_query, buffer, field)
 
+            # pass if not children or fields
+            if not (obj.children or obj.fields):
+                buffer.write('pass')
+
+        buffer.write('')
+
     def __render_operation(self, parsed_query: ParsedQuery, buffer: CodeChunk, parsed_op: ParsedOperation):
         buffer.write('@dataclass_json')
         buffer.write('@dataclass')
@@ -122,6 +121,8 @@ def __render_operation(self, parsed_query: ParsedQuery, buffer: CodeChunk, parse
                 buffer.write('response_text = client.call(cls.__QUERY__, variables=variables, on_before_callback=on_before_callback)')
                 buffer.write('return cls.from_json(response_text)')
 
+            buffer.write('')
+
             buffer.write('@classmethod')
             with buffer.write_block(f'async def execute_async(cls, {vars_args} on_before_callback: Callable[[Mapping[str, str], Mapping[str, str]], None] = None):'):
                 buffer.write(f'client = AsyncIOClient(\'{self.config.endpoint}\')')
@@ -143,18 +144,20 @@ def __render_variable_definition(var: ParsedVariableDefinition):
     def __render_field(parsed_query: ParsedQuery, buffer: CodeChunk, field: ParsedField):
         enum_names = [e.name for e in parsed_query.enums]
         is_enum = field.type in enum_names
+        suffix = ''
+        field_type = field.type
+
         if is_enum:
-            buffer.write(f'{field.name}: {field.type} = enum_field({field.type})')
-            return
+            suffix = f'= enum_field({field.type})'
 
         if field.type == 'DateTime':
-            buffer.write(f'{field.name}: datetime = DATETIME_FIELD')
-            return
+            suffix = '= DATETIME_FIELD'
+            field_type = 'datetime'
 
         if field.nullable:
-            buffer.write(f'{field.name}: {field.type} = {field.default_value}')
-        else:
-            buffer.write(f'{field.name}: {field.type}')
+            suffix = f'= {field.default_value}'
+
+        buffer.write(f'{field.name}: {field_type} {suffix}')
 
     @staticmethod
     def __render_enum(buffer: CodeChunk, enum: ParsedEnum):

tests/test_renderer_dataclasses.py

@@ -1,9 +1,14 @@
 import pytest
 from datetime import datetime
-from dataclasses import field
+
+from graphql import GraphQLEnumType, GraphQLEnumValue, GraphQLField, GraphQLNonNull, GraphQLString, GraphQLInt, \
+    GraphQLArgument, GraphQLSchema, GraphQLObjectType
+
 from gql.config import Config
+from gql.query_parser import QueryParser
 from gql.renderer_dataclasses import DataclassesRenderer
 
+
 @pytest.fixture
 def swapi_dataclass_renderer(swapi_schema):
     return DataclassesRenderer(swapi_schema, Config(schema='schemaurl', endpoint='schemaurl', documents=''))
@@ -162,6 +167,54 @@ def test_simple_query_with_complex_fragment(swapi_parser, swapi_dataclass_render
     assert data.luke.home.name == 'Arakis'
 
 
+def test_simple_query_with_complex_fragments(swapi_parser, swapi_dataclass_renderer, module_compiler):
+    query = """
+        fragment PlanetFields on Planet {
+          name
+          population
+          terrains
+        }
+
+        fragment CharacterFields on Person {
+          name
+          home: homeworld {
+            ...PlanetFields
+          }
+        }
+
+        query GetPerson {
+          luke: character(id: "luke") {
+            ...CharacterFields
+          }
+        }
+    """
+
+    parsed = swapi_parser.parse(query)
+    rendered = swapi_dataclass_renderer.render(parsed)
+
+    m = module_compiler(rendered)
+    response = m.GetPerson.from_json("""
+    {
+        "data": {
+            "luke": {
+                "name": "Luke Skywalker",
+                "home": {
+                    "name": "Arakis",
+                    "population": "1,000,000",
+                    "terrains": ["Desert"]
+                }
+            }
+        }
+    }
+    """)
+
+    assert response
+
+    data = response.data
+    assert data.luke.name == 'Luke Skywalker'
+    assert data.luke.home.name == 'Arakis'
+
+
 def test_simple_query_with_complex_inline_fragment(swapi_parser, swapi_dataclass_renderer, module_compiler):
     query = """
         query GetPerson {
@@ -246,6 +299,99 @@ def test_simple_query_with_enums(github_parser, github_dataclass_renderer, modul
     assert node.authorAssociation == m.CommentAuthorAssociation.FIRST_TIMER
 
 
+def test_simple_query_with_enums_default_value(module_compiler):
+    """
+        enum LengthUnit {
+          METER
+          KM
+        }
+
+        type Starship {
+          id: ID!
+          name: String!
+          length(unit: LengthUnit = METER): Float
+        }
+
+        type Query {
+            ship(id: String!): Starship
+        }
+    """
+
+    length_unit_enum = GraphQLEnumType(
+        'LengthUnit',
+        {
+            'METER': GraphQLEnumValue('METER'),
+            'KM': GraphQLEnumValue('KM'),
+        },
+        description='One of the films in the Star Wars Trilogy',
+    )
+
+    starship_type = GraphQLObjectType(
+        'Starship',
+        lambda: {
+            'id': GraphQLField(GraphQLNonNull(GraphQLString), description='The id of the ship.'),
+            'name': GraphQLField(GraphQLString, description='The name of the ship.'),
+            'length': GraphQLField(
+                GraphQLInt,
+                args={
+                    'unit': GraphQLArgument(
+                        GraphQLNonNull(length_unit_enum), default_value='METER', description='id of the droid'
+                    )
+                }
+            )
+        }
+    )
+
+    query_type = GraphQLObjectType(
+        'Query',
+        lambda: {
+            'ship': GraphQLField(
+                starship_type,
+                args={
+                    'id': GraphQLArgument(GraphQLNonNull(GraphQLString), description='id of the ship')
+                },
+            )
+        }
+    )
+
+    schema = GraphQLSchema(query_type, types=[length_unit_enum, starship_type])
+
+    query = """
+        query GetStarship {
+            ship(id: "Enterprise") {
+                id
+                name
+                length(unit: METER)
+            }
+        }
+    """
+    query_parser = QueryParser(schema)
+    query_renderer = DataclassesRenderer(schema, Config(schema='schemaurl', endpoint='schemaurl', documents=''))
+    parsed = query_parser.parse(query)
+    rendered = query_renderer.render(parsed)
+
+    m = module_compiler(rendered)
+    response = m.GetStarship.from_json("""
+        {
+            "data": {
+                "ship": {
+                    "id": "Enterprise",
+                    "name": "Enterprise",
+                    "length": 100
+                }
+            }
+        }
+    """)
+
+    assert response
+
+    ship = response.data.ship
+    assert ship
+    assert ship.id == 'Enterprise'
+    assert ship.name == 'Enterprise'
+    assert ship.length == 100
+
+
 def test_simple_query_with_datetime(swapi_dataclass_renderer, swapi_parser, module_compiler, mocker):
     query = """
         query GetFilm($id: ID!) {