Python Cluster Object - Field Defaults (#12381)

* Python Cluster Object - Field Defaults This initializes the various fields in a cluster object to type-specific default values. This correclty handles nullable and optional types as well. * Missed a couple of places... * Re-run codegen * Re-gen Python cluster objects * Restyle after regen * Remove Objects.py from restyle * Completely disable auto restyle for generated pyhon files Co-authored-by: Andrei Litvin <andy314@gmail.com>
project-chip · Sep 22, 2023 · 8814788 · 8814788
1 parent f9b98f5
commit 8814788
Show file tree

Hide file tree

Showing 6 changed files with 8,511 additions and 8,958 deletions.
diff --git a/.restyled.yaml b/.restyled.yaml
@@ -67,6 +67,8 @@ exclude:
     - "third_party/nanopb/repo/**/*"
     - "src/android/CHIPTool/gradlew" # gradle wrapper generated file
     - "third_party/android_deps/gradlew" # gradle wrapper generated file
+    - "src/controller/python/chip/clusters/Objects.py" # generated file, no point to restyle
+    - "src/controller/python/chip/clusters/CHIPClusters.py" # generated file, no point to restyle
 
 
 changed_paths:

diff --git a/scripts/tools/zap/generate.py b/scripts/tools/zap/generate.py
@@ -146,23 +146,6 @@ def runJavaPrettifier(templates_file, output_dir):
         print('google-java-format error:', err)
 
 
-def runPythonPrettifier(templates_file, output_dir):
-    try:
-        jsonData = json.loads(Path(templates_file).read_text())
-        outputs = [(os.path.join(output_dir, template['output']))
-                   for template in jsonData['templates']]
-        pyOutputs = list(
-            filter(lambda filepath: os.path.splitext(filepath)[1] == ".py", outputs))
-
-        if not pyOutputs:
-            return
-        args = ['autopep8', '--in-place']
-        args.extend(pyOutputs)
-        subprocess.check_call(args)
-    except Exception as err:
-        print('autopep8 error:', err)
-
-
 def main():
     checkPythonVersion()
 
@@ -172,7 +155,6 @@ def main():
     prettifiers = [
         runClangPrettifier,
         runJavaPrettifier,
-        runPythonPrettifier,
     ]
 
     for prettifier in prettifiers:

diff --git a/src/app/zap-templates/templates/app/helper.js b/src/app/zap-templates/templates/app/helper.js
@@ -516,6 +516,86 @@ function zapTypeToPythonClusterObjectType(type, options)
   return _zapTypeToPythonClusterObjectType.call(this, type, options)
 }
 
+async function _getPythonFieldDefault(type, options)
+{
+  async function fn(pkgId)
+  {
+    const ns          = options.hash.ns;
+    const typeChecker = async (method) => zclHelper[method](this.global.db, type, pkgId).then(zclType => zclType != 'unknown');
+
+    if (await typeChecker('isEnum')) {
+      return '0';
+    }
+
+    if (await typeChecker('isBitmap')) {
+      return '0';
+    }
+
+    if (await typeChecker('isStruct')) {
+      return 'field(default_factory=lambda: ' + ns + '.Structs.' + type + '())';
+    }
+
+    if (StringHelper.isCharString(type)) {
+      return '""';
+    }
+
+    if (StringHelper.isOctetString(type)) {
+      return 'b""';
+    }
+
+    if ([ 'single', 'double' ].includes(type.toLowerCase())) {
+      return '0.0';
+    }
+
+    if (type.toLowerCase() == 'boolean') {
+      return 'False'
+    }
+
+    // #10748: asUnderlyingZclType will emit wrong types for int{48|56|64}(u), so we process all int values here.
+    if (type.toLowerCase().match(/^int\d+$/)) {
+      return '0'
+    }
+
+    if (type.toLowerCase().match(/^int\d+u$/)) {
+      return '0'
+    }
+
+    resolvedType = await zclHelper.asUnderlyingZclType.call({ global : this.global }, type, options);
+    {
+      basicType = ChipTypesHelper.asBasicType(resolvedType);
+      if (basicType.match(/^int\d+_t$/)) {
+        return '0'
+      }
+      if (basicType.match(/^uint\d+_t$/)) {
+        return '0'
+      }
+    }
+  }
+
+  let promise = templateUtil.ensureZclPackageId(this).then(fn.bind(this));
+  if ((this.isList || this.isArray || this.entryType) && !options.hash.forceNotList) {
+    promise = promise.then(typeStr => `field(default_factory=lambda: [])`);
+  }
+
+  const isNull     = (this.isNullable && !options.hash.forceNotNullable);
+  const isOptional = (this.isOptional && !options.hash.forceNotOptional);
+
+  if (isNull && isOptional) {
+    promise = promise.then(typeStr => `None`);
+  } else if (isNull) {
+    promise = promise.then(typeStr => `NullValue`);
+  } else if (isOptional) {
+    promise = promise.then(typeStr => `None`);
+  }
+
+  return templateUtil.templatePromise(this.global, promise)
+}
+
+function getPythonFieldDefault(type, options)
+{
+  return _getPythonFieldDefault.call(this, type, options)
+}
+
 async function getResponseCommandName(responseRef, options)
 {
   let pkgId = await templateUtil.ensureZclPackageId(this);
@@ -620,3 +700,4 @@ exports.zapTypeToDecodableClusterObjectType = zapTypeToDecodableClusterObjectTyp
 exports.zapTypeToPythonClusterObjectType    = zapTypeToPythonClusterObjectType;
 exports.getResponseCommandName              = getResponseCommandName;
 exports.isWeaklyTypedEnum                   = isWeaklyTypedEnum;
+exports.getPythonFieldDefault               = getPythonFieldDefault;