Use astor to generate code instead of astunparse

Astor generates nicer looking docstrings :-)

Author: mvantellingen

codegen/generate_schema.py

@@ -44,7 +44,7 @@ def get_module_nodes(self):
                     targets=[ast.Name(id="__all__")],
                     value=ast.List(
                         elts=[
-                            ast.Str(s=node.name, kind="str")
+                            ast.Str(s=node.name, kind=None)
                             for node in sorted(
                                 type_nodes, key=operator.attrgetter("name")
                             )
@@ -200,7 +200,7 @@ def build(self) -> typing.Optional[ast.ClassDef]:
         doc_string = (
             f"Marshmallow schema for :class:`commercetools.types.{self.resource.name}`."
         )
-        class_node.body.append(ast.Expr(value=ast.Str(s=doc_string, kind="str")))
+        class_node.body.append(ast.Expr(value=ast.Str(s=doc_string, kind=None)))
 
         # Add the field definitions
         for prop in self.resource.properties:
@@ -265,7 +265,7 @@ def build(self) -> typing.Optional[ast.ClassDef]:
                         ast.Subscript(
                             value=ast.Name(id="data"),
                             slice=ast.Index(
-                                value=ast.Str(s=d_field.attribute_name, kind="str")
+                                value=ast.Str(s=d_field.attribute_name, kind=None)
                             ),
                         )
                     ]
@@ -299,7 +299,7 @@ def _create_schema_property(self, prop):
 
         if prop.attribute_name != prop.name and not prop.name.startswith("/"):
             node.keywords.append(
-                ast.keyword(arg="data_key", value=ast.Str(s=prop.name, kind="str"))
+                ast.keyword(arg="data_key", value=ast.Str(s=prop.name, kind=None))
             )
 
         if prop.name.startswith("/"):
@@ -319,7 +319,7 @@ def _create_schema_property(self, prop):
                         arg="pattern",
                         value=ast.Call(
                             func=ast.Name(id="re.compile"),
-                            args=[ast.Str(s=prop.name[1:-1], kind="str")],
+                            args=[ast.Str(s=prop.name[1:-1], kind=None)],
                             keywords=[],
                         ),
                     ),
@@ -433,16 +433,16 @@ def _create_discriminator_field(self, type_obj):
                     arg="discriminator_field",
                     value=ast.Tuple(
                         elts=[
-                            ast.Str(s=field.name, kind="str"),
-                            ast.Str(s=field.attribute_name, kind="str"),
+                            ast.Str(s=field.name, kind=None),
+                            ast.Str(s=field.attribute_name, kind=None),
                         ]
                     ),
                 ),
                 ast.keyword(
                     arg="discriminator_schemas",
                     value=ast.Dict(
-                        keys=[ast.Str(s=v, kind="str") for v in items.keys()],
-                        values=[ast.Str(s=v, kind="str") for v in items.values()],
+                        keys=[ast.Str(s=v, kind=None) for v in items.keys()],
+                        values=[ast.Str(s=v, kind=None) for v in items.values()],
                     ),
                 ),
                 ast.keyword(arg="unknown", value=ast.Name(id="marshmallow.EXCLUDE")),
@@ -470,7 +470,7 @@ def _create_nested_field(self, type_obj):
                     arg="nested",
                     value=ast.Str(
                         s=f"commercetools.schemas.{type_obj.package_name}.{type_obj.name}Schema",
-                        kind="str",
+                        kind=None,
                     ),
                 ),
                 ast.keyword(arg="unknown", value=ast.Name(id="marshmallow.EXCLUDE")),
@@ -486,7 +486,7 @@ def _create_regex_call(self, field_name, method_name):
                 func=ast.Attribute(
                     value=ast.Subscript(
                         value=ast.Attribute(value=ast.Name(id="self"), attr="fields"),
-                        slice=ast.Index(value=ast.Str(s=field_name, kind="str")),
+                        slice=ast.Index(value=ast.Str(s=field_name, kind=None)),
                     ),
                     attr=method_name,
                 ),

