@contractkit/plugin-python 0.11.5 → 0.11.7

package/.turbo/turbo-build$colon$ci.log

@@ -5,9 +5,9 @@ $ tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly
 CLI tsup v8.5.1
 CLI Target: esnext
 ESM Build start
-ESM dist/index.js     42.68 KB
-ESM dist/index.js.map 90.20 KB
-ESM ⚡️ Build success in 183ms
+ESM dist/index.js     43.30 KB
+ESM dist/index.js.map 92.85 KB
+ESM ⚡️ Build success in 274ms
 DTS Build start
-DTS ⚡️ Build success in 4903ms
+DTS ⚡️ Build success in 4814ms
 DTS dist/index.d.ts 1.10 KB

package/.turbo/turbo-test$colon$ci.log

@@ -3,22 +3,22 @@ $ vitest run --coverage
  RUN  v4.1.5 /home/runner/work/ContractKit/ContractKit/packages/plugin-python
       Coverage enabled with v8
 
- ✓ tests/codegen-client.test.ts (27 tests) 127ms
- ✓ tests/codegen-models.test.ts (32 tests) 150ms
+ ✓ tests/codegen-client.test.ts (30 tests) 70ms
+ ✓ tests/codegen-models.test.ts (36 tests) 177ms
 
  Test Files  2 passed (2)
-      Tests  59 passed (59)
-   Start at  19:14:39
-   Duration  5.03s (transform 2.04s, setup 0ms, import 6.39s, tests 278ms, environment 0ms)
+      Tests  66 passed (66)
+   Start at  17:06:40
+   Duration  5.70s (transform 2.27s, setup 0ms, import 7.55s, tests 246ms, environment 0ms)
 
  % Coverage report from v8
 -------------------|---------|----------|---------|---------|-------------------
 File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
 -------------------|---------|----------|---------|---------|-------------------
-All files          |   82.67 |    76.92 |   85.71 |   84.75 |                   
- src               |   82.36 |    77.14 |   83.33 |    84.2 |                   
-  ...gen-client.ts |    82.6 |    77.92 |   86.48 |   83.33 | ...87-507,540-541 
-  ...gen-models.ts |   82.04 |    75.97 |   79.31 |   85.32 | ...33,347-349,353 
+All files          |   83.57 |    78.28 |   86.31 |   85.13 |                   
+ src               |   83.33 |     78.6 |   84.28 |   84.61 |                   
+  ...gen-client.ts |   83.18 |    78.96 |   87.17 |   83.56 | ...02-522,555-556 
+  ...gen-models.ts |   83.53 |    78.06 |   80.64 |   85.97 | ...59,373-375,379 
  tests             |   86.66 |    74.19 |      92 |    92.1 |                   
   helpers.ts       |   86.66 |    74.19 |      92 |    92.1 | 137-141,167       
 -------------------|---------|----------|---------|---------|-------------------

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @contractkit/contractkit-plugin-python
 
+## 0.11.7
+
+### Patch Changes
+
+- 2bf01f1: Split multi-line descriptions across `#` comment lines and escape `"""` in generated method docstrings so ordinary multi-line doc comments can no longer produce invalid Python. Render the `interval` scalar as `str` and throw on an unmapped scalar type instead of falling back to `Any`.
+- Updated dependencies [2bf01f1]
+    - @contractkit/core@0.23.0
+
+## 0.11.6
+
+### Patch Changes
+
+- Updated dependencies [0d3b8e2]
+    - @contractkit/core@0.22.0
+
 ## 0.11.5
 
 ### Patch Changes

package/dist/codegen-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codegen-client.d.ts","sourceRoot":"","sources":["../src/codegen-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAqF,MAAM,mBAAmB,CAAC;AAMvI,MAAM,WAAW,oBAAoB;IACjC,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,0FAA0F;IAC1F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kDAAkD;IAClD,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,UAAQ,GAAG,OAAO,CAOtF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,GAAE,oBAAyB,GAAG,MAAM,CA0G9F;AA4XD,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ3D;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7D;AAmCD,eAAO,MAAM,cAAc,wuGAqF1B,CAAC"}
+{"version":3,"file":"codegen-client.d.ts","sourceRoot":"","sources":["../src/codegen-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAqF,MAAM,mBAAmB,CAAC;AAMvI,MAAM,WAAW,oBAAoB;IACjC,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,0FAA0F;IAC1F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kDAAkD;IAClD,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,UAAQ,GAAG,OAAO,CAOtF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,GAAE,oBAAyB,GAAG,MAAM,CA0G9F;AA2YD,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ3D;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7D;AAmCD,eAAO,MAAM,cAAc,wuGAqF1B,CAAC"}

package/dist/codegen-models.d.ts

@@ -11,6 +11,15 @@ export interface ModelCodegenOptions {
  * Generate Pydantic v2 model classes from a ContractRootNode.
  */
 export declare function generatePydanticModels(root: ContractRootNode, opts?: ModelCodegenOptions): string;
+/**
+ * Render a ContractKit type node as its Python type annotation (Pydantic v2 conventions).
+ *
+ * @param modelsWithInput - Model names that have a distinct `Input` variant; a `ref` to one of
+ *   these renders as `<Name>Input` when `forInput` is set.
+ * @param forInput - When true, request-side refs use their `Input` variant.
+ * @throws {Error} Via the scalar renderer, if a scalar name has no Python mapping (guards against
+ *   a scalar being added to core without updating this plugin).
+ */
 export declare function renderPyType(type: ContractTypeNode, modelsWithInput?: Set<string>, forInput?: boolean): string;
 /** Convert a field name to a valid Python identifier in snake_case. */
 export declare function toPythonFieldName(name: string): string;

package/dist/codegen-models.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codegen-models.d.ts","sourceRoot":"","sources":["../src/codegen-models.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAwB,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAKlG,MAAM,WAAW,mBAAmB;IAChC,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+DAA+D;IAC/D,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,GAAE,mBAAwB,GAAG,MAAM,CAwDrG;AAsGD,wBAAgB,YAAY,CAAC,IAAI,EAAE,gBAAgB,EAAE,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,UAAQ,GAAG,MAAM,CAkC5G;AAyCD,uEAAuE;AACvE,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUtD;AA0JD,kHAAkH;AAClH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ3D"}
+{"version":3,"file":"codegen-models.d.ts","sourceRoot":"","sources":["../src/codegen-models.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAwB,gBAAgB,EAAkB,MAAM,mBAAmB,CAAC;AAKlH,MAAM,WAAW,mBAAmB;IAChC,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+DAA+D;IAC/D,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,GAAE,mBAAwB,GAAG,MAAM,CAwDrG;AAsGD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,gBAAgB,EAAE,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,UAAQ,GAAG,MAAM,CAkC5G;AA6CD,uEAAuE;AACvE,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUtD;AAuKD,kHAAkH;AAClH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQ3D"}

package/dist/index.js

@@ -221,6 +221,8 @@ function renderScalar(name) {
       return "datetime";
     case "duration":
       return "timedelta";
+    case "interval":
+      return "str";
     case "uuid":
       return "UUID";
     case "null":
@@ -231,8 +233,10 @@ function renderScalar(name) {
     case "json":
     case "object":
       return "Any";
-    default:
-      return "Any";
+    default: {
+      const _exhaustive = name;
+      throw new Error(`plugin-python: unmapped scalar '${String(_exhaustive)}' \u2014 add a case`);
+    }
   }
 }
 __name(renderScalar, "renderScalar");
@@ -244,6 +248,10 @@ function toPythonFieldName(name) {
   return result;
 }
 __name(toPythonFieldName, "toPythonFieldName");
+function commentLines(text, indent) {
+  return text.split("\n").map((line) => `${indent}# ${line}`);
+}
+__name(commentLines, "commentLines");
 function generateModel(model, allModelsWithInput, imports) {
   if (model.type) {
     return generateTypeAlias(model, allModelsWithInput, imports);
@@ -257,7 +265,7 @@ function generateModel(model, allModelsWithInput, imports) {
 __name(generateModel, "generateModel");
 function generateTypeAlias(model, allModelsWithInput, _) {
   const lines = [];
-  if (model.description) lines.push(`# ${model.description}`);
+  if (model.description) lines.push(...commentLines(model.description, ""));
   if (model.deprecated) lines.push("# @deprecated");
   lines.push(`${model.name} = ${renderPyType(model.type, allModelsWithInput)}`);
   if (allModelsWithInput.has(model.name)) {
@@ -268,7 +276,7 @@ function generateTypeAlias(model, allModelsWithInput, _) {
 __name(generateTypeAlias, "generateTypeAlias");
 function generateSimpleModel(model, allModelsWithInput, imports) {
   const lines = [];
-  if (model.description) lines.push(`# ${model.description}`);
+  if (model.description) lines.push(...commentLines(model.description, ""));
   if (model.deprecated) lines.push("# @deprecated");
   const baseList = model.bases && model.bases.length > 0 ? model.bases.join(", ") : "BaseModel";
   lines.push(`class ${model.name}(${baseList}):`);
@@ -290,7 +298,7 @@ __name(generateSimpleModel, "generateSimpleModel");
 function generateSplitModel(model, allModelsWithInput, imports) {
   const lines = [];
   const readFields = model.fields.filter((f) => f.visibility !== "writeonly");
-  if (model.description) lines.push(`# ${model.description}`);
+  if (model.description) lines.push(...commentLines(model.description, ""));
   if (model.deprecated) lines.push("# @deprecated");
   const readBaseList = model.bases && model.bases.length > 0 ? model.bases.join(", ") : "BaseModel";
   lines.push(`class ${model.name}(${readBaseList}):`);
@@ -350,7 +358,7 @@ function renderField(field, allModelsWithInput, imports, forInput) {
     fieldAnnotations.push(`default=${def}`);
   }
   if (field.deprecated) lines.push(`    # @deprecated`);
-  if (field.description) lines.push(`    # ${field.description}`);
+  if (field.description) lines.push(...commentLines(field.description, "    "));
   let rhs;
   if (fieldAnnotations.length > 0) {
     imports.add("pydantic", "Field");
@@ -511,8 +519,8 @@ function generateMethod(route, op, opts) {
   if (op.name || desc) {
     lines.push(`    async def ${methodName}(${selfParam}${paramStr}) -> ${returnType}:`);
     lines.push(`        """`);
-    if (op.name) lines.push(`        ${op.name}`);
-    if (desc) lines.push(`        ${desc}`);
+    if (op.name) lines.push(...docstringLines(op.name, "        "));
+    if (desc) lines.push(...docstringLines(desc, "        "));
     lines.push(`        """`);
   } else {
     lines.push(`    async def ${methodName}(${selfParam}${paramStr}) -> ${returnType}:`);
@@ -596,6 +604,14 @@ function buildHeadersDictLines(headers, typeName) {
   return lines;
 }
 __name(buildHeadersDictLines, "buildHeadersDictLines");
+function docstringLines(text, indent) {
+  return text.split("\n").map((line) => {
+    let safe = line.replace(/"/g, '\\"');
+    if (/\\$/.test(safe)) safe += " ";
+    return `${indent}${safe}`;
+  });
+}
+__name(docstringLines, "docstringLines");
 function snakeToPascal(s) {
   return s.split("_").filter(Boolean).map((p) => p.charAt(0).toUpperCase() + p.slice(1)).join("");
 }