@alloy-js/python 0.0.1

package/dist/test/sourcefiles.test.js

@@ -0,0 +1,198 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { d } from "@alloy-js/core/testing";
+import { expect, it } from "vitest";
+import * as py 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([]);
+  const expected = d`
+
+
+  `;
+  expect(result).toRenderTo(expected);
+});
+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
+                      });
+                    }
+                  }), _$createComponent(py.VariableDeclaration, {
+                    name: "y",
+                    type: "int",
+                    get initializer() {
+                      return _$createComponent(py.Atom, {
+                        jsValue: 42
+                      });
+                    }
+                  }), _$createComponent(py.FunctionCallExpression, {
+                    target: "foo",
+                    args: ["a", "b"]
+                  }), _$createComponent(py.MemberExpression, {
+                    get children() {
+                      return [_$createComponent(py.MemberExpression.Part, {
+                        id: "a"
+                      }), _$createComponent(py.MemberExpression.Part, {
+                        id: "b"
+                      }), _$createComponent(py.MemberExpression.Part, {
+                        key: "special-prop"
+                      })];
+                    }
+                  }), _$createComponent(py.VariableDeclaration, {
+                    name: "z",
+                    type: "int",
+                    get initializer() {
+                      return _$createComponent(py.Atom, {
+                        jsValue: 42
+                      });
+                    }
+                  })];
+                }
+              });
+            }
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "someVar",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              });
+            }
+          }), _$createComponent(py.FunctionDeclaration, {
+            name: "someOtherMethod",
+            returnType: "str"
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "someOtherVar",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              });
+            }
+          })];
+        }
+      });
+    }
+  }), _$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
+              });
+            }
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "y",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              });
+            }
+          }), _$createComponent(py.FunctionCallExpression, {
+            target: "foo",
+            args: ["a", "b"]
+          }), _$createComponent(py.MemberExpression, {
+            get children() {
+              return [_$createComponent(py.MemberExpression.Part, {
+                id: "a"
+              }), _$createComponent(py.MemberExpression.Part, {
+                id: "b"
+              }), _$createComponent(py.MemberExpression.Part, {
+                key: "special-prop"
+              })];
+            }
+          }), _$createComponent(py.VariableDeclaration, {
+            name: "z",
+            type: "int",
+            get initializer() {
+              return _$createComponent(py.Atom, {
+                jsValue: 42
+              });
+            }
+          })];
+        }
+      });
+    }
+  }), _$createComponent(py.ClassDeclaration, {
+    name: "someOtherClass",
+    get children() {
+      return _$createComponent(py.StatementList, {
+        get children() {
+          return _$createComponent(py.FunctionDeclaration, {
+            name: "someMethod",
+            returnType: "str"
+          });
+        }
+      });
+    }
+  }), _$createComponent(py.MemberExpression, {
+    get children() {
+      return [_$createComponent(py.MemberExpression.Part, {
+        id: "a"
+      }), _$createComponent(py.MemberExpression.Part, {
+        id: "b"
+      }), _$createComponent(py.MemberExpression.Part, {
+        key: "special-prop"
+      })];
+    }
+  })]);
+  const expected = 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"]
+
+  `;
+  expect(result).toRenderTo(expected);
+});

package/dist/test/utils.d.ts

@@ -0,0 +1,23 @@
+import { Binder, Children, ContentOutputFile, NamePolicy, OutputDirectory, PrintTreeOptions, SymbolCreator } from "@alloy-js/core";
+import { CustomOutputScope } from "../src/symbols/custom-output-scope.js";
+import { PythonModuleScope } from "../src/symbols/index.js";
+export declare function findFile(res: OutputDirectory, path: string): ContentOutputFile;
+export declare function assertFileContents(res: OutputDirectory, expectedFiles: Record<string, string>): void;
+export declare function toSourceTextMultiple(sourceFiles: Children[], { policy, externals, options, printOptions, }?: {
+    policy?: NamePolicy<string>;
+    externals?: SymbolCreator[];
+    options?: {
+        externals?: SymbolCreator[];
+    };
+    printOptions?: PrintTreeOptions;
+}): OutputDirectory;
+export declare function toSourceText(c: Children[], { policy, externals, options, printOptions, }?: {
+    policy?: NamePolicy<string>;
+    externals?: SymbolCreator[];
+    options?: {
+        externals?: SymbolCreator[];
+    };
+    printOptions?: PrintTreeOptions;
+}): string;
+export declare function createPythonModuleScope(name: string, parent: CustomOutputScope | undefined, binder?: Binder | undefined): PythonModuleScope;
+//# sourceMappingURL=utils.d.ts.map

package/dist/test/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../test/utils.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,QAAQ,EACR,iBAAiB,EACjB,UAAU,EAEV,eAAe,EAEf,gBAAgB,EAChB,aAAa,EAEd,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,wBAAgB,QAAQ,CACtB,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,MAAM,GACX,iBAAiB,CA2BnB;AAED,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,eAAe,EACpB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAMtC;AAED,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,QAAQ,EAAE,EACvB,EACE,MAAM,EACN,SAAS,EACT,OAAO,EACP,YAAY,GACb,GAAE;IACD,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;IAC1C,YAAY,CAAC,EAAE,gBAAgB,CAAC;CAC5B,GACL,eAAe,CAmBjB;AAED,wBAAgB,YAAY,CAC1B,CAAC,EAAE,QAAQ,EAAE,EACb,EACE,MAAM,EACN,SAAS,EACT,OAAO,EACP,YAAY,GACb,GAAE;IACD,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC;IAC1C,YAAY,CAAC,EAAE,gBAAgB,CAAC;CAC5B,GACL,MAAM,CAUR;AAGD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,GAAG,SAAS,EACrC,MAAM,GAAE,MAAM,GAAG,SAAqB,GACrC,iBAAiB,CAKnB"}

package/dist/test/utils.js

@@ -0,0 +1,88 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { Output, render } from "@alloy-js/core";
+import { dedent } from "@alloy-js/core/testing";
+import { expect } from "vitest";
+import * as py from "../src/components/index.js";
+import { createPythonNamePolicy } from "../src/name-policy.js";
+import { PythonModuleScope } from "../src/symbols/index.js";
+export function findFile(res, path) {
+  const result = findFileWorker(res, path);
+  if (!result) {
+    throw new Error("Expected to find file " + path);
+  }
+  return result;
+  function findFileWorker(res, path) {
+    for (const item of res.contents) {
+      if (item.kind === "file") {
+        if (item.path === path) {
+          return item;
+        }
+        continue;
+      } else {
+        const found = findFileWorker(item, path);
+        if (found) {
+          return found;
+        }
+      }
+    }
+    return null;
+  }
+}
+export function assertFileContents(res, expectedFiles) {
+  for (const [path, contents] of Object.entries(expectedFiles)) {
+    const file = findFile(res, path);
+    expect(file.contents).toBe(dedent(contents));
+  }
+}
+export function toSourceTextMultiple(sourceFiles, {
+  policy,
+  externals,
+  options,
+  printOptions
+} = {}) {
+  if (!policy) {
+    policy = createPythonNamePolicy();
+  }
+  const mergedExternals = options?.externals ?? externals;
+  if (printOptions === undefined) {
+    printOptions = {
+      printWidth: 80,
+      tabWidth: 4
+    };
+  } else {
+    printOptions.tabWidth = 4;
+  }
+  const content = _$createComponent(Output, {
+    externals: mergedExternals,
+    namePolicy: policy,
+    children: sourceFiles
+  });
+  return render(content, printOptions);
+}
+export function toSourceText(c, {
+  policy,
+  externals,
+  options,
+  printOptions
+} = {}) {
+  const content = _$createComponent(py.SourceFile, {
+    path: "test.py",
+    children: c
+  });
+  const res = toSourceTextMultiple([content], {
+    policy,
+    externals,
+    options,
+    printOptions
+  });
+  const file = findFile(res, "test.py");
+  return file.contents;
+}
+
+// Helper function to create a PythonModuleScope to be used in tests
+export function createPythonModuleScope(name, parent, binder = undefined) {
+  return new PythonModuleScope(name, {
+    parent: parent,
+    binder: binder
+  });
+}

package/dist/test/values.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=values.test.d.ts.map

package/dist/test/values.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"values.test.d.ts","sourceRoot":"","sources":["../../test/values.test.tsx"],"names":[],"mappings":""}

package/dist/test/values.test.js

@@ -0,0 +1,78 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import * as py from "../src/index.js";
+import { toSourceText } from "./utils.js";
+describe("Atom", () => {
+  it("renders string value", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: "Test"
+    })])).toRenderTo('"Test"');
+  });
+  it("renders null/undefined object", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: undefined
+    })])).toRenderTo("None");
+  });
+  it("renders number", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: 123
+    })])).toRenderTo("123");
+  });
+  it("renders boolean - True", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: true
+    })])).toRenderTo("True");
+  });
+  it("renders boolean - False", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: false
+    })])).toRenderTo("False");
+  });
+  it("renders array", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: [1, 2, 3]
+    })])).toRenderTo("[1, 2, 3]");
+  });
+  it("renders object", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: {
+        a: 1,
+        b: 2
+      }
+    })])).toRenderTo('{"a": 1, "b": 2}');
+  });
+  it("renders more complex object", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: {
+        a: "1",
+        b: 2,
+        c: true
+      }
+    })])).toRenderTo('{"a": "1", "b": 2, "c": True}');
+  });
+  it("renders empty object", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: {}
+    })])).toRenderTo("{}");
+  });
+  it("renders function", () => {
+    function Test() {
+      return ["Test"];
+    }
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: Test
+    })])).toRenderTo("Test");
+  });
+  it("renders nested object", () => {
+    expect(toSourceText([_$createComponent(py.Atom, {
+      jsValue: {
+        a: {
+          b: {
+            c: 1
+          }
+        },
+        d: 2
+      }
+    })])).toRenderTo('{"a": {"b": {"c": 1}}, "d": 2}');
+  });
+});

package/dist/test/variables.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=variables.test.d.ts.map

package/dist/test/variables.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variables.test.d.ts","sourceRoot":"","sources":["../../test/variables.test.tsx"],"names":[],"mappings":""}

package/dist/test/variables.test.js

@@ -0,0 +1,173 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { 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.js";
+describe("Python Variable", () => {
+  it("declares a python variable", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "myVar",
+      type: "int",
+      initializer: 42
+    })]);
+    expect(res).toBe(`my_var: int = 42`);
+  });
+  it("declares a python variable without value", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "myVar",
+      type: "int",
+      omitNone: true
+    })]);
+    expect(res).toBe(`my_var: int`);
+  });
+  it("declares a python variable without typeAnnotations", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "myVar",
+      initializer: 42
+    })]);
+    expect(res).toBe(`my_var = 42`);
+  });
+  it("declares a python variable as None when undefined", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "myVar"
+    })]);
+    expect(res).toBe(`my_var = None`);
+  });
+  it("declares a python variable as None when null", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "myVar",
+      get initializer() {
+        return _$createComponent(py.Atom, {
+          jsValue: null
+        });
+      }
+    })]);
+    expect(res).toBe(`my_var = None`);
+  });
+  it("declares a python variable that's an array", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "numbers",
+      type: "list[int]",
+      get initializer() {
+        return _$createComponent(py.Atom, {
+          jsValue: [1, 2, 3]
+        });
+      }
+    })]);
+    expect(res).toBe(`numbers: list[int] = [1, 2, 3]`);
+  });
+  it("declares a python variable with a python value", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "nameIdPairs",
+      get initializer() {
+        return _$createComponent(py.Atom, {
+          jsValue: {
+            John: 123,
+            Doe: 234
+          }
+        });
+      }
+    })]);
+    expect(res).toBe(`name_id_pairs = {"John": 123, "Doe": 234}`);
+  });
+  it("declares a python variable with omitNone", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "omitNoneVar",
+      type: "int",
+      omitNone: true
+    })]);
+    expect(res).toBe(`omit_none_var: int`);
+  });
+  it("declares a call statement python variable", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "callStmtVar",
+      initializer: 12,
+      callStatementVar: true
+    })]);
+    expect(res).toBe(`call_stmt_var=12`);
+  });
+  it("declares a call statement python variable without name", () => {
+    const res = toSourceText([_$createComponent(py.VariableDeclaration, {
+      name: "",
+      initializer: 12,
+      callStatementVar: true
+    })]);
+    expect(res).toBe(`12`);
+  });
+  it("declares a python variable with a class type", () => {
+    const res = toSourceText([_$createComponent(py.StatementList, {
+      get children() {
+        return [_$createComponent(py.ClassDeclaration, {
+          name: "MyClass"
+        }), _$createComponent(py.VariableDeclaration, {
+          name: "my_var",
+          get type() {
+            return _$createComponent(py.Reference, {
+              get refkey() {
+                return refkey("MyClass");
+              }
+            });
+          }
+        })];
+      }
+    })]);
+    expect(res).toBe(d`
+      class MyClass:
+          pass
+
+      my_var: MyClass = None`);
+  });
+  it("declares a python variable with a class type from a different module", () => {
+    const res = toSourceTextMultiple([_$createComponent(py.SourceFile, {
+      path: "classes.py",
+      get children() {
+        return _$createComponent(py.ClassDeclaration, {
+          name: "MyClass"
+        });
+      }
+    }), _$createComponent(py.SourceFile, {
+      path: "usage.py",
+      get children() {
+        return _$createComponent(py.VariableDeclaration, {
+          name: "my_var",
+          get type() {
+            return _$createComponent(py.Reference, {
+              get refkey() {
+                return refkey("MyClass");
+              }
+            });
+          }
+        });
+      }
+    })]);
+    assertFileContents(res, {
+      "classes.py": `
+        class MyClass:
+            pass
+
+      `,
+      "usage.py": `
+        from classes import MyClass
+
+        my_var: MyClass = None
+      `
+    });
+  });
+  it("declares a python variable receiving other variable as value", () => {
+    const res = toSourceText([_$createComponent(py.StatementList, {
+      get children() {
+        return [_$createComponent(py.VariableDeclaration, {
+          name: "my_var",
+          initializer: 42
+        }), _$createComponent(py.VariableDeclaration, {
+          name: "my_other_var",
+          get initializer() {
+            return refkey("my_var");
+          }
+        })];
+      }
+    })]);
+    expect(res).toBe(`my_var = 42\nmy_other_var = my_var`);
+  });
+});