Merge branch 'jhnnsrs:master' into master

.vscode/settings.json

@@ -27,7 +27,6 @@
   },
 
   "files.exclude": {
-    "**/venv": true,
     "**/__pycache__": true,
     "**/.pytest_cache": true
   },

.vscode/tasks.json

@@ -7,12 +7,12 @@
     {
       "label": "Patch",
       "type": "shell",
-      "command": "source venv/bin/activate && poetry version patch && poetry build "
+      "command": " poetry version patch && poetry build "
     },
     {
       "label": "Publish",
       "type": "shell",
-      "command": "source venv/bin/activate && poetry publish"
+      "command": " poetry publish"
     },
     {
       "type": "shell",

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Johannes Roos <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyproject.toml

@@ -1,9 +1,9 @@
 [tool.poetry]
 name = "turms"
-version = "0.4.2"
+version = "0.5.0"
 description = "graphql-codegen powered by pydantic"
 authors = ["jhnnsrs <[email protected]>"]
-license = "CC BY-NC 3.0"
+license = "MIT"
 readme = "README.md"
 packages = [{ include = "turms" }]
 homepage = "https://jhnnsrs.github.io/turms"

tests/test_optional_input_fields.py

@@ -0,0 +1,47 @@
+import ast
+from graphql import parse, build_ast_schema
+from turms.config import GeneratorConfig
+from turms.run import generate_ast
+from turms.stylers.snake_case import SnakeCaseStyler
+from turms.plugins.inputs import InputsPlugin
+from turms.plugins.objects import ObjectsPlugin
+from .utils import unit_test_with
+
+inputs = '''
+input X {
+    mandatory: String!
+    otherMandatory: String!
+    optional: String
+    otherOptional: String
+}
+'''
+
+
+expected = '''class X(BaseModel):
+    mandatory: str
+    other_mandatory: str = Field(alias='otherMandatory')
+    optional: Optional[str] = None
+    other_optional: Optional[str] = Field(alias='otherOptional', default=None)'''
+
+
+def test_generates_schema(snapshot):
+    config = GeneratorConfig()
+
+    schema = build_ast_schema(parse(inputs))
+
+    generated_ast = generate_ast(
+        config,
+        schema,
+        stylers=[SnakeCaseStyler()],
+        plugins=[
+            InputsPlugin(),
+            ObjectsPlugin(),
+        ],
+    )
+
+    unit_test_with(generated_ast, '')
+
+    without_imports = [node for node in generated_ast if not isinstance(node, ast.ImportFrom)]
+    md = ast.Module(body=without_imports, type_ignores=[])
+    generated = ast.unparse(ast.fix_missing_locations(md))
+    assert generated == expected

turms/cli/main.py

@@ -38,7 +38,7 @@ class TurmsOptions(str, Enum):
 
 welcome = """
 Welcome to Turms! Turms is a GraphQL code generator that generates code from your GraphQL schema and documents. For more information, visit
-https://gihub.com/jhnnsrs/turms
+https://github.com/jhnnsrs/turms
 """
 
 
@@ -81,7 +81,6 @@ def generate_projects(projects, title="Turms"):
 
     with Live(panel, screen=False) as live:
         for key, project in projects.items():
-
             project_tree = Tree(f"{key}", style="not bold white")
             tree.add(project_tree)
             live.update(panel)
@@ -172,7 +171,6 @@ def watch_projects(projects, title="Turms"):  # pragma: no cover
     )
 
     with Live(panel, screen=False) as live:
-
         tree.renderable = f"Watching {project.documents}..."
         live.update(panel)
 
@@ -201,7 +199,6 @@ def watch_projects(projects, title="Turms"):  # pragma: no cover
                 live.update(panel)
 
             except Exception as e:
-
                 tree.renderable = f"[red] {str(e)} [/],"
                 tree.border_style = "not bold red"
                 tree.style = "not bold red"
@@ -216,7 +213,8 @@ def cli(ctx):
 
     Welcome to Turms! Turms is a GraphQL code generator that generates code from your GraphQL schema and documents.
 
