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

package/dist/src/components/PropertyDeclaration.d.ts

@@ -0,0 +1,71 @@
+import { Children, Refkey } from "@alloy-js/core";
+import { CommonFunctionProps } from "./FunctionBase.js";
+/**
+ * Declares a Python property with optional getter, setter, and deleter methods.
+ *
+ * @example
+ * ```tsx
+ * <py.PropertyDeclaration name="name" type={{ children: "str" }}>
+ *   return self._name
+ * </py.PropertyDeclaration>
+ * ```
+ * Generates:
+ * ```python
+ * @property
+ * def name(self) -> str:
+ *     return self._name
+ * ```
+ *
+ * @example Setter and deleter
+ * ```tsx
+ * <py.PropertyDeclaration name="value" type={{ children: "int" }}>
+ *   return self._value
+ *   <py.PropertyDeclaration.Setter type={{ children: "int" }}>
+ *     self._value = value
+ *   </py.PropertyDeclaration.Setter>
+ *   <py.PropertyDeclaration.Deleter>
+ *     del self._value
+ *   </py.PropertyDeclaration.Deleter>
+ * </py.PropertyDeclaration>
+ * ```
+ * Generates:
+ * ```python
+ * @property
+ * def value(self) -> int:
+ *     return self._value
+ *
+ * @value.setter
+ * def value(self, value: int) -> None:
+ *     self._value = value
+ *
+ * @value.deleter
+ * def value(self) -> None:
+ *     del self._value
+ * ```
+ *
+ * @remarks
+ * The property must be declared within a class. The getter method is
+ * automatically generated using the `@property` decorator. Use the nested
+ * `Setter` and `Deleter` components to add mutators.
+ */
+export interface PropertyDeclarationProps {
+    name: string;
+    type?: Children;
+    children?: Children;
+    refkey?: Refkey;
+    abstract?: boolean;
+    doc?: Children;
+}
+export declare function PropertyDeclaration(props: PropertyDeclarationProps): Children;
+export declare namespace PropertyDeclaration {
+    var Setter: import("@alloy-js/core").Component<PropertyMethodDeclarationProps & {
+        type?: Children;
+    }> & Required<Pick<import("@alloy-js/core").Component<PropertyMethodDeclarationProps & {
+        type?: Children;
+    }>, "tag">>;
+    var Deleter: import("@alloy-js/core").Component<Omit<PropertyMethodDeclarationProps, "returnType">> & Required<Pick<import("@alloy-js/core").Component<Omit<PropertyMethodDeclarationProps, "returnType">>, "tag">>;
+}
+export interface PropertyMethodDeclarationProps extends Omit<CommonFunctionProps, "name"> {
+    abstract?: boolean;
+}
+//# sourceMappingURL=PropertyDeclaration.d.ts.map

package/dist/src/components/PropertyDeclaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyDeclaration.d.ts","sourceRoot":"","sources":["../../../src/components/PropertyDeclaration.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EAGR,MAAM,EASP,MAAM,gBAAgB,CAAC;AAKxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AASxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,GAAG,CAAC,EAAE,QAAQ,CAAC;CAChB;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,YA+DlE;yBA/De,mBAAmB;;eA6IkB,QAAQ;;eAAR,QAAQ;;;;AA5E7D,MAAM,WAAW,8BACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/dist/src/components/PropertyDeclaration.js

