0005-Add-lookup-dicts-for-clusters-and-attributes.patch

From 5c019aa310a040b1162f3242101abc5440838c11 Mon Sep 17 00:00:00 2001
Message-Id: <5c019aa310a040b1162f3242101abc5440838c11.1684168831.git.stefan@agner.ch>
In-Reply-To: <c46f6cb84fb189da723a9932a5195a553762e2b6.1684168831.git.stefan@agner.ch>
References: <c46f6cb84fb189da723a9932a5195a553762e2b6.1684168831.git.stefan@agner.ch>
From: Marcel van der Veldt <m.vanderveldt@outlook.com>
Date: Tue, 21 Feb 2023 16:05:53 +0100
Subject: [PATCH] Add lookup dicts for clusters and attributes

---
 .../python/chip/clusters/ClusterObjects.py    | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/src/controller/python/chip/clusters/ClusterObjects.py b/src/controller/python/chip/clusters/ClusterObjects.py
index 13f35f240a..68e335a696 100644
--- a/src/controller/python/chip/clusters/ClusterObjects.py
+++ b/src/controller/python/chip/clusters/ClusterObjects.py
@@ -218,6 +218,10 @@ class ClusterCommand(ClusterObject):
     def must_use_timed_invoke(cls) -> bool:
         return False
 
+# The below dictionaries will be filled dynamically
+# and are used for quick lookup/mapping from cluster/attribute id to the correct class
+ALL_CLUSTERS = {}
+ALL_ATTRIBUTES = {}
 
 class Cluster(ClusterObject):
     '''
@@ -228,6 +232,16 @@ class Cluster(ClusterObject):
     especially the TLV decoding logic. Also ThreadNetworkDiagnostics has an attribute with the same name so we
     picked data_version as its name.
     '''
+
+    def __init_subclass__(cls, *args, **kwargs) -> None:
+        """Register a subclass."""
+        super().__init_subclass__(*args, **kwargs)
+        # register this cluster in the ALL_CLUSTERS dict for quick lookups
+        try:
+            ALL_CLUSTERS[cls.id] = cls
+        except NotImplementedError:
+            pass # we can safely ignore this
+
     @property
     def data_version(self) -> int:
         return self._data_version
@@ -254,6 +268,18 @@ class ClusterAttributeDescriptor:
 
     The implementation of this functions is quite tricky, it will create a cluster object on-the-fly, and use it for actual encode / decode routine to save lines of code.
     '''
+
+    def __init_subclass__(cls, *args, **kwargs) -> None:
+        """Register a subclass."""
+        super().__init_subclass__(*args, **kwargs)
+        try:
+            if cls.cluster_id not in ALL_ATTRIBUTES:
+                ALL_ATTRIBUTES[cls.cluster_id] = {}
+            # register this clusterattribute in the ALL_ATTRIBUTES dict for quick lookups
+            ALL_ATTRIBUTES[cls.cluster_id][cls.attribute_id] = cls
+        except NotImplementedError:
+            pass # we can safely ignore this
+
     @classmethod
     def ToTLV(cls, tag: Union[int, None], value):
         writer = tlv.TLVWriter()
-- 
2.40.1