@alloy-js/python 0.4.0-dev.3 → 0.4.0-dev.5

package/dist/dev/test/sourcefiles.test.js

@@ -0,0 +1,1802 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { Prose } from "@alloy-js/core";
+import { d } from "@alloy-js/core/testing";
+import { expect, it } from "vitest";
+import * as py from "../src/index.js";
+import { dataclassesModule } from "../src/index.js";
+import { toSourceText } from "./utils.js";
+
+/**
+ * toSourceText wraps the children in a SourceFile component
+ * and renders it to a string.
+ */
+it("renders an empty source file", () => {
+  const result = toSourceText([]);
+  expect(result).toRenderTo(d`
+
+
+  `);
+});
+it("correct formatting of source file", () => {
+  const result = toSourceText([_$createComponent(py.ClassDeclaration, {
+    name: "someClass",
+    get children() {
+      return _$createComponent(py.StatementList, {
+        get children() {
+          return [_$createComponent(py.FunctionDeclaration, {
+            name: "someMethod",
+            returnType: "str",
+            get children() {
+              return _$createComponent(py.StatementList, {
+                get children() {
+                  return [_$createComponent(py.VariableDeclaration, {
+                    name: "x",
+                    type: "int",
+                    get initializer() {
+                      return _$createComponent(py.Atom, {
+                        jsValue: 42
+                      }, {
+                        fileName: import.meta.url,
+                        lineNumber: 29,
+                        columnNumber: 28
+                      });
+                    }
+                  }, {
+                    fileName: import.meta.url,
+                    lineNumber: 26,
+                    columnNumber: 13
+                  }), _$createComponent(py.VariableDeclaration, {
+                    name: "y",
+                    type: "int",
+                    get initializer() {
+                      return _$createComponent(py.Atom, {
+                        jsValue: 42
+                      }, {
+                        fileName: import.meta.url,
+                        lineNumber: 34,
+                        columnNumber: 28
+                      });
+                    }
+                  }, {
+                    fileName: import.meta.url,
+                    lineNumber: 31,
+                    columnNumber: 13
+                  }), _$createComponent(py.FunctionCallExpression, {
+                    target: "foo",
+                    args: ["a", "b"]
+                  }, {
+                    fileName: import.meta.url,
+                    lineNumber: 36,
+                    columnNumber: 13
+                  }), _$createComponent(py.MemberExpression, {
+                    get children() {
+                      return [_$createComponent(py.MemberExpression.Part, {
+                        id: "a"
+                      }, {
+                        fileName: import.meta.url,
+                        lineNumber: 38,
+                        columnNumber: 15
+                      }), _$createComponent(py.MemberExpression.Part, {
+                        id: "b"
+                      }, {
+                        fileName: import.meta.url,
+                        lineNumber: 39,
+                        columnNumber: 15
+                      }), _$createComponent(py.MemberExpression.Part, {
+                        key: "special-prop"
+                      }, {
+                        fileName: import.meta.url,
+                        lineNumber: 40,
+                        columnNumber: 15
+                      })];
+                    }
+                  }, {
+                    fileName: import.meta.url,
+                    lineNumber: 37,
+                    columnNumber: 13
+                  }), _$createComponent(py.VariableDeclaration, {
+                    name: "z",
+                    type: "int",
+                    get initializer() {
+                      return _$createComponent(py.Atom, {
+                        jsValue: 42
+                      }, {
+                        fileName: import.meta.url,
+                        lineNumber: 45,
+                        columnNumber: 28
+                      });
+                    }
+                  }, {
+                    fileName: import.meta.url,
+                    lineNumber: 42,
+                    columnNumber: 13
+                  })];
+                }
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 25,
+                columnNumber: 11
+              });
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 24,
+            columnNumber: 9
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "someVar",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 52,
+                columnNumber: 24
+              });
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 49,
+            columnNumber: 9
+          }), _$createComponent(py.FunctionDeclaration, {
+            name: "someOtherMethod",
+            returnType: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 54,
+            columnNumber: 9
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "someOtherVar",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 58,
+                columnNumber: 24
+              });
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 55,
+            columnNumber: 9
+          })];
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 23,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 22,
+    columnNumber: 5
+  }), _$createComponent(py.FunctionDeclaration, {
+    name: "someFunction",
+    get children() {
+      return _$createComponent(py.StatementList, {
+        get children() {
+          return [_$createComponent(py.VariableDeclaration, {
+            name: "x",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 67,
+                columnNumber: 24
+              });
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 64,
+            columnNumber: 9
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "y",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 72,
+                columnNumber: 24
+              });
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 69,
+            columnNumber: 9
+          }), _$createComponent(py.FunctionCallExpression, {
+            target: "foo",
+            args: ["a", "b"]
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 74,
+            columnNumber: 9
+          }), _$createComponent(py.MemberExpression, {
+            get children() {
+              return [_$createComponent(py.MemberExpression.Part, {
+                id: "a"
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 76,
+                columnNumber: 11
+              }), _$createComponent(py.MemberExpression.Part, {
+                id: "b"
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 77,
+                columnNumber: 11
+              }), _$createComponent(py.MemberExpression.Part, {
+                key: "special-prop"
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 78,
+                columnNumber: 11
+              })];
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 75,
+            columnNumber: 9
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "z",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              }, {
+                fileName: import.meta.url,
+                lineNumber: 83,
+                columnNumber: 24
+              });
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 80,
+            columnNumber: 9
+          })];
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 63,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 62,
+    columnNumber: 5
+  }), _$createComponent(py.ClassDeclaration, {
+    name: "someOtherClass",
+    get children() {
+      return _$createComponent(py.StatementList, {
+        get children() {
+          return _$createComponent(py.FunctionDeclaration, {
+            name: "someMethod",
+            returnType: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 89,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 88,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 87,
+    columnNumber: 5
+  }), _$createComponent(py.MemberExpression, {
+    get children() {
+      return [_$createComponent(py.MemberExpression.Part, {
+        id: "a"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 93,
+        columnNumber: 7
+      }), _$createComponent(py.MemberExpression.Part, {
+        id: "b"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 94,
+        columnNumber: 7
+      }), _$createComponent(py.MemberExpression.Part, {
+        key: "special-prop"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 95,
+        columnNumber: 7
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 92,
+    columnNumber: 5
+  })]);
+  expect(result).toRenderTo(d`
+    class SomeClass:
+        def some_method() -> str:
+            x: int = 42
+            y: int = 42
+            foo(a, b)
+            a.b["special-prop"]
+            z: int = 42
+
+        some_var: int = 42
+        def some_other_method() -> str:
+            pass
+
+        some_other_var: int = 42
+
+
+    def some_function():
+        x: int = 42
+        y: int = 42
+        foo(a, b)
+        a.b["special-prop"]
+        z: int = 42
+
+
+    class SomeOtherClass:
+        def some_method() -> str:
+            pass
+
+
+
+    a.b["special-prop"]
+
+  `);
+});
+it("renders module documentation correctly", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "This module provides utility functions for data processing. It includes functions for validation, transformation, and analysis."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 137,
+        columnNumber: 9
+      })];
+    },
+    attributes: [{
+      name: "DEFAULT_TIMEOUT",
+      type: "int",
+      children: "Default timeout value in seconds."
+    }, {
+      name: "MAX_RETRIES",
+      type: "int",
+      children: "Maximum number of retry attempts."
+    }],
+    todo: ["Add caching functionality", "Improve error messages"],
+    style: "google"
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 135,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get children() {
+      return [_$createComponent(py.VariableDeclaration, {
+        name: "DEFAULT_TIMEOUT",
+        initializer: 30
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 161,
+        columnNumber: 7
+      }), _$createComponent(py.VariableDeclaration, {
+        name: "MAX_RETRIES",
+        initializer: 3
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 162,
+        columnNumber: 7
+      }), _$createComponent(py.FunctionDeclaration, {
+        name: "process_data",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 163,
+        columnNumber: 7
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 160,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    """
+    This module provides utility functions for data processing. It includes
+    functions for validation, transformation, and analysis.
+
+    Attributes:
+        DEFAULT_TIMEOUT (int): Default timeout value in seconds.
+
+        MAX_RETRIES (int): Maximum number of retry attempts.
+
+    Todo:
+        * Add caching functionality
+        * Improve error messages
+    """
+
+    default_timeout = 30
+
+    max_retries = 3
+
+    def process_data():
+        pass
+
+
+  `);
+});
+it("renders source file without documentation correctly", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello_world",
+        children: "print(\"Hello, World!\")"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 196,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 195,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    def hello_world():
+        print("Hello, World!")
+
+
+  `);
+});
+it("nothing before top-level definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 213,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 212,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    def hello():
+        pass
+
+
+  `);
+});
+it("nothing before non-definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        initializer: 42
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 228,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 227,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo("x = 42");
+});
+it("only doc before definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 237,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 237,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 242,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 241,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    """
+    Module description.
+    """
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("only doc before non-definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 261,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 261,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        initializer: 42
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 266,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 265,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    x = 42`);
+});
+it("only header before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    header: "#!/usr/bin/env python3",
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 281,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 280,
+    columnNumber: 5
+  });
+
+  // 2 blank lines before definition (PEP 8)
+  expect(toSourceText(content)).toRenderTo(d`
+    #!/usr/bin/env python3
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("only header before non-definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    header: "#!/usr/bin/env python3",
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        initializer: 42
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 300,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 299,
+    columnNumber: 5
+  });
+
+  // 1 blank line for non-definition
+  expect(toSourceText(content)).toRenderTo(d`
+    #!/usr/bin/env python3
+
+    x = 42`);
+});
+it("only futureImports before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 315,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 317,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 313,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    from __future__ import annotations
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("only futureImports before non-definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 336,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        initializer: 42
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 338,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 334,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    from __future__ import annotations
+
+    x = 42`);
+});
+it("only imports before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get children() {
+      return _$createComponent(py.DataclassDeclaration, {
+        name: "User",
+        get children() {
+          return _$createComponent(py.VariableDeclaration, {
+            name: "name",
+            type: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 352,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 351,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 350,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class User:
+        name: str = None
+
+
+  `);
+});
+it("only imports before non-definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        get initializer() {
+          return _$createComponent(py.Reference, {
+            get refkey() {
+              return dataclassesModule["."].dataclass;
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 375,
+            columnNumber: 22
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 373,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 372,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    from dataclasses import dataclass
+
+    x = dataclass`);
+});
+it("doc + futureImports before definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 389,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 389,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 396,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 398,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 393,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    from __future__ import annotations
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("doc + futureImports before non-definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 419,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 419,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 426,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        initializer: 42
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 428,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 423,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    from __future__ import annotations
+
+    x = 42`);
+});
+it("doc + imports before definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 444,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 444,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get children() {
+      return _$createComponent(py.DataclassDeclaration, {
+        name: "User",
+        get children() {
+          return _$createComponent(py.VariableDeclaration, {
+            name: "name",
+            type: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 450,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 449,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 448,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class User:
+        name: str = None
+
+
+  `);
+});
+it("doc + imports before non-definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 474,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 474,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        get initializer() {
+          return _$createComponent(py.Reference, {
+            get refkey() {
+              return dataclassesModule["."].dataclass;
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 481,
+            columnNumber: 22
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 479,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 478,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    from dataclasses import dataclass
+
+    x = dataclass`);
+});
+it("futureImports + imports before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 501,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.DataclassDeclaration, {
+        name: "User",
+        get children() {
+          return _$createComponent(py.VariableDeclaration, {
+            name: "name",
+            type: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 504,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 503,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 499,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    from __future__ import annotations
+
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class User:
+        name: str = None
+
+
+  `);
+});
+it("futureImports + imports before non-definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 528,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        get initializer() {
+          return _$createComponent(py.Reference, {
+            get refkey() {
+              return dataclassesModule["."].dataclass;
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 532,
+            columnNumber: 22
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 530,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 526,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    from __future__ import annotations
+
+    from dataclasses import dataclass
+
+    x = dataclass`);
+});
+it("doc + futureImports + imports before definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 548,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 548,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 555,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.DataclassDeclaration, {
+        name: "User",
+        get children() {
+          return _$createComponent(py.VariableDeclaration, {
+            name: "name",
+            type: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 558,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 557,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 552,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    from __future__ import annotations
+
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class User:
+        name: str = None
+
+
+  `);
+});
+it("doc + futureImports + imports before non-definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 584,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 584,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 591,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        get initializer() {
+          return _$createComponent(py.Reference, {
+            get refkey() {
+              return dataclassesModule["."].dataclass;
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 595,
+            columnNumber: 22
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 593,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 588,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    from __future__ import annotations
+
+    from dataclasses import dataclass
+
+    x = dataclass`);
+});
+it("only doc in file (no children)", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 615,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 615,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 618,
+    columnNumber: 19
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    """
+    Module description.
+    """
+
+
+  `);
+});
+it("only header in file (no children)", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    header: "#!/usr/bin/env python3"
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 631,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    #!/usr/bin/env python3
+
+
+  `);
+});
+it("only futureImports in file (no children)", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 645,
+        columnNumber: 23
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 643,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    from __future__ import annotations
+
+  `);
+});
+it("doc + futureImports in file (no children)", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 657,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 657,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    doc: moduleDoc,
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 664,
+        columnNumber: 23
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 661,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    """
+    Module description.
+    """
+
+    from __future__ import annotations
+
+  `);
+});
+
+// headerComment tests
+it("only headerComment before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company",
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 682,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 681,
+    columnNumber: 5
+  });
+
+  // 2 blank lines before definition (PEP 8)
+  expect(toSourceText(content)).toRenderTo(d`
+    # Copyright 2024 My Company
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("only headerComment before non-definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company",
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        initializer: 42
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 701,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 700,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    # Copyright 2024 My Company
+
+    x = 42`);
+});
+it("headerComment + doc before definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 713,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 713,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company",
+    doc: moduleDoc,
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 722,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 717,
+    columnNumber: 5
+  });
+
+  // headerComment and doc adjacent, then PEP 8 spacing before definition
+  expect(toSourceText(content)).toRenderTo(d`
+    # Copyright 2024 My Company
+    """
+    Module description.
+    """
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("headerComment + futureImports before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company",
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 746,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 748,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 743,
+    columnNumber: 5
+  });
+
+  // headerComment and futureImports adjacent, then PEP 8 spacing
+  expect(toSourceText(content)).toRenderTo(d`
+    # Copyright 2024 My Company
+
+    from __future__ import annotations
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("headerComment + imports before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company",
+    get children() {
+      return _$createComponent(py.DataclassDeclaration, {
+        name: "User",
+        get children() {
+          return _$createComponent(py.VariableDeclaration, {
+            name: "name",
+            type: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 770,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 769,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 768,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    # Copyright 2024 My Company
+
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class User:
+        name: str = None
+
+
+  `);
+});
+it("headerComment + doc + futureImports before definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 792,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 792,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company",
+    doc: moduleDoc,
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 800,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 802,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 796,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    # Copyright 2024 My Company
+    """
+    Module description.
+    """
+
+    from __future__ import annotations
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("headerComment + doc + futureImports + imports before definition", () => {
+  const moduleDoc = _$createComponent(py.ModuleDoc, {
+    get description() {
+      return [_$createComponent(Prose, {
+        children: "Module description."
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 824,
+        columnNumber: 33
+      })];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 824,
+    columnNumber: 5
+  });
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company",
+    doc: moduleDoc,
+    get futureImports() {
+      return [_$createComponent(py.FutureStatement, {
+        feature: "annotations"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 832,
+        columnNumber: 23
+      })];
+    },
+    get children() {
+      return _$createComponent(py.DataclassDeclaration, {
+        name: "User",
+        get children() {
+          return _$createComponent(py.VariableDeclaration, {
+            name: "name",
+            type: "str"
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 835,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 834,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 828,
+    columnNumber: 5
+  });
+  expect(toSourceText(content, {
+    externals: [dataclassesModule]
+  })).toRenderTo(d`
+    # Copyright 2024 My Company
+    """
+    Module description.
+    """
+
+    from __future__ import annotations
+
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class User:
+        name: str = None
+
+
+  `);
+});
+it("only headerComment in file (no children)", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    headerComment: "Copyright 2024 My Company"
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 862,
+    columnNumber: 5
+  });
+  expect(toSourceText(content)).toRenderTo(d`
+    # Copyright 2024 My Company
+
+  `);
+});
+it("header + headerComment before definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    header: "#!/usr/bin/env python3",
+    headerComment: "Copyright 2024 My Company",
+    get children() {
+      return _$createComponent(py.FunctionDeclaration, {
+        name: "hello",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 878,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 873,
+    columnNumber: 5
+  });
+
+  // 2 blank lines before definition (PEP 8)
+  expect(toSourceText(content)).toRenderTo(d`
+    #!/usr/bin/env python3
+    # Copyright 2024 My Company
+
+
+    def hello():
+        pass
+
+
+  `);
+});
+it("header + headerComment before class definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    header: "#!/usr/bin/env python3",
+    headerComment: "Copyright 2024 My Company",
+    get children() {
+      return _$createComponent(py.ClassDeclaration, {
+        name: "MyClass",
+        children: "pass"
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 902,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 897,
+    columnNumber: 5
+  });
+
+  // 2 blank lines before definition (PEP 8)
+  expect(toSourceText(content)).toRenderTo(d`
+    #!/usr/bin/env python3
+    # Copyright 2024 My Company
+
+
+    class MyClass:
+        pass
+
+
+  `);
+});
+it("header + headerComment before non-definition", () => {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    header: "#!/usr/bin/env python3",
+    headerComment: "Copyright 2024 My Company",
+    get children() {
+      return _$createComponent(py.VariableDeclaration, {
+        name: "x",
+        initializer: 42
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 926,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 921,
+    columnNumber: 5
+  });
+
+  // 1 blank line for non-definition
+  expect(toSourceText(content)).toRenderTo(d`
+    #!/usr/bin/env python3
+    # Copyright 2024 My Company
+
+    x = 42`);
+});
+//# sourceMappingURL=sourcefiles.test.js.map