@@ -0,0 +1,227 @@
+import { createComponent as _$createComponent, memo as _$memo, mergeProps as _$mergeProps, createIntrinsic as _$createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { DeclarationContext, List, Show, childrenArray, code, createContext, findKeyedChild, findUnkeyedChildren, taggedComponent, useContext } from "@alloy-js/core";
+import { createMethodSymbol } from "../symbols/factories.js";
+import { Atom } from "./Atom.js";
+import { MethodDeclarationBase } from "./MethodBase.js";
+const setterTag = Symbol();
+const deleterTag = Symbol();
+
+/** Context to provide property type information within a PropertyDeclaration */
+const PropertyContext = createContext();
+
+/**
+ * Declares a Python property with optional getter, setter, and deleter methods.
+ *
+ * @example
+ * ```tsx
+ * <py.PropertyDeclaration name="name" type={{ children: "str" }}>
+ *   return self._name
+ * </py.PropertyDeclaration>
+ * ```
+ * Generates:
+ * ```python
+ * @property
+ * def name(self) -> str:
+ *     return self._name
+ * ```
+ *
+ * @example Setter and deleter
+ * ```tsx
+ * <py.PropertyDeclaration name="value" type={{ children: "int" }}>
+ *   return self._value
+ *   <py.PropertyDeclaration.Setter type={{ children: "int" }}>
+ *     self._value = value
+ *   </py.PropertyDeclaration.Setter>
+ *   <py.PropertyDeclaration.Deleter>
+ *     del self._value
+ *   </py.PropertyDeclaration.Deleter>
+ * </py.PropertyDeclaration>
+ * ```
+ * Generates:
+ * ```python
+ * @property
+ * def value(self) -> int:
+ *     return self._value
+ *
+ * @value.setter
+ * def value(self, value: int) -> None:
+ *     self._value = value
+ *
+ * @value.deleter
+ * def value(self) -> None:
+ *     del self._value
+ * ```
+ *
+ * @remarks
+ * The property must be declared within a class. The getter method is
+ * automatically generated using the `@property` decorator. Use the nested
+ * `Setter` and `Deleter` components to add mutators.
+ */
+
+export function PropertyDeclaration(props) {
+  const nonEmptyOrNotImplemented = children => {
+    if (children && childrenArray(() => children).length > 0) {
+      return children;
+    } else {
+      return [code`raise NotImplementedError`];
+    }
+  };
+  const children = childrenArray(() => props.children);
+  const setterComponent = findKeyedChild(children, PropertyDeclaration.Setter.tag) ?? undefined;
+  const deleterComponent = findKeyedChild(children, PropertyDeclaration.Deleter.tag) ?? undefined;
+  const setterChildren = nonEmptyOrNotImplemented(setterComponent?.props?.children);
+  const deleterChildren = nonEmptyOrNotImplemented(deleterComponent?.props?.children);
+  const unkeyedChildren = nonEmptyOrNotImplemented(findUnkeyedChildren(children));
+  const sym = createMethodSymbol(props.name, {
+    refkeys: props.refkey
+  });
+  return [_$createComponent(DeclarationContext.Provider, {
+    value: sym,
+    get children() {
+      return _$createComponent(PropertyContext.Provider, {
+        get value() {
+          return props.type;
+        },
+        get children() {
+          return _$createComponent(List, {
+            hardline: true,
+            enderPunctuation: true,
+            get children() {
+              return [_$createComponent(PropertyMethodDeclaration, {
+                get abstract() {
+                  return props.abstract;
+                },
+                get doc() {
+                  return props.doc;
+                },
+                children: unkeyedChildren
+              }), _$createComponent(Show, {
+                get when() {
+                  return Boolean(setterComponent);
+                },
+                get children() {
+                  return _$createComponent(PropertyDeclaration.Setter, _$mergeProps(() => setterComponent?.props, {
+                    get type() {
+                      return setterComponent?.props?.type ?? props.type;
+                    },
+                    get abstract() {
+                      return setterComponent?.props?.abstract ?? props.abstract;
+                    },
+                    children: setterChildren
+                  }));
+                }
+              }), _$createComponent(Show, {
+                get when() {
+                  return Boolean(deleterComponent);
+                },
+                get children() {
+                  return _$createComponent(PropertyDeclaration.Deleter, _$mergeProps(() => deleterComponent?.props, {
+                    get abstract() {
+                      return deleterComponent?.props?.abstract ?? props.abstract;
+                    },
+                    children: deleterChildren
+                  }));
+                }
+              })];
+            }
+          });
+        }
+      });
+    }
+  })];
+}
+function PropertyMethodDeclaration(props) {
+  const propertySymbol = useContext(DeclarationContext);
+  const propertyType = useContext(PropertyContext);
+  return [code`@property`, _$createIntrinsic("hbr", {}), _$createComponent(MethodDeclarationBase, _$mergeProps(props, {
+    get name() {
+      return propertySymbol.name;
+    },
+    functionType: "instance",
+    returnType: propertyType,
+    sym: propertySymbol,
+    get children() {
+      return props.children;
+    }
+  }))];
+}
+function PropertyMethodBase(props) {
+  const propertySymbol = useContext(DeclarationContext);
+  const {
+    decoratorType,
+    parameters,
+    children,
+    ...restProps
+  } = props;
+  return [_$memo(() => code`@${propertySymbol.name}.${decoratorType}`), _$createIntrinsic("hbr", {}), _$createComponent(MethodDeclarationBase, _$mergeProps(restProps, {
+    get name() {
+      return propertySymbol.name;
+    },
+    functionType: "instance",
+    parameters: parameters,
+    get returnType() {
+      return _$createComponent(Atom, {
+        jsValue: null
+      });
+    },
+    sym: propertySymbol,
+    children: children
+  }))];
+}
+
+/**
+ * Adds a setter to a `PropertyDeclaration`.
+ *
+ * @example
+ * ```tsx
+ * <py.PropertyDeclaration name="value" type={{ children: "int" }}>
+ *   return self._value
+ *   <py.PropertyDeclaration.Setter type={{ children: "int" }}>
+ *     self._value = value
+ *   </py.PropertyDeclaration.Setter>
+ * </py.PropertyDeclaration>
+ * ```
+ * Generates:
+ * ```python
+ * @value.setter
+ * def value(self, value: int) -> None:
+ *     self._value = value
+ * ```
+ */
+PropertyDeclaration.Setter = taggedComponent(setterTag, function PropertySetter(props) {
+  return _$createComponent(PropertyMethodBase, _$mergeProps({
+    decoratorType: "setter",
+    get parameters() {
+      return [{
+        name: "value",
+        type: props.type
+      }];
+    }
+  }, props));
+});
+
+/**
+ * Adds a deleter to a `PropertyDeclaration`.
+ *
+ * @example
+ * ```tsx
+ * <py.PropertyDeclaration name="value" type={{ children: "int" }}>
+ *   return self._value
+ *   <py.PropertyDeclaration.Deleter>
+ *     del self._value
+ *   </py.PropertyDeclaration.Deleter>
+ * </py.PropertyDeclaration>
+ * ```
+ * Generates:
+ * ```python
+ * @value.deleter
+ * def value(self) -> None:
+ *     del self._value
+ * ```
+ */
+PropertyDeclaration.Deleter = taggedComponent(deleterTag, function PropertyDeleter(props) {
+  return _$createComponent(PropertyMethodBase, _$mergeProps({
+    decoratorType: "deleter"
+  }, props));
+});
+//# sourceMappingURL=PropertyDeclaration.js.map

package/dist/src/components/PropertyDeclaration.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["DeclarationContext","List","Show","childrenArray","code","createContext","findKeyedChild","findUnkeyedChildren","taggedComponent","useContext","createMethodSymbol","Atom","MethodDeclarationBase","setterTag","Symbol","deleterTag","PropertyContext","PropertyDeclaration","props","nonEmptyOrNotImplemented","children","length","setterComponent","Setter","tag","undefined","deleterComponent","Deleter","setterChildren","deleterChildren","unkeyedChildren","sym","name","refkeys","refkey","_$createComponent","Provider","value","type","hardline","enderPunctuation","PropertyMethodDeclaration","abstract","doc","when","Boolean","_$mergeProps","propertySymbol","propertyType","_$createIntrinsic","functionType","returnType","PropertyMethodBase","decoratorType","parameters","restProps","_$memo","jsValue","PropertySetter","PropertyDeleter"],"sources":["../../../src/components/PropertyDeclaration.tsx"],"sourcesContent":[null],"mappings":";AAAA,SAEEA,kBAAkB,EAClBC,IAAI,EAEJC,IAAI,EACJC,aAAa,EACbC,IAAI,EACJC,aAAa,EACbC,cAAc,EACdC,mBAAmB,EACnBC,eAAe,EACfC,UAAU,QACL,gBAAgB;AAGvB,SAASC,kBAAkB,QAAQ,yBAAyB;AAC5D,SAASC,IAAI;AAEb,SAASC,qBAAqB,QAAQ,iBAAiB;AAEvD,MAAMC,SAAS,GAAGC,MAAM,CAAC,CAAC;AAC1B,MAAMC,UAAU,GAAGD,MAAM,CAAC,CAAC;;AAE3B;AACA,MAAME,eAAe,GAAGX,aAAa,CAAuB,CAAC;;AAE7D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,OAAO,SAASY,mBAAmBA,CAACC,KAA+B,EAAE;EACnE,MAAMC,wBAAwB,GAC5BC,QAA8B,IACjB;IACb,IAAIA,QAAQ,IAAIjB,aAAa,CAAC,MAAMiB,QAAQ,CAAC,CAACC,MAAM,GAAG,CAAC,EAAE;MACxD,OAAOD,QAAQ;IACjB,CAAC,MAAM;MACL,OAAO,CAAChB,IAAI,2BAA2B,CAAC;IAC1C;EACF,CAAC;EAED,MAAMgB,QAAQ,GAAGjB,aAAa,CAAC,MAAMe,KAAK,CAACE,QAAQ,CAAC;EACpD,MAAME,eAAe,GACnBhB,cAAc,CAACc,QAAQ,EAAEH,mBAAmB,CAACM,MAAM,CAACC,GAAG,CAAC,IAAIC,SAAS;EACvE,MAAMC,gBAAgB,GACpBpB,cAAc,CAACc,QAAQ,EAAEH,mBAAmB,CAACU,OAAO,CAACH,GAAG,CAAC,IAAIC,SAAS;EAExE,MAAMG,cAAc,GAAGT,wBAAwB,CAC7CG,eAAe,EAAEJ,KAAK,EAAEE,QAC1B,CAAC;EACD,MAAMS,eAAe,GAAGV,wBAAwB,CAC9CO,gBAAgB,EAAER,KAAK,EAAEE,QAC3B,CAAC;EACD,MAAMU,eAAe,GAAGX,wBAAwB,CAC9CZ,mBAAmB,CAACa,QAAQ,CAC9B,CAAC;EAED,MAAMW,GAAuB,GAAGrB,kBAAkB,CAACQ,KAAK,CAACc,IAAI,EAAE;IAC7DC,OAAO,EAAEf,KAAK,CAACgB;EACjB,CAAC,CAAC;EACF,QAAAC,iBAAA,CAEKnC,kBAAkB,CAACoC,QAAQ;IAACC,KAAK,EAAEN,GAAG;IAAA,IAAAX,SAAA;MAAA,OAAAe,iBAAA,CACpCnB,eAAe,CAACoB,QAAQ;QAAA,IAACC,KAAKA,CAAA;UAAA,OAAEnB,KAAK,CAACoB,IAAI;QAAA;QAAA,IAAAlB,SAAA;UAAA,OAAAe,iBAAA,CACxClC,IAAI;YAACsC,QAAQ;YAACC,gBAAgB;YAAA,IAAApB,SAAA;cAAA,QAAAe,iBAAA,CAC5BM,yBAAyB;gBAAA,IACxBC,QAAQA,CAAA;kBAAA,OAAExB,KAAK,CAACwB,QAAQ;gBAAA;gBAAA,IACxBC,GAAGA,CAAA;kBAAA,OAAEzB,KAAK,CAACyB,GAAG;gBAAA;gBAAAvB,QAAA,EAEbU;cAAe,IAAAK,iBAAA,CAEjBjC,IAAI;gBAAA,IAAC0C,IAAIA,CAAA;kBAAA,OAAEC,OAAO,CAACvB,eAAe,CAAC;gBAAA;gBAAA,IAAAF,SAAA;kBAAA,OAAAe,iBAAA,CACjClB,mBAAmB,CAACM,MAAM,EAAAuB,YAAA,OACrBxB,eAAe,EAAEJ,KAAK;oBAAA,IAC1BoB,IAAIA,CAAA;sBAAA,OAAEhB,eAAe,EAAEJ,KAAK,EAAEoB,IAAI,IAAIpB,KAAK,CAACoB,IAAI;oBAAA;oBAAA,IAChDI,QAAQA,CAAA;sBAAA,OAAEpB,eAAe,EAAEJ,KAAK,EAAEwB,QAAQ,IAAIxB,KAAK,CAACwB,QAAQ;oBAAA;oBAAAtB,QAAA,EAE3DQ;kBAAc;gBAAA;cAAA,IAAAO,iBAAA,CAGlBjC,IAAI;gBAAA,IAAC0C,IAAIA,CAAA;kBAAA,OAAEC,OAAO,CAACnB,gBAAgB,CAAC;gBAAA;gBAAA,IAAAN,SAAA;kBAAA,OAAAe,iBAAA,CAClClB,mBAAmB,CAACU,OAAO,EAAAmB,YAAA,OACtBpB,gBAAgB,EAAER,KAAK;oBAAA,IAC3BwB,QAAQA,CAAA;sBAAA,OAAEhB,gBAAgB,EAAER,KAAK,EAAEwB,QAAQ,IAAIxB,KAAK,CAACwB,QAAQ;oBAAA;oBAAAtB,QAAA,EAE5DS;kBAAe;gBAAA;cAAA;YAAA;UAAA;QAAA;MAAA;IAAA;EAAA;AAQhC;AAOA,SAASY,yBAAyBA,CAACvB,KAAqC,EAAE;EACxE,MAAM6B,cAAc,GAAGtC,UAAU,CAACT,kBAAkB,CAAuB;EAC3E,MAAMgD,YAAY,GAAGvC,UAAU,CAACO,eAAe,CAAC;EAEhD,QAEKZ,IAAI,WAAW,EAAA6C,iBAAA,aAAAd,iBAAA,CAEfvB,qBAAqB,EAAAkC,YAAA,CAChB5B,KAAK;IAAA,IACTc,IAAIA,CAAA;MAAA,OAAEe,cAAc,CAACf,IAAI;IAAA;IACzBkB,YAAY;IACZC,UAAU,EAAEH,YAAY;IACxBjB,GAAG,EAAEgB,cAAc;IAAA,IAAA3B,SAAA;MAAA,OAElBF,KAAK,CAACE,QAAQ;IAAA;EAAA;AAIvB;AAQA,SAASgC,kBAAkBA,CAAClC,KAA8B,EAAE;EAC1D,MAAM6B,cAAc,GAAGtC,UAAU,CAACT,kBAAkB,CAAuB;EAC3E,MAAM;IAAEqD,aAAa;IAAEC,UAAU;IAAElC,QAAQ;IAAE,GAAGmC;EAAU,CAAC,GAAGrC,KAAK;EAEnE,QAAAsC,MAAA,OAEKpD,IAAI,IAAI2C,cAAc,CAACf,IAAI,IAAIqB,aAAa,EAAE,GAAAJ,iBAAA,aAAAd,iBAAA,CAE9CvB,qBAAqB,EAAAkC,YAAA,CAChBS,SAAS;IAAA,IACbvB,IAAIA,CAAA;MAAA,OAAEe,cAAc,CAACf,IAAI;IAAA;IACzBkB,YAAY;IACZI,UAAU,EAAEA,UAAU;IAAA,IACtBH,UAAUA,CAAA;MAAA,OAAAhB,iBAAA,CAAGxB,IAAI;QAAC8C,OAAO,EAAE;MAAI;IAAA;IAC/B1B,GAAG,EAAEgB,cAAc;IAAA3B,QAAA,EAElBA;EAAQ;AAIjB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACAH,mBAAmB,CAACM,MAAM,GAAGf,eAAe,CAC1CK,SAAS,EACT,SAAS6C,cAAcA,CACrBxC,KAA2D,EAC3D;EACA,OAAAiB,iBAAA,CACGiB,kBAAkB,EAAAN,YAAA;IACjBO,aAAa;IAAA,IACbC,UAAUA,CAAA;MAAA,OAAE,CAAC;QAAEtB,IAAI,EAAE,OAAO;QAAEM,IAAI,EAAEpB,KAAK,CAACoB;MAAK,CAAC,CAAC;IAAA;EAAA,GAC7CpB,KAAK;AAGf,CACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACAD,mBAAmB,CAACU,OAAO,GAAGnB,eAAe,CAC3CO,UAAU,EACV,SAAS4C,eAAeA,CACtBzC,KAAyD,EACzD;EACA,OAAAiB,iBAAA,CAAQiB,kBAAkB,EAAAN,YAAA;IAACO,aAAa;EAAA,GAAenC,KAAK;AAC9D,CACF,CAAC","ignoreList":[]}