-    For more information, visit [link=https://gihub.com/jhnnsrs/turms] https://gihub.com/jhnnsrs/turms [/link]"""
+    For more information, visit [link=https://github.com/jhnnsrs/turms] https://github.com/jhnnsrs/turms [/link]
+    """
 
 
 @cli.command()

turms/helpers.py

@@ -107,6 +107,12 @@ def load_introspection_from_url(
         raise GenerationError(
             f"Failed to fetch schema from {url} Graphql error: {x['errors']}"
         )
+
+    if "data" not in x:
+        raise GenerationError(f"Failed to fetch schema from {url}. Did not receive data attripute: {x}")
+
+
+
     return x["data"]
 
 

turms/plugins/enums.py

@@ -21,7 +21,7 @@ class EnumsPluginConfig(PluginConfig):
     type = "turms.plugins.enums.EnumsPlugin"
     skip_underscore: bool = False
     skip_double_underscore: bool = True
-    skip_unreferenced: bool = False
+    skip_unreferenced: bool = True
     prepend: str = ""
     append: str = ""
 
@@ -35,7 +35,6 @@ def generate_enums(
     plugin_config: EnumsPluginConfig,
     registry: ClassRegistry,
 ):
-
     tree = []
 
     enum_types = {
@@ -44,15 +43,14 @@ def generate_enums(
         if isinstance(value, GraphQLEnumType)
     }
 
-    if plugin_config.skip_unreferenced:
+    if plugin_config.skip_unreferenced and config.documents:
         ref_registry = create_reference_registry_from_documents(
             client_schema, parse_documents(client_schema, config.documents)
         )
     else:
         ref_registry = None
 
     for key, type in enum_types.items():
-
         if ref_registry and key not in ref_registry.enums:
             continue
 
@@ -71,7 +69,6 @@ def generate_enums(
         )
 
         for value_key, value in type.values.items():
-
             if isinstance(value.value, str):
                 servalue = value.value
             else:
@@ -129,7 +126,6 @@ def generate_ast(
         config: GeneratorConfig,
         registry: ClassRegistry,
     ) -> List[ast.AST]:
-
         registry.register_import("enum.Enum")
 
         return generate_enums(client_schema, config, self.config, registry)

turms/plugins/funcs.py

@@ -218,13 +218,24 @@ def generate_parameters(
 
     for kwarg in extra_kwargs:
         registry.register_import(kwarg.type)
+
+        annotation = ast.Name(
+            id=kwarg.type.split(".")[-1],
+            ctx=ast.Load(),
+        )
+
+        if kwarg.default is None:
+            # if we set the default to None, we need to make the annotation optional
+            # complies with PEP 484
+            annotation = ast.Subscript(
+                value=ast.Name(id="Optional", ctx=ast.Load()),
+                slice=annotation,
+            )
+
         kw_args.append(
             ast.arg(
                 arg=kwarg.key,
-                annotation=ast.Name(
-                    id=kwarg.type.split(".")[-1],
-                    ctx=ast.Load(),
-                ),
+                annotation=annotation,
             )
         )
         kw_values.append(ast.Constant(value=kwarg.default))
@@ -503,6 +514,12 @@ def genereate_async_call(
             )
         )
     else:
+        correct_attr = (
+            o.selection_set.selections[0].alias.value
+            if o.selection_set.selections[0].alias
+            else o.selection_set.selections[0].name.value
+        )
+
         return ast.Return(
             value=ast.Attribute(
                 value=ast.Await(
@@ -523,9 +540,7 @@ def genereate_async_call(
                         ],
                     )
                 ),
-                attr=registry.generate_node_name(
-                    o.selection_set.selections[0].name.value
-                ),
+                attr=registry.generate_node_name(correct_attr),
                 ctx=ast.Load(),
             )
         )
@@ -559,6 +574,12 @@ def genereate_sync_call(
             )
         )
     else:
+        correct_attr = (
+            o.selection_set.selections[0].alias.value
+            if o.selection_set.selections[0].alias
+            else o.selection_set.selections[0].name.value
+        )
+
         return ast.Return(
             value=ast.Attribute(
                 value=ast.Call(
@@ -577,9 +598,7 @@ def genereate_sync_call(
                         generate_variable_dict(o, plugin_config, registry),
                     ],
                 ),
-                attr=registry.generate_node_name(
-                    o.selection_set.selections[0].name.value
-                ),
+                attr=registry.generate_node_name(correct_attr),
                 ctx=ast.Load(),
             )
         )
@@ -618,6 +637,12 @@ def genereate_async_iterator(
             orelse=[],
         )
     else:
+        correct_attr = (
+            o.selection_set.selections[0].alias.value
+            if o.selection_set.selections[0].alias
+            else o.selection_set.selections[0].name.value
+        )
+
         return ast.AsyncFor(
             target=ast.Name(id="event", ctx=ast.Store()),
             iter=ast.Call(
@@ -640,9 +665,7 @@ def genereate_async_iterator(
                         value=ast.Attribute(
                             value=ast.Name(id="event", ctx=ast.Load()),
                             ctx=ast.Load(),
-                            attr=registry.generate_node_name(
-                                o.selection_set.selections[0].name.value
-                            ),
+                            attr=registry.generate_node_name(correct_attr),
                         )
                     )
                 ),
@@ -684,6 +707,12 @@ def genereate_sync_iterator(
             orelse=[],
         )
     else:
+        correct_attr = (
+            o.selection_set.selections[0].alias.value
+            if o.selection_set.selections[0].alias
+            else o.selection_set.selections[0].name.value
+        )
+
         return ast.For(
             target=ast.Name(id="event", ctx=ast.Store()),
             iter=ast.Call(
@@ -706,9 +735,7 @@ def genereate_sync_iterator(
                         value=ast.Attribute(
                             value=ast.Name(id="event", ctx=ast.Load()),
                             ctx=ast.Load(),
-                            attr=registry.generate_node_name(
-                                o.selection_set.selections[0].name.value
-                            ),
+                            attr=registry.generate_node_name(correct_attr),
                         )
                     )
                 ),