cddl2py 0.1.0 → 0.1.2

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,KAAK,UAAU,EAGlB,MAAM,MAAM,CAAA;AAKb,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB;AAgBD,wBAAgB,SAAS,CAAE,WAAW,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAuBxF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,KAAK,UAAU,EAGlB,MAAM,MAAM,CAAA;AAKb,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB;AAkBD,wBAAgB,SAAS,CAAE,WAAW,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAuBxF"}

package/build/index.js

@@ -1,6 +1,7 @@
 import { isCDDLArray, isGroup, isNamedGroupReference, isLiteralWithValue, isNativeTypeWithOperator, isUnNamedProperty, isPropertyReference, isRange, isVariable, pascalCase } from 'cddl';
 import { snakeCase } from './utils.js';
 import { pkg, NATIVE_TYPE_MAP } from './constants.js';
+const STRING_RECORD_KEY_TYPES = new Set(['str', 'text', 'tstr']);
 export function transform(assignments, options) {
     const ctx = {
         pydantic: options?.pydantic ?? false,
@@ -88,6 +89,7 @@ function generateGroup(group, ctx) {
         return comments + generateGroupWithChoices(name, properties, ctx);
     }
     const props = properties;
+    const extraItemsType = getExtraItemsType(props, ctx);
     if (props.length === 1) {
         const prop = props[0];
         const propType = Array.isArray(prop.Type) ? prop.Type : [prop.Type];
@@ -101,7 +103,7 @@ function generateGroup(group, ctx) {
         }
     }
     const mixins = props.filter(isUnNamedProperty);
-    const ownProps = props.filter(p => !isUnNamedProperty(p));
+    const ownProps = props.filter(p => !isUnNamedProperty(p) && !isExtensibleRecordProperty(p));
     const simpleMixinBases = [];
     const unionMixinGroups = [];
     for (const mixin of mixins) {
@@ -137,9 +139,9 @@ function generateGroup(group, ctx) {
         }
     }
     if (unionMixinGroups.length > 0) {
-        return comments + generateGroupWithUnionMixins(name, simpleMixinBases, unionMixinGroups, ownProps, ctx);
+        return comments + generateGroupWithUnionMixins(name, simpleMixinBases, unionMixinGroups, ownProps, extraItemsType, ctx);
     }
-    return comments + generateClass(name, simpleMixinBases, ownProps, ctx);
+    return comments + generateClass(name, simpleMixinBases, ownProps, ctx, extraItemsType);
 }
 function generateGroupWithChoices(name, properties, ctx) {
     const blocks = [];
@@ -203,7 +205,7 @@ function generateGroupWithChoices(name, properties, ctx) {
     }
     return blocks.join('\n\n');
 }
-function generateGroupWithUnionMixins(name, simpleBases, unionGroups, ownProps, ctx) {
+function generateGroupWithUnionMixins(name, simpleBases, unionGroups, ownProps, extraItemsType, ctx) {
     if (ownProps.length === 0 && simpleBases.length === 0) {
         const allTypes = unionGroups.flat();
         if (allTypes.length === 1) {
@@ -218,7 +220,7 @@ function generateGroupWithUnionMixins(name, simpleBases, unionGroups, ownProps,
         const unionTypes = unionGroups[0];
         if (ownProps.length > 0) {
             const baseName = `_${name}Fields`;
-            blocks.push(generateClass(baseName, [], ownProps, ctx));
+            blocks.push(generateClass(baseName, [], ownProps, ctx, extraItemsType));
             for (let i = 0; i < unionTypes.length; i++) {
                 const variantName = `_${name}Variant${i}`;
                 variantNames.push(variantName);
@@ -231,7 +233,7 @@ function generateGroupWithUnionMixins(name, simpleBases, unionGroups, ownProps,
                 const variantName = `_${name}Variant${i}`;
                 variantNames.push(variantName);
                 const bases = [unionTypes[i], ...simpleBases];
-                blocks.push(generateClass(variantName, bases, [], ctx));
+                blocks.push(generateClass(variantName, bases, [], ctx, extraItemsType));
             }
         }
     }
@@ -292,7 +294,7 @@ function generateArrayAssignment(arr, ctx) {
 // ---------------------------------------------------------------------------
 // Class generation (TypedDict or Pydantic BaseModel)
 // ---------------------------------------------------------------------------
-function generateClass(name, bases, props, ctx) {
+function generateClass(name, bases, props, ctx, extraItemsType) {
     const lines = [];
     let classDecl;
     if (ctx.pydantic) {
@@ -308,16 +310,22 @@ function generateClass(name, bases, props, ctx) {
     else {
         ctx.typingExtensionsImports.add('TypedDict');
         const typedDictBases = bases.filter((base) => isModelCompatibleBase(base, ctx));
-        if (typedDictBases.length > 0) {
-            classDecl = `class ${name}(${typedDictBases.join(', ')}):`;
-        }
-        else {
-            classDecl = `class ${name}(TypedDict):`;
-        }
+        const baseList = typedDictBases.length > 0 ? typedDictBases.join(', ') : 'TypedDict';
+        classDecl = extraItemsType
+            ? `class ${name}(${baseList}, extra_items=${extraItemsType}):`
+            : `class ${name}(${baseList}):`;
     }
     lines.push(classDecl);
+    if (ctx.pydantic && extraItemsType) {
+        ctx.pydanticImports.add('ConfigDict');
+        ctx.pydanticImports.add('Field');
+        lines.push(`    __pydantic_extra__: dict[str, ${extraItemsType}] = Field(init=False)`);
+        lines.push(`    model_config = ConfigDict(extra='allow')`);
+    }
     if (props.length === 0) {
-        lines.push('    pass');
+        if (lines.length === 1) {
+            lines.push('    pass');
+        }
         return lines.join('\n');
     }
     for (const prop of props) {
@@ -385,6 +393,29 @@ function generateField(prop, ctx) {
     }
     return `    ${propName}: ${typeStr}${commentSuffix}`;
 }
+function isExtensibleRecordProperty(prop) {
+    return !isUnNamedProperty(prop) &&
+        prop.Occurrence.m === Infinity &&
+        !prop.HasCut &&
+        STRING_RECORD_KEY_TYPES.has(prop.Name);
+}
+function getExtraItemsType(props, ctx) {
+    const types = props
+        .filter(isExtensibleRecordProperty)
+        .flatMap((prop) => {
+        const cddlTypes = Array.isArray(prop.Type) ? prop.Type : [prop.Type];
+        return cddlTypes.map((type) => resolveType(type, ctx));
+    });
+    if (types.length === 0) {
+        return;
+    }
+    const uniqueTypes = [...new Set(types)];
+    if (uniqueTypes.length === 1) {
+        return uniqueTypes[0];
+    }
+    ctx.typingImports.add('Union');
+    return `Union[${uniqueTypes.join(', ')}]`;
+}
 // ---------------------------------------------------------------------------
 // Type resolution
 // ---------------------------------------------------------------------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cddl2py",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A Node.js package that can generate Python type definitions (with optional Pydantic support) based on a CDDL file",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "yargs": "^18.0.0",
-    "cddl": "0.19.0"
+    "cddl": "0.19.2"
   },
   "scripts": {
     "release": "release-it --config .release-it.ts --VV",