package/dist/src/components/PyDoc.d.ts

@@ -1,76 +1,125 @@
 import { Children } from "@alloy-js/core/jsx-runtime";
 import { ParameterDescriptor } from "../parameter-descriptor.js";
-export interface GoogleStyleDocParamProps {
-    name: Children;
-    type?: Children;
-    children?: Children;
-    optional?: boolean;
-    defaultValue?: Children;
-}
-/**
- * Create a GoogleStyleDoc parameter.
- */
-export declare function GoogleStyleDocParam(props: GoogleStyleDocParamProps): Children;
-export interface GoogleStyleDocParamsProps {
-    parameters: ParameterDescriptor[] | string[];
+export interface FunctionDocProps {
+    description: Children[];
+    parameters?: ParameterDescriptor[];
+    returns?: string;
+    yields?: string;
+    raises?: string[];
+    examples?: Children[];
+    seeAlso?: string[];
+    warning?: string;
+    deprecated?: string;
+    note?: string;
+    style?: "google";
 }
 /**
- * A component that creates a GoogleStyleDoc block for parameters.
+ * A component that creates a FunctionDoc block for functions.
  */
-export declare function GoogleStyleDocParams(props: GoogleStyleDocParamsProps): Children;
-export interface GoogleStyleDocReturnProps {
-    message: string;
+export declare function FunctionDoc(props: FunctionDocProps): Children;
+export interface ClassDocProps {
+    description: Children[];
+    parameters?: ParameterDescriptor[];
+    attributes?: GoogleStyleDocAttributeProps[];
+    examples?: Children[];
+    seeAlso?: string[];
+    warning?: string;
+    deprecated?: string;
+    note?: string;
+    style?: "google";
 }
 /**
- * A component that creates a GoogleStyleDoc block for parameters.
+ * A component that creates a ClassDoc block for classes.
  */
-export declare function GoogleStyleDocReturn(props: GoogleStyleDocReturnProps): Children;
-export interface GoogleStyleDocRaisesProps {
-    message: string;
+export declare function ClassDoc(props: ClassDocProps): Children;
+export interface ModuleDocProps {
+    description: Children[];
+    attributes?: GoogleStyleDocAttributeProps[];
+    examples?: Children[];
+    seeAlso?: string[];
+    warning?: string;
+    deprecated?: string;
+    todo?: string[];
+    style?: "google";
 }
 /**
- * A component that creates a GoogleStyleDoc block for parameters.
+ * A component that creates a ModuleDoc block for module-level documentation.
  */
-export declare function GoogleStyleDocRaises(props: GoogleStyleDocRaisesProps): Children;
-export interface GoogleStyleFunctionDocProps extends Omit<FunctionDocProps, "style"> {
+export declare function ModuleDoc(props: ModuleDocProps): Children;
+export interface PropertyDocProps {
+    description: Children[];
+    returns?: string;
+    examples?: Children[];
+    seeAlso?: string[];
+    warning?: string;
+    deprecated?: string;
+    note?: string;
+    style?: "google";
 }
 /**
- * A component that creates a GoogleStyleFunctionDoc block for parameters.
+ * A component that creates a PropertyDoc block for `@property` decorated methods.
  */
-export declare function GoogleStyleFunctionDoc(props: GoogleStyleFunctionDocProps): Children;
-export interface FunctionDocProps {
+export declare function PropertyDoc(props: PropertyDocProps): Children;
+export interface GeneratorDocProps {
     description: Children[];
-    parameters?: ParameterDescriptor[] | string[];
-    returns?: string;
+    parameters?: ParameterDescriptor[];
+    yields?: string;
     raises?: string[];
+    examples?: Children[];
+    seeAlso?: string[];
+    warning?: string;
+    deprecated?: string;
+    note?: string;
     style?: "google";
 }
 /**
- * A component that creates a FunctionDoc block for parameters.
+ * A component that creates a GeneratorDoc block for generator functions.
  */
-export declare function FunctionDoc(props: FunctionDocProps): Children;
-export interface ClassDocProps {
+export declare function GeneratorDoc(props: GeneratorDocProps): Children;
+export interface ExceptionDocProps {
     description: Children[];
-    parameters?: ParameterDescriptor[] | string[];
+    parameters?: ParameterDescriptor[];
+    attributes?: GoogleStyleDocAttributeProps[];
+    examples?: Children[];
+    seeAlso?: string[];
+    warning?: string;
+    deprecated?: string;
+    note?: string;
     style?: "google";
 }
 /**
- * A component that creates a ClassDoc block for parameters.
+ * A component that creates an ExceptionDoc block for custom exception classes.
  */
-export declare function ClassDoc(props: ClassDocProps): Children;
-export interface GoogleStyleClassDocProps extends Omit<ClassDocProps, "style"> {
+export declare function ExceptionDoc(props: ExceptionDocProps): Children;
+export interface AttributeDocProps {
+    name: Children;
+    type?: Children;
+    children?: Children;
+    style?: "google";
 }
 /**
- * A component that creates a GoogleStyleClassDoc block for parameters.
+ * A component that creates documentation for a single attribute.
+ * This can be used for both inline and block attribute documentation.
  */
-export declare function GoogleStyleClassDoc(props: GoogleStyleClassDocProps): Children;
-export interface PyDocExampleProps {
-    children: Children;
+export declare function AttributeDoc(props: AttributeDocProps): Children;
+export interface MethodDocProps {
+    description: Children[];
+    parameters?: ParameterDescriptor[];
+    returns?: string;
+    raises?: string[];
+    examples?: Children[];
+    seeAlso?: string[];
+    warning?: string;
+    deprecated?: string;
+    note?: string;
+    overrides?: string;
+    style?: "google";
 }
 /**
- * Create a PyDoc example, which is prepended by \>\>.
+ * A component that creates a MethodDoc block for class methods.
+ * Automatically adds a note about not including 'self' parameter if no custom note is provided.
  */
-export declare function PyDocExample(props: PyDocExampleProps): Children;
+export declare function MethodDoc(props: MethodDocProps): Children;
 export interface PyDocProps {
     children: Children;
 }
@@ -79,6 +128,13 @@ export interface PyDocProps {
  * linebreaks. This is useful for creating PyDoc comments with multiple paragraphs.
  */
 export declare function PyDoc(props: PyDocProps): Children;
+export interface PyDocExampleProps {
+    children: Children;
+}
+/**
+ * Create a PyDoc example, which is prepended by \>\>.
+ */
+export declare function PyDocExample(props: PyDocExampleProps): Children;
 export interface SimpleCommentBlockProps {
     children: Children;
 }
@@ -87,4 +143,13 @@ export interface SimpleInlineCommentProps {
     children: Children;
 }
 export declare function SimpleInlineComment(props: SimpleInlineCommentProps): Children;
+export interface SimpleInlineCommentProps {
+    children: Children;
+}
+export declare function SimpleInlineMemberComment(props: SimpleInlineCommentProps): Children;
+export interface GoogleStyleDocAttributeProps {
+    name: Children;
+    type?: Children;
+    children?: Children;
+}
 //# sourceMappingURL=PyDoc.d.ts.map

package/dist/src/components/PyDoc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PyDoc.d.ts","sourceRoot":"","sources":["../../../src/components/PyDoc.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAmDjE,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,QAAQ,CAAC;CACzB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,YAWlE;AAED,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,mBAAmB,EAAE,GAAG,MAAM,EAAE,CAAC;CAC9C;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,YAoBpE;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,YAOpE;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,YAOpE;AAED,MAAM,WAAW,2BACf,SAAQ,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC;CAAG;AAE5C;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,YAqBxE;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,mBAAmB,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,YAYlD;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,mBAAmB,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9C,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,YAU5C;AAED,MAAM,WAAW,wBACf,SAAQ,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC;CAAG;AAEzC;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,YAalE;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,YA8BpD;AAYD,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,UAAU,YAYtC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,YAShE;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,YAMlE"}
+{"version":3,"file":"PyDoc.d.ts","sourceRoot":"","sources":["../../../src/components/PyDoc.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGjE,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,YAWlD;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,UAAU,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAC5C,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,YAW5C;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAC5C,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,YAW9C;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,YAWlD;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,YAWpD;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,UAAU,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAC5C,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,YAWpD;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,YAWpD;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,YAY9C;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,UAAU,YAYtC;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,YA8BpD;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,YAShE;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,wBAAwB,YAMlE;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,wBAAwB,YAMxE;AAgYD,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB"}