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

package/src/components/EnumMember.tsx

@@ -3,7 +3,7 @@ import { enumModule } from "../builtins/python.js";
 import { createPythonSymbol } from "../symbol-creation.js";
 import { PythonOutputSymbol } from "../symbols/index.js";
 import { Atom } from "./Atom.jsx";
-import { SimpleInlineMemberComment } from "./PyDoc.jsx";
+import { InlineDoc } from "./PyDoc.jsx";
 
 export interface EnumMemberProps {
   /**
@@ -73,7 +73,7 @@ export function EnumMember(props: EnumMemberProps) {
       <>
         '{sym.name}'<Show when={valueCode !== undefined}> : {valueCode}</Show>
         <Show when={props.doc !== undefined}>
-          <SimpleInlineMemberComment>{props.doc}</SimpleInlineMemberComment>
+          <InlineDoc>{props.doc}</InlineDoc>
         </Show>
       </>
     );
@@ -83,7 +83,7 @@ export function EnumMember(props: EnumMemberProps) {
       {sym.name}
       <Show when={valueCode !== undefined}> = {valueCode}</Show>
       <Show when={props.doc !== undefined}>
-        <SimpleInlineMemberComment>{props.doc}</SimpleInlineMemberComment>
+        <InlineDoc>{props.doc}</InlineDoc>
       </Show>
     </>
   );

package/src/components/PyDoc.tsx

@@ -259,6 +259,28 @@ export function PyDoc(props: PyDocProps) {
   );
 }
 
+export interface InlineDocProps {
+  children: Children;
+}
+
+/**
+ * An inline documentation component for attribute docstrings.
+ * Unlike PyDoc, this doesn't add a trailing line break after the closing quotes,
+ * which is appropriate for documenting consecutive attributes like enum members.
+ */
+export function InlineDoc(props: InlineDocProps) {
+  return (
+    <>
+      <hardline />
+      {'"""'}
+      <hbr />
+      {props.children}
+      <hbr />
+      {'"""'}
+    </>
+  );
+}
+
 export interface PyDocExampleProps {
   children: Children;
 }
@@ -373,14 +395,6 @@ export interface SimpleInlineCommentProps {
   children: Children;
 }
 
-export function SimpleInlineMemberComment(props: SimpleInlineCommentProps) {
-  return (
-    <>
-      {"  "}#: <Prose>{props.children}</Prose>
-    </>
-  );
-}
-
 interface GoogleStyleFunctionDocProps extends Omit<FunctionDocProps, "style"> {}
 
 /**

package/temp/api.json

@@ -5431,6 +5431,99 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/python!InlineDoc:function(1)",
+          "docComment": "/**\n * An inline documentation component for attribute docstrings.\n * Unlike PyDoc, this doesn't add a trailing line break after the closing quotes,\n * which is appropriate for documenting consecutive attributes like enum members.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function InlineDoc(props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "InlineDocProps",
+              "canonicalReference": "@alloy-js/python!InlineDocProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Children",
+              "canonicalReference": "@alloy-js/core!Children:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/components/PyDoc.tsx",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "InlineDoc"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/python!InlineDocProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface InlineDocProps "
+            }
+          ],
+          "fileUrlPath": "src/components/PyDoc.tsx",
+          "releaseTag": "Public",
+          "name": "InlineDocProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/python!InlineDocProps#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
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/python!isParameterDescriptor:function(1)",
@@ -9731,53 +9824,6 @@
           ],
           "extendsTokenRanges": []
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@alloy-js/python!SimpleInlineMemberComment:function(1)",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function SimpleInlineMemberComment(props: "
-            },
-            {
-              "kind": "Reference",
-              "text": "SimpleInlineCommentProps",
-              "canonicalReference": "@alloy-js/python!SimpleInlineCommentProps:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Reference",
-              "text": "Children",
-              "canonicalReference": "@alloy-js/core!Children:type"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/components/PyDoc.tsx",
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "props",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "SimpleInlineMemberComment"
-        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/python!SourceFile:function(1)",

package/test/dataclassdeclarations.test.tsx

@@ -1,9 +1,13 @@
-import { Prose, namekey } from "@alloy-js/core";
+import { Prose, namekey, refkey } from "@alloy-js/core";
 import { d } from "@alloy-js/core/testing";
 import { describe, expect, it } from "vitest";
 import { dataclassesModule } from "../src/builtins/python.js";
 import * as py from "../src/index.js";
-import { toSourceText } from "./utils.jsx";
+import {
+  assertFileContents,
+  toSourceText,
+  toSourceTextMultiple,
+} from "./utils.jsx";
 
 describe("DataclassDeclaration", () => {
   it("Creates a dataclass with a class doc", () => {
@@ -582,4 +586,61 @@ describe("DataclassDeclaration", () => {
       `,
     );
   });
+
+  it("Forwards refkey prop for symbol resolution in type references", () => {
+    const userRefkey = refkey();
+    const res = toSourceTextMultiple(
+      [
+        <py.SourceFile path="models.py">
+          <py.DataclassDeclaration name="User" refkey={userRefkey}>
+            <py.VariableDeclaration
+              instanceVariable
+              omitNone
+              name="id"
+              type="int"
+            />
+            <py.VariableDeclaration
+              instanceVariable
+              omitNone
+              name="name"
+              type="str"
+            />
+          </py.DataclassDeclaration>
+        </py.SourceFile>,
+        <py.SourceFile path="services.py">
+          <py.FunctionDeclaration name="get_user" returnType={userRefkey}>
+            <py.VariableDeclaration
+              name="user"
+              type={userRefkey}
+              initializer={
+                <py.ClassInstantiation target="User" args={["1", '"Alice"']} />
+              }
+            />
+            <hbr />
+            {"return user"}
+          </py.FunctionDeclaration>
+        </py.SourceFile>,
+      ],
+      { externals: [dataclassesModule] },
+    );
+    assertFileContents(res, {
+      "models.py": `
+        from dataclasses import dataclass
+
+        @dataclass
+        class User:
+            id: int
+            name: str
+
+        `,
+      "services.py": `
+        from models import User
+
+        def get_user() -> User:
+            user: User = User(1, "Alice")
+            return user
+
+        `,
+    });
+  });
 });

package/test/pydocs.test.tsx

@@ -195,40 +195,6 @@ describe("SimpleInlineComment", () => {
   });
 });
 
-describe("SimpleInlineMemberComment", () => {
-  it("renders inline member comment", () => {
-    const res = toSourceText([
-      <>
-        status: int
-        <py.SimpleInlineMemberComment>
-          HTTP status code
-        </py.SimpleInlineMemberComment>
-      </>,
-    ]);
-    expect(res).toRenderTo(
-      d`
-          status: int  #: HTTP status code
-          `,
-    );
-  });
-
-  it("renders inline member comment for variable declaration", () => {
-    const res = toSourceText([
-      <>
-        max_retries = 3
-        <py.SimpleInlineMemberComment>
-          Maximum number of retry attempts
-        </py.SimpleInlineMemberComment>
-      </>,
-    ]);
-    expect(res).toRenderTo(
-      d`
-          max_retries = 3  #: Maximum number of retry attempts
-          `,
-    );
-  });
-});
-
 describe("New Documentation Components", () => {
   it("ModuleDoc renders correctly", () => {
     const res = toSourceText([
@@ -1177,9 +1143,18 @@ describe("Full example", () => {
           An enum representing colors.
           """
 
-          RED = 1  #: The color red.
-          GREEN = 2  #: The color green.
-          BLUE = 3  #: The color blue.
+          RED = 1
+          """
+          The color red.
+          """
+          GREEN = 2
+          """
+          The color green.
+          """
+          BLUE = 3
+          """
+          The color blue.
+          """
 
 
     `;