@alloy-js/python 0.1.0-dev.2 → 0.1.0-dev.4

package/src/components/UnionTypeExpression.tsx

@@ -0,0 +1,40 @@
+import { Children, childrenArray, For, memo } from "@alloy-js/core";
+
+export interface UnionTypeExpressionProps {
+  children: Children[];
+  optional?: boolean;
+}
+
+export function UnionTypeExpression(props: UnionTypeExpressionProps) {
+  const resolvedChildren = memo(() => {
+    const children = childrenArray(() => props.children, {
+      preserveFragments: true,
+    });
+
+    if (props.optional) {
+      children.push("None");
+    }
+    return children;
+  });
+
+  return (
+    <group>
+      <ifBreak>(</ifBreak>
+      <indent>
+        <sbr />
+        <For
+          each={resolvedChildren}
+          joiner={
+            <>
+              <br />|{" "}
+            </>
+          }
+        >
+          {(child) => child}
+        </For>
+      </indent>
+      <sbr />
+      <ifBreak>)</ifBreak>
+    </group>
+  );
+}

package/src/components/index.ts

@@ -15,4 +15,5 @@ export * from "./PythonBlock.js";
 export * from "./Reference.js";
 export * from "./SourceFile.js";
 export * from "./StatementList.js";
+export * from "./UnionTypeExpression.js";
 export * from "./VariableDeclaration.js";

package/temp/api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.52.8",
+    "toolVersion": "7.52.9",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -4325,21 +4325,8 @@
             },
             {
               "kind": "Reference",
-              "text": "Omit",
-              "canonicalReference": "!Omit:type"
-            },
-            {
-              "kind": "Content",
-              "text": "<"
-            },
-            {
-              "kind": "Reference",
-              "text": "FunctionDeclarationProps",
-              "canonicalReference": "@alloy-js/python!FunctionDeclarationProps:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ", \"name\" | \"instanceFunction\" | \"classFunction\">"
+              "text": "InitFunctionDeclarationProps",
+              "canonicalReference": "@alloy-js/python!InitFunctionDeclarationProps:interface"
             },
             {
               "kind": "Content",
@@ -4361,8 +4348,8 @@
           ],
           "fileUrlPath": "src/components/FunctionDeclaration.tsx",
           "returnTypeTokenRange": {
-            "startIndex": 6,
-            "endIndex": 8
+            "startIndex": 3,
+            "endIndex": 5
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -4371,13 +4358,57 @@
               "parameterName": "props",
               "parameterTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 5
+                "endIndex": 2
               },
               "isOptional": false
             }
           ],
           "name": "InitFunctionDeclaration"
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/python!InitFunctionDeclarationProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface InitFunctionDeclarationProps extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "FunctionDeclarationProps",
+              "canonicalReference": "@alloy-js/python!FunctionDeclarationProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"name\" | \"instanceFunction\" | \"classFunction\">"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/components/FunctionDeclaration.tsx",
+          "releaseTag": "Public",
+          "name": "InitFunctionDeclarationProps",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 5
+            }
+          ]
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/python!MemberExpression:function(1)",
@@ -5440,18 +5471,10 @@
               "kind": "Content",
               "text": "export declare function PythonBlock(props: "
             },
-            {
-              "kind": "Content",
-              "text": "{\n    children: "
-            },
             {
               "kind": "Reference",
-              "text": "Children",
-              "canonicalReference": "@alloy-js/core!Children:type"
-            },
-            {
-              "kind": "Content",
-              "text": ";\n    opener?: string;\n}"
+              "text": "PythonBlockProps",
+              "canonicalReference": "@alloy-js/python!PythonBlockProps:interface"
             },
             {
               "kind": "Content",
@@ -5469,8 +5492,8 @@
           ],
           "fileUrlPath": "src/components/PythonBlock.tsx",
           "returnTypeTokenRange": {
-            "startIndex": 5,
-            "endIndex": 6
+            "startIndex": 3,
+            "endIndex": 4
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -5479,13 +5502,86 @@
               "parameterName": "props",
               "parameterTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 4
+                "endIndex": 2
               },
               "isOptional": false
             }
           ],
           "name": "PythonBlock"
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/python!PythonBlockProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PythonBlockProps "
+            }
+          ],
+          "fileUrlPath": "src/components/PythonBlock.tsx",
+          "releaseTag": "Public",
+          "name": "PythonBlockProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/python!PythonBlockProps#children:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "children: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "children",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/python!PythonBlockProps#opener:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "opener?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "opener",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@alloy-js/python!PythonElements:type",
@@ -6885,6 +6981,130 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/python!UnionTypeExpression:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function UnionTypeExpression(props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UnionTypeExpressionProps",
+              "canonicalReference": "@alloy-js/python!UnionTypeExpressionProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Children",
+              "canonicalReference": "@alloy-js/core!Children:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/components/UnionTypeExpression.tsx",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "UnionTypeExpression"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/python!UnionTypeExpressionProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface UnionTypeExpressionProps "
+            }
+          ],
+          "fileUrlPath": "src/components/UnionTypeExpression.tsx",
+          "releaseTag": "Public",
+          "name": "UnionTypeExpressionProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/python!UnionTypeExpressionProps#children:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "children: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "children",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/python!UnionTypeExpressionProps#optional:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "optional?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "optional",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/python!usePythonNamePolicy:function(1)",