codegen/generate_types.py

@@ -48,7 +48,7 @@ def get_module_nodes(self):
                     targets=[ast.Name(id="__all__")],
                     value=ast.List(
                         elts=[
-                            ast.Str(s=node.name, kind="str")
+                            ast.Str(s=node.name, kind=None)
                             for node in sorted(
                                 type_nodes, key=operator.attrgetter("name")
                             )
@@ -170,7 +170,7 @@ class FieldContainer(typing.Dict[K, V]):
         if value_type.name in BUILTIN_TYPES:
             value_node = BUILTIN_TYPES[value_type.name]
         else:
-            value_node = ast.Str(s=value_type.name, kind="str")
+            value_node = ast.Str(s=value_type.name, kind=None)
         bases = [
             ast.Subscript(
                 value=ast.Name(id="typing.Dict"),
@@ -231,7 +231,7 @@ class ChannelRoleEnum(enum.Enum):
             body=[
                 ast.Assign(
                     targets=[ast.Name(id=enum_attr(val))],
-                    value=ast.Str(s=val, kind="str"),
+                    value=ast.Str(s=val, kind=None),
                 )
                 for val in resource.enum
             ],
@@ -343,7 +343,7 @@ def build(self):
         )
         # Docstring
         doc_string = f"Corresponding marshmallow schema is :class:`commercetools.schemas.{self.resource.name}Schema`."
-        class_node.body.append(ast.Expr(value=ast.Str(s=doc_string, kind="str")))
+        class_node.body.append(ast.Expr(value=ast.Str(s=doc_string, kind=None)))
 
         # Add the properties for the attr class
         for prop in self.resource.properties:
@@ -414,13 +414,13 @@ def _get_annotation_for_property(self, prop: raml_types.Property):
         elif prop.type.name in BUILTIN_TYPES:
             annotation_type = BUILTIN_TYPES[prop.type.name]
         elif prop.type.base and prop.type.base.name == "string" and not prop.type.enum:
-            annotation_type = ast.Str(s="str", kind="str")
+            annotation_type = ast.Str(s="str", kind=None)
         else:
             if self.resource.package_name != prop.type.package_name:
                 self.generator.import_resource_typing(
                     self.resource.package_name, prop.type.package_name, prop.type.name
                 )
-            annotation_type = ast.Str(s=prop.type.name, kind="str")
+            annotation_type = ast.Str(s=prop.type.name, kind=None)
 
         # use typing.List[]. We make an hardcoded exception for
         # resources ending on PagedQueryResponse and mark that as Sequence. The
@@ -540,7 +540,7 @@ def __init__(self, id: typing.Optional[int]=None) -> None:
                         ast.keyword(
                             arg=name,
                             value=ast.Str(
-                                s=self.resource.discriminator_value, kind="str"
+                                s=self.resource.discriminator_value, kind=None,
                             ),
                         )
                     )
@@ -596,7 +596,7 @@ def __repr__(self) -> str:
                             self.resource.name,
                             ", ".join(f"{attr}=%r" for attr in self.attribute_names),
                         ),
-                        kind="str",
+                        kind=None,
                     ),
                     op=ast.Mod(),
                     right=ast.Tuple(

codegen/main.py

@@ -68,7 +68,7 @@ def generate():
 
     for name, metadata in ast_nodes.items():
         filename = os.path.join(target_path, metadata["name"] + ".py")
-        write_module(filename, metadata["ast"], new=True)
+        write_module(filename, metadata["ast"])
 
     # Generate types.py
     ast_nodes = generate_types_module(types)
@@ -91,11 +91,8 @@ def generate():
         write_module(filename, module_ast)
 
 
-def write_module(filename, ast, new=False):
-    if new:
-        content = astor.to_source(ast)
-    else:
-        content = astunparse.unparse(ast)
+def write_module(filename, ast):
+    content = astor.to_source(ast)
     with open(filename, "w") as fh:
         fh.write("# DO NOT EDIT! This file is automatically generated\n")
         fh.write(content)