Merge pull request #24 from adrianhdezm/codex/fix-dict-comments-indentation-for-description

Fix typed dict docstring indentation

Author: adrianhdezm

src/utils/json-schema-to-typed-dict.ts

@@ -60,7 +60,12 @@ export function convertToTypedDict(name: string, schema: OpenAPI.SchemaObject |
         fields.push(`    ${key}: ${typeStr}`);
       }
       if (desc) {
-        attrLines.push(`${key}: ${desc.replace(/\n/g, ' ')}`);
+        const descLines = String(desc).split('\n');
+        attrLines.push(`${key}:`);
+        for (const dl of descLines) {
+          attrLines.push(`    ${dl}`);
+        }
+        attrLines.push('');
       }
     }
     if (fields.length === 0) {
@@ -73,14 +78,15 @@ export function convertToTypedDict(name: string, schema: OpenAPI.SchemaObject |
       docLines.push((flat.description as string).replace(/\n/g, ' '));
     }
     if (attrLines.length > 0) {
+      if (attrLines[attrLines.length - 1] === '') attrLines.pop();
       if (flat.description) docLines.push('');
       docLines.push('Attributes:');
       for (const line of attrLines) {
         docLines.push(`    ${line}`);
       }
     }
     if (docLines.length > 0) {
-      header.push(`    """\n    ${docLines.join('\n')}\n    """`);
+      header.push(`    """\n    ${docLines.join('\n    ')}\n    """`);
     }
     extraDefs.push(`${header.join('\n')}\n${fields.join('\n')}`);
   }
@@ -172,7 +178,12 @@ export function convertToTypedDict(name: string, schema: OpenAPI.SchemaObject |
         fields.push(`    ${key}: ${typeStr}`);
       }
       if (desc) {
-        attrLines.push(`${key}: ${desc.replace(/\n/g, ' ')}`);
+        const descLines = String(desc).split('\n');
+        attrLines.push(`${key}:`);
+        for (const dl of descLines) {
+          attrLines.push(`    ${dl}`);
+        }
+        attrLines.push('');
       }
     }
     if (fields.length === 0) {
@@ -185,14 +196,15 @@ export function convertToTypedDict(name: string, schema: OpenAPI.SchemaObject |
       docLines.push((flat.description as string).replace(/\n/g, ' '));
     }
     if (attrLines.length > 0) {
+      if (attrLines[attrLines.length - 1] === '') attrLines.pop();
       if (flat.description) docLines.push('');
       docLines.push('Attributes:');
       for (const line of attrLines) {
         docLines.push(`    ${line}`);
       }
     }
     if (docLines.length > 0) {
-      header.push(`    """\n    ${docLines.join('\n')}\n    """`);
+      header.push(`    """\n    ${docLines.join('\n    ')}\n    """`);
     }
     definition = `${header.join('\n')}\n${fields.join('\n')}`;
   } else {

tests/__snapshots__/json-schema-to-typed-dict.spec.ts.snap

@@ -4,13 +4,31 @@ exports[`generate-python-dict > adds descriptions as comments 1`] = `
 "class User(TypedDict, total=False):
     """
     User object
-
-Attributes:
-    id: identifier
+    
+    Attributes:
+        id:
+            identifier
     """
     id: Required[str]"
 `;
 
+exports[`generate-python-dict > formats multiline attribute descriptions 1`] = `
+"class Multi(TypedDict, total=False):
+    """
+    Multi attr example
+    
+    Attributes:
+        id:
+            identifier
+            first line
+        
+        name:
+            the name
+    """
+    id: str
+    name: str"
+`;
+
 exports[`generate-python-dict > generates a simple object schema 1`] = `
 "from typing import TypedDict, Required
 class User(TypedDict, total=False):

tests/json-schema-to-typed-dict.spec.ts

@@ -74,6 +74,29 @@ describe('generate-python-dict', () => {
     expect(definition).toMatchSnapshot();
   });
 
+  it('formats multiline attribute descriptions', () => {
+    const doc: OpenAPI.Document = {
+      openapi: '3.1.0',
+      info: { title: 't', version: '1' },
+      paths: {},
+      components: {
+        schemas: {
+          Multi: {
+            type: 'object',
+            description: 'Multi attr example',
+            properties: {
+              id: { type: 'string', description: 'identifier\nfirst line' },
+              name: { type: 'string', description: 'the name' }
+            }
+          }
+        }
+      }
+    };
+    const schemas = extractSchemas(doc, null);
+    const { definition } = convertToTypedDict('Multi', schemas.Multi as OpenAPI.SchemaObject);
+    expect(definition).toMatchSnapshot();
+  });
+
   it('handles allOf with refs and properties', () => {
     const doc: OpenAPI.Document = {
       openapi: '3.1.0',