package/test/uniontypeexpression.test.tsx

@@ -0,0 +1,77 @@
+import { code } 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 { toSourceText } from "./utils.jsx";
+
+describe("UnionTypeExpression", () => {
+  it("renders a Python union expression - 1 item", () => {
+    const elements = [code`int`];
+    expect(
+      toSourceText([
+        <py.UnionTypeExpression>{elements}</py.UnionTypeExpression>,
+      ]),
+    ).toRenderTo("int");
+  });
+  it("renders a Python union expression - 2 items", () => {
+    const elements = [code`int`, code`str`];
+    expect(
+      toSourceText([
+        <py.UnionTypeExpression>{elements}</py.UnionTypeExpression>,
+      ]),
+    ).toRenderTo("int | str");
+  });
+  it("renders a Python union expression - N items", () => {
+    const elements = [
+      code`int`,
+      code`str`,
+      code`float`,
+      code`bool`,
+      code`list`,
+      code`dict`,
+      code`set`,
+      code`tuple`,
+      code`frozenset`,
+      code`bytes`,
+      code`bytearray`,
+      code`memoryview`,
+      code`complex`,
+    ];
+    expect(
+      toSourceText([
+        <py.UnionTypeExpression>{elements}</py.UnionTypeExpression>,
+      ]),
+    ).toRenderTo(d`
+        (
+            int
+            | str
+            | float
+            | bool
+            | list
+            | dict
+            | set
+            | tuple
+            | frozenset
+            | bytes
+            | bytearray
+            | memoryview
+            | complex
+        )`);
+  });
+  it("renders a Python union expression - 2 items", () => {
+    const elements = [code`int`, code`str`];
+    expect(
+      toSourceText([
+        <py.UnionTypeExpression>{elements}</py.UnionTypeExpression>,
+      ]),
+    ).toRenderTo("int | str");
+  });
+  it("renders a Python union expression - 2 items with optional", () => {
+    const elements = [code`int`, code`str`];
+    expect(
+      toSourceText([
+        <py.UnionTypeExpression optional>{elements}</py.UnionTypeExpression>,
+      ]),
+    ).toRenderTo("int | str | None");
+  });
+});

package/test/variables.test.tsx

@@ -1,4 +1,4 @@
-import { refkey } from "@alloy-js/core";
+import { code, 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";
@@ -95,6 +95,34 @@ describe("Python Variable", () => {
     expect(res).toBe(`12`);
   });
 
+  it("declares a python variable with an optional type", () => {
+    const elements = [code`int`];
+    const typing = (
+      <py.UnionTypeExpression optional>{elements}</py.UnionTypeExpression>
+    );
+    const res = toSourceText([
+      <py.StatementList>
+        <py.VariableDeclaration name="my_var" type={typing} />
+      </py.StatementList>,
+    ]);
+    expect(res).toBe(d`
+      my_var: int | None = None`);
+  });
+
+  it("declares a python variable with an optional type omitting none", () => {
+    const elements = [code`int`];
+    const typing = (
+      <py.UnionTypeExpression optional>{elements}</py.UnionTypeExpression>
+    );
+    const res = toSourceText([
+      <py.StatementList>
+        <py.VariableDeclaration name="my_var" type={typing} omitNone />
+      </py.StatementList>,
+    ]);
+    expect(res).toBe(d`
+      my_var: int | None`);
+  });
+
   it("declares a python variable with a class type", () => {
     const res = toSourceText([
       <py.StatementList>

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.8"
+      "packageVersion": "7.52.9"
     }
   ]
 }