handle reserved python builtin type names as graphql names (#403)

Author: DamianCzajkowski

ariadne_codegen/utils.py

@@ -1,4 +1,5 @@
 import ast
+import builtins
 import re
 from keyword import iskeyword
 from textwrap import indent
@@ -17,6 +18,14 @@
 ]
 
 
+def _is_builtin_type_name(name: str) -> bool:
+    try:
+        value = getattr(builtins, name)
+    except AttributeError:
+        return False
+    return isinstance(value, type)
+
+
 def ast_to_str(
     ast_obj: ast.AST,
     remove_unused_imports: bool = True,
@@ -124,7 +133,7 @@ def process_name(
     processed_name = name
     if convert_to_snake_case:
         processed_name = str_to_snake_case(processed_name)
-    if iskeyword(processed_name):
+    if iskeyword(processed_name) or _is_builtin_type_name(processed_name):
         processed_name += "_"
     if (
         handle_pydantic_resrved_field_names

tests/client_generators/input_types_generator/test_names.py

@@ -197,3 +197,34 @@ def test_generate_returns_module_with_valid_field_names():
         "underscore_named_field_",
         "schema_",
     }
+
+
+def test_generate_returns_module_with_builtin_field_names():
+    schema = """
+    input BuiltinsInput {
+        list: [Int!]
+        dict: String
+        set: Boolean
+        tuple: Float
+        int: Int
+        str: String
+        bool: Boolean
+    }
+    """
+
+    generator = InputTypesGenerator(schema=build_ast_schema(parse(schema)))
+
+    module = generator.generate()
+
+    parsed = ast.parse(ast_to_str(module))
+    class_def = get_class_def(parsed)
+    field_names = get_assignment_target_names(class_def)
+    assert field_names == {
+        "list_",
+        "dict_",
+        "set_",
+        "tuple_",
+        "int_",
+        "str_",
+        "bool_",
+    }

tests/main/clients/example/expected_client/__init__.py

@@ -13,6 +13,7 @@
 from .fragments import BasicUser, UserPersonalData
 from .get_users_counter import GetUsersCounter
 from .input_types import (
+    BuiltinsInput,
     LocationInput,
     NotificationsPreferencesInput,
     UserCreateInput,
@@ -26,6 +27,7 @@
     "AsyncBaseClient",
     "BaseModel",
     "BasicUser",
+    "BuiltinsInput",
     "Client",
     "Color",
     "CreateUser",

tests/main/clients/example/expected_client/input_types.py

@@ -48,5 +48,15 @@ class NotificationsPreferencesInput(BaseModel):
     title: str
 
 
+class BuiltinsInput(BaseModel):
+    list_: Optional[list[int]] = Field(alias="list", default=None)
+    dict_: Optional[str] = Field(alias="dict", default=None)
+    set_: Optional[bool] = Field(alias="set", default=None)
+    tuple_: Optional[float] = Field(alias="tuple", default=None)
+    int_: Optional[int] = Field(alias="int", default=None)
+    str_: Optional[str] = Field(alias="str", default=None)
+    bool_: Optional[bool] = Field(alias="bool", default=None)
+
+
 UserCreateInput.model_rebuild()
 UserPreferencesInput.model_rebuild()

tests/main/clients/example/schema.graphql

@@ -75,3 +75,13 @@ input NotificationsPreferencesInput {
   receiveSms: Boolean!
   title: String!
 }
+
+input BuiltinsInput {
+  list: [Int!]
+  dict: String
+  set: Boolean
+  tuple: Float
+  int: Int
+  str: String
+  bool: Boolean
+}