Add docstring to generated code based on schema description

Author: John Lyu

ariadne_codegen/client_generators/custom_fields.py

@@ -114,6 +114,7 @@ def _parse_object_type_definitions(
                 class_def = self._generate_class_def_body(
                     definition=graphql_type,
                     class_name=f"{graphql_type.name}{self._get_suffix(graphql_type)}",
+                    description=graphql_type.description,
                 )
                 if isinstance(graphql_type, GraphQLInterfaceType):
                     class_def.body.append(
@@ -129,14 +130,17 @@ def _generate_class_def_body(
         self,
         definition: Union[GraphQLObjectType, GraphQLInterfaceType],
         class_name: str,
+        description: Optional[str] = None,
     ) -> ast.ClassDef:
         """
         Generates the body of a class definition for a given GraphQL object
         or interface type.
         """
         base_names = [GRAPHQL_BASE_FIELD_CLASS]
         additional_fields_typing = set()
-        class_def = generate_class_def(name=class_name, base_names=base_names)
+        class_def = generate_class_def(
+            name=class_name, base_names=base_names, description=description
+        )
         for lineno, (org_name, field) in enumerate(
             self._get_combined_fields(definition).items(), start=1
         ):

ariadne_codegen/client_generators/custom_operation.py

@@ -115,6 +115,7 @@ def _generate_method(
         operation_name: str,
         operation_args,
         final_type,
+        description: Optional[str] = None,
     ) -> ast.FunctionDef:
         """Generates a method definition for a given operation."""
         (
@@ -141,6 +142,7 @@ def _generate_method(
             name=str_to_snake_case(operation_name),
             arguments=method_arguments,
             return_type=generate_name(return_type_name),
+            description=description,
             body=[
                 *arguments_body,
                 generate_return(

ariadne_codegen/client_generators/input_types.py

@@ -157,7 +157,9 @@ def _parse_input_definition(
         self, definition: GraphQLInputObjectType
     ) -> ast.ClassDef:
         class_def = generate_class_def(
-            name=definition.name, base_names=[BASE_MODEL_CLASS_NAME]
+            name=definition.name,
+            base_names=[BASE_MODEL_CLASS_NAME],
+            description=definition.description,
         )
 
         for lineno, (org_name, field) in enumerate(definition.fields.items(), start=1):

ariadne_codegen/codegen.py

@@ -111,16 +111,21 @@ def generate_class_def(
     name: str,
     base_names: Optional[List[str]] = None,
     body: Optional[List[ast.stmt]] = None,
+    description: str = "",
 ) -> ast.ClassDef:
     """Generate class definition."""
     bases = cast(
         List[ast.expr], [ast.Name(id=name) for name in base_names] if base_names else []
     )
+    body = body if body else []
+    if description:
+        docstring = ast.Expr(value=ast.Constant(value=description))
+        body.insert(0, docstring)
     params: Dict[str, Any] = {
         "name": name,
         "bases": bases,
         "keywords": [],
-        "body": body if body else [],
+        "body": body,
         "decorator_list": [],
     }
     if sys.version_info >= (3, 12):
@@ -354,10 +359,15 @@ def generate_method_definition(
     name: str,
     arguments: ast.arguments,
     return_type: Union[ast.Name, ast.Subscript],
+    description: str = "",
     body: Optional[List[ast.stmt]] = None,
     lineno: int = 1,
     decorator_list: Optional[List[ast.expr]] = None,
 ) -> ast.FunctionDef:
+    body = body if body else [ast.Pass()]
+    if description:
+        docstring = ast.Expr(value=ast.Constant(value=description))
+        body.insert(0, docstring)
     params: Dict[str, Any] = {
         "name": name,
         "args": arguments,