@alloy-js/python 0.5.0-dev.0 → 0.5.0-dev.2

package/test/class-method-declaration.test.tsx

@@ -1,7 +1,6 @@
-import { d } from "@alloy-js/core/testing";
 import { describe, expect, it } from "vitest";
 import * as py from "../src/index.js";
-import { toSourceText } from "./utils.js";
+import { TestOutput } from "./utils.js";
 
 describe("ClassMethodDeclaration", () => {
   it("renders async class method", () => {
@@ -21,7 +20,7 @@ describe("ClassMethodDeclaration", () => {
       </py.StatementList>
     );
 
-    expect(toSourceText([decl])).toBe(d`
+    expect(<TestOutput>{decl}</TestOutput>).toRenderTo(`
       class MyClass:
           @classmethod
           async def create(cls) -> MyClass:
@@ -41,7 +40,7 @@ describe("ClassMethodDeclaration", () => {
       </py.ClassDeclaration>
     );
 
-    expect(toSourceText([decl])).toBe(d`
+    expect(<TestOutput>{decl}</TestOutput>).toRenderTo(`
       class MyClass:
           @classmethod
           def foo(cls, x: int):

package/test/classdeclarations.test.tsx

@@ -1,60 +1,98 @@
 import { memberRefkey, namekey, refkey } from "@alloy-js/core";
-import { d } from "@alloy-js/core/testing";
 import { describe, expect, it } from "vitest";
 import * as py from "../src/index.js";
-import {
-  assertFileContents,
-  toSourceText,
-  toSourceTextMultiple,
-} from "./utils.jsx";
+import { TestOutput, TestOutputDirectory } from "./utils.js";
 
 describe("Python Class", () => {
-  it("renders a class with no body as 'pass'", () => {
-    const result = toSourceText([<py.ClassDeclaration name="Foo" />]);
-    expect(result).toRenderTo(d`
+  it("renders class-level decorators above `class`", () => {
+    expect(
+      <TestOutput>
+        <py.ClassDeclaration
+          name="Foo"
+          decorators={["@final", "@deprecated('use Bar')"]}
+        />
+      </TestOutput>,
+    ).toRenderTo(
+      `
+      @final
+      @deprecated('use Bar')
       class Foo:
           pass
 
+    `,
+    );
+  });
 
-    `);
+  it("renders nothing extra when decorators is undefined", () => {
+    expect(
+      <TestOutput>
+        <py.ClassDeclaration name="Foo" />
+      </TestOutput>,
+    ).toRenderTo(
+      `
+      class Foo:
+          pass
+
+    `,
+    );
   });
 
-  it("takes a namekey", () => {
-    const result = toSourceText([
-      <py.ClassDeclaration name={namekey("Foo")} />,
-    ]);
-    expect(result).toRenderTo(d`
+  it("renders a class with no body as 'pass'", () => {
+    expect(
+      <TestOutput>
+        <py.ClassDeclaration name="Foo" />
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class Foo:
           pass
 
+    `,
+    );
+  });
+
+  it("takes a namekey", () => {
+    expect(
+      <TestOutput>
+        <py.ClassDeclaration name={namekey("Foo")} />
+      </TestOutput>,
+    ).toRenderTo(
+      `
+      class Foo:
+          pass
 
-    `);
+    `,
+    );
   });
 
   it("renders a class with a body", () => {
-    const result = toSourceText([
-      <py.ClassDeclaration name="Bar">print('hi')</py.ClassDeclaration>,
-    ]);
-    expect(result).toRenderTo(d`
+    expect(
+      <TestOutput>
+        <py.ClassDeclaration name="Bar">print('hi')</py.ClassDeclaration>
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class Bar:
           print('hi')
 
-
-    `);
+    `,
+    );
   });
 
   it("renders a class with base classes", () => {
-    const result = toSourceText([
-      <py.StatementList>
-        <py.ClassDeclaration name="Base1" refkey={refkey("Base1")} />
-        <py.ClassDeclaration name="Base2" refkey={refkey("Base2")} />
-        <py.ClassDeclaration
-          name="Baz"
-          bases={[refkey("Base1"), refkey("Base2")]}
-        />
-      </py.StatementList>,
-    ]);
-    const expected = d`
+    expect(
+      <TestOutput>
+        <py.StatementList>
+          <py.ClassDeclaration name="Base1" refkey={refkey("Base1")} />
+          <py.ClassDeclaration name="Base2" refkey={refkey("Base2")} />
+          <py.ClassDeclaration
+            name="Baz"
+            bases={[refkey("Base1"), refkey("Base2")]}
+          />
+        </py.StatementList>
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class Base1:
           pass
 
@@ -64,83 +102,83 @@ describe("Python Class", () => {
       class Baz(Base1, Base2):
           pass
 
-        
-    `;
-    expect(result).toRenderTo(expected);
+    `,
+    );
   });
 
   it("renders a class with base classes and body", () => {
-    const result = toSourceText([
-      <py.ClassDeclaration name="Qux" bases={["Base"]}>
-        print('hello')
-      </py.ClassDeclaration>,
-    ]);
-    expect(result).toRenderTo(d`
+    expect(
+      <TestOutput>
+        <py.ClassDeclaration name="Qux" bases={["Base"]}>
+          print('hello')
+        </py.ClassDeclaration>
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class Qux(Base):
           print('hello')
 
-
-    `);
+    `,
+    );
   });
 
   it("renders classes across modules with inheritance", () => {
-    const result = toSourceTextMultiple([
-      <py.SourceFile path="mod1.py">
-        <py.ClassDeclaration name="A" refkey={refkey("A")} />
-      </py.SourceFile>,
-      <py.SourceFile path="folder/mod2.py">
-        <py.ClassDeclaration
-          name="B"
-          refkey={refkey("B")}
-          bases={[refkey("A")]}
-        />
-      </py.SourceFile>,
-      <py.SourceFile path="mod3.py">
-        <py.ClassDeclaration name="C" bases={[refkey("B")]} />
-      </py.SourceFile>,
-    ]);
-    const mod1Expected = d`
-      class A:
-          pass
-
-
-    `;
-    const mod2Expected = d`
-      from mod1 import A
-
+    expect(
+      <TestOutputDirectory>
+        <py.SourceFile path="mod1.py">
+          <py.ClassDeclaration name="A" refkey={refkey("A")} />
+        </py.SourceFile>
+        <py.SourceFile path="folder/mod2.py">
+          <py.ClassDeclaration
+            name="B"
+            refkey={refkey("B")}
+            bases={[refkey("A")]}
+          />
+        </py.SourceFile>
+        <py.SourceFile path="mod3.py">
+          <py.ClassDeclaration name="C" bases={[refkey("B")]} />
+        </py.SourceFile>
+      </TestOutputDirectory>,
+    ).toRenderTo({
+      "mod1.py": `
+          class A:
+              pass
 
-      class B(A):
-          pass
+        `,
+      "folder/mod2.py": `
+          from mod1 import A
 
 
-    `;
-    const mod3Expected = d`
-      from folder.mod2 import B
+          class B(A):
+              pass
 
+        `,
+      "mod3.py": `
+          from folder.mod2 import B
 
-      class C(B):
-          pass
 
+          class C(B):
+              pass
 
-    `;
-    assertFileContents(result, { "mod1.py": mod1Expected });
-    assertFileContents(result, { "folder/mod2.py": mod2Expected });
-    assertFileContents(result, { "mod3.py": mod3Expected });
+        `,
+    });
   });
 
   it("renders a class with class variables like foo: str, and also bar: A where A is another class", () => {
-    const result = toSourceText([
-      <py.StatementList>
-        <py.ClassDeclaration name="A" refkey={refkey("A")} />
-        <py.ClassDeclaration name="B">
-          <py.StatementList>
-            <py.VariableDeclaration name="bar" type={refkey("A")} omitNone />
-            <py.VariableDeclaration name="foo" type="str" omitNone />
-          </py.StatementList>
-        </py.ClassDeclaration>
-      </py.StatementList>,
-    ]);
-    const expected = d`
+    expect(
+      <TestOutput>
+        <py.StatementList>
+          <py.ClassDeclaration name="A" refkey={refkey("A")} />
+          <py.ClassDeclaration name="B">
+            <py.StatementList>
+              <py.VariableDeclaration name="bar" type={refkey("A")} omitNone />
+              <py.VariableDeclaration name="foo" type="str" omitNone />
+            </py.StatementList>
+          </py.ClassDeclaration>
+        </py.StatementList>
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class A:
           pass
 
@@ -148,42 +186,43 @@ describe("Python Class", () => {
           bar: A
           foo: str
 
-
-    `;
-    expect(result).toRenderTo(expected);
+    `,
+    );
   });
 
   it("renders a class with class variables like foo: str, and another identical class", () => {
     const fooKey = refkey();
     const barKey = refkey();
 
-    const result = toSourceText([
-      <py.StatementList>
-        <py.ClassDeclaration name="A">
-          <py.StatementList>
-            <py.VariableDeclaration
-              name="foo"
-              type="str"
-              refkey={fooKey}
-              omitNone
-            />
-          </py.StatementList>
-        </py.ClassDeclaration>
-        <py.ClassDeclaration name="B">
-          <py.StatementList>
-            <py.VariableDeclaration
-              name="foo"
-              type="str"
-              refkey={barKey}
-              omitNone
-            />
-          </py.StatementList>
-        </py.ClassDeclaration>
-        {fooKey}
-        {barKey}
-      </py.StatementList>,
-    ]);
-    const expected = d`
+    expect(
+      <TestOutput>
+        <py.StatementList>
+          <py.ClassDeclaration name="A">
+            <py.StatementList>
+              <py.VariableDeclaration
+                name="foo"
+                type="str"
+                refkey={fooKey}
+                omitNone
+              />
+            </py.StatementList>
+          </py.ClassDeclaration>
+          <py.ClassDeclaration name="B">
+            <py.StatementList>
+              <py.VariableDeclaration
+                name="foo"
+                type="str"
+                refkey={barKey}
+                omitNone
+              />
+            </py.StatementList>
+          </py.ClassDeclaration>
+          {fooKey}
+          {barKey}
+        </py.StatementList>
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class A:
           foo: str
 
@@ -192,43 +231,45 @@ describe("Python Class", () => {
 
       A.foo
       B.foo
-    `;
-    expect(result).toRenderTo(expected);
+    `,
+    );
   });
 });
 
 describe("Python Class - VariableDeclaration", () => {
   it("renders a class with class fields", () => {
-    const result = toSourceText([
-      <py.StatementList>
-        <py.ClassDeclaration
-          refkey={refkey("Base")}
-          name="Base"
-        ></py.ClassDeclaration>
-        <py.ClassDeclaration refkey={refkey("A")} name="A">
-          <py.StatementList>
-            <py.VariableDeclaration instanceVariable name="just_name" />
-            <py.VariableDeclaration
-              name="name_and_type"
-              type="number"
-              instanceVariable
-            />
-            <py.VariableDeclaration
-              instanceVariable
-              name="name_type_and_value"
-              type="number"
-              initializer={12}
-            />
-            <py.VariableDeclaration
-              instanceVariable
-              name="class_based"
-              type={refkey("Base")}
-            />
-          </py.StatementList>
-        </py.ClassDeclaration>
-      </py.StatementList>,
-    ]);
-    const expected = d`
+    expect(
+      <TestOutput>
+        <py.StatementList>
+          <py.ClassDeclaration
+            refkey={refkey("Base")}
+            name="Base"
+          ></py.ClassDeclaration>
+          <py.ClassDeclaration refkey={refkey("A")} name="A">
+            <py.StatementList>
+              <py.VariableDeclaration instanceVariable name="just_name" />
+              <py.VariableDeclaration
+                name="name_and_type"
+                type="number"
+                instanceVariable
+              />
+              <py.VariableDeclaration
+                instanceVariable
+                name="name_type_and_value"
+                type="number"
+                initializer={12}
+              />
+              <py.VariableDeclaration
+                instanceVariable
+                name="class_based"
+                type={refkey("Base")}
+              />
+            </py.StatementList>
+          </py.ClassDeclaration>
+        </py.StatementList>
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class Base:
           pass
 
@@ -238,9 +279,8 @@ describe("Python Class - VariableDeclaration", () => {
           name_type_and_value: number = 12
           class_based: Base = None
 
-
-    `;
-    expect(result).toRenderTo(expected);
+    `,
+    );
   });
 
   it("correctly access members of its type", () => {
@@ -249,54 +289,54 @@ describe("Python Class - VariableDeclaration", () => {
     const classMethodRk = refkey();
     const v1Rk = refkey();
 
-    const res = toSourceTextMultiple([
-      <py.SourceFile path="inst.py">
-        <py.StatementList>
-          <py.VariableDeclaration
-            name="one"
-            refkey={v1Rk}
-            type={classRk}
-            initializer={<py.ClassInstantiation target={classRk} />}
-          />
-          <>{memberRefkey(v1Rk, classMemberRk)}</>
-          <>{memberRefkey(v1Rk, classMethodRk)}()</>
-        </py.StatementList>
-      </py.SourceFile>,
-      <py.SourceFile path="decl.py">
-        <py.ClassDeclaration name="Bar" refkey={classRk}>
+    expect(
+      <TestOutputDirectory>
+        <py.SourceFile path="inst.py">
           <py.StatementList>
             <py.VariableDeclaration
-              name="instanceProp"
-              refkey={classMemberRk}
-              initializer={42}
-              instanceVariable
-            />
-            <py.MethodDeclaration
-              name="instanceMethod"
-              refkey={classMethodRk}
-              returnType="int"
+              name="one"
+              refkey={v1Rk}
+              type={classRk}
+              initializer={<py.ClassInstantiation target={classRk} />}
             />
+            <>{memberRefkey(v1Rk, classMemberRk)}</>
+            <>{memberRefkey(v1Rk, classMethodRk)}()</>
           </py.StatementList>
-        </py.ClassDeclaration>
-      </py.SourceFile>,
-    ]);
-
-    assertFileContents(res, {
+        </py.SourceFile>
+        <py.SourceFile path="decl.py">
+          <py.ClassDeclaration name="Bar" refkey={classRk}>
+            <py.StatementList>
+              <py.VariableDeclaration
+                name="instanceProp"
+                refkey={classMemberRk}
+                initializer={42}
+                instanceVariable
+              />
+              <py.MethodDeclaration
+                name="instanceMethod"
+                refkey={classMethodRk}
+                returnType="int"
+              />
+            </py.StatementList>
+          </py.ClassDeclaration>
+        </py.SourceFile>
+      </TestOutputDirectory>,
+    ).toRenderTo({
       "inst.py": `
-        from decl import Bar
+          from decl import Bar
 
-        one: Bar = Bar()
-        one.instance_prop
-        one.instance_method()
-      `,
+          one: Bar = Bar()
+          one.instance_prop
+          one.instance_method()
+        `,
       "decl.py": `
-        class Bar:
-            instance_prop = 42
-            def instance_method(self) -> int:
-                pass
+          class Bar:
+              instance_prop = 42
+              def instance_method(self) -> int:
+                  pass
 
 
-      `,
+        `,
     });
   });
 });
@@ -307,44 +347,46 @@ describe("Python Class - FunctionDeclaration", () => {
     const classMethodRefkey = refkey();
     const staticMethodRefkey = refkey();
 
-    const result = toSourceText([
-      <py.StatementList>
-        <py.ClassDeclaration name="MyClass" bases={["BaseClass"]}>
-          <py.StatementList>
-            <py.VariableDeclaration name="a" type="int" instanceVariable />
-            <py.VariableDeclaration name="b" type="int" instanceVariable />
-            <py.MethodDeclaration
-              name="my_method"
-              parameters={[
-                { name: "a", type: "int" },
-                { name: "b", type: "int" },
-              ]}
-              returnType="int"
-              refkey={methodRefkey}
-            >
-              return a + b
-            </py.MethodDeclaration>
-            <py.ClassMethodDeclaration
-              name="my_class_method"
-              returnType="int"
-              refkey={classMethodRefkey}
-            >
-              pass
-            </py.ClassMethodDeclaration>
-            <py.FunctionDeclaration
-              name="my_standalone_function"
-              returnType="int"
-              refkey={staticMethodRefkey}
-            >
-              pass
-            </py.FunctionDeclaration>
-          </py.StatementList>
-        </py.ClassDeclaration>
-        {classMethodRefkey}
-        {staticMethodRefkey}
-      </py.StatementList>,
-    ]);
-    const expected = d`
+    expect(
+      <TestOutput>
+        <py.StatementList>
+          <py.ClassDeclaration name="MyClass" bases={["BaseClass"]}>
+            <py.StatementList>
+              <py.VariableDeclaration name="a" type="int" instanceVariable />
+              <py.VariableDeclaration name="b" type="int" instanceVariable />
+              <py.MethodDeclaration
+                name="my_method"
+                parameters={[
+                  { name: "a", type: "int" },
+                  { name: "b", type: "int" },
+                ]}
+                returnType="int"
+                refkey={methodRefkey}
+              >
+                return a + b
+              </py.MethodDeclaration>
+              <py.ClassMethodDeclaration
+                name="my_class_method"
+                returnType="int"
+                refkey={classMethodRefkey}
+              >
+                pass
+              </py.ClassMethodDeclaration>
+              <py.FunctionDeclaration
+                name="my_standalone_function"
+                returnType="int"
+                refkey={staticMethodRefkey}
+              >
+                pass
+              </py.FunctionDeclaration>
+            </py.StatementList>
+          </py.ClassDeclaration>
+          {classMethodRefkey}
+          {staticMethodRefkey}
+        </py.StatementList>
+      </TestOutput>,
+    ).toRenderTo(
+      `
       class MyClass(BaseClass):
           a: int = None
           b: int = None
@@ -361,7 +403,7 @@ describe("Python Class - FunctionDeclaration", () => {
       
       MyClass.my_class_method
       MyClass.my_standalone_function
-    `;
-    expect(result).toRenderTo(expected);
+    `,
+    );
   });
 });