Add commento for the module info retrieve and format functions

[bertos.git] / wizard / bertos_utils.py

diff --git a/wizard/bertos_utils.py b/wizard/bertos_utils.py
index 593bb4627ca39a42306ffa8ef5a93a8419cbcd49..5c6bf3c1f841ba9eafefbdbd8ada4b4f4c582973 100644 (file)
--- a/wizard/bertos_utils.py
+++ b/wizard/bertos_utils.py
@@ -95,6 +95,9 @@ def getInfos(definition):
     return D
 
 def getDefinitionBlocks(text):
+    """
+    Take a text and return a list of tuple (description, name-value).
+    """
     block = []
     block_tmp = re.findall(r"/\*{2}\s*([^*]*\*(?:[^/*][^*]*\*+)*)/\s*#define\s+((?:[^/]*?/?)+)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)
     for comment, define in block_tmp:
@@ -103,11 +106,24 @@ def getDefinitionBlocks(text):
     block += [(comment, define) for define, comment in re.findall(r"#define\s*(.*?)\s*/{3}<\s*(.+?)\s*?(?:/{2,3}[^<].*?)?$", text, re.MULTILINE)]
     return block
 
+def formatModuleNameValue(text):
+    """
+    Take the given string and return a tuple with the name of the parameter in the first position
+    and the value in the second.
+    """
+    block = re.findall("\s*([^\s]+)\s*(.+?)\s*$", text, re.MULTILINE)
+    return block[0]
+
 def loadModuleInfos(path):
+    """
+    Return the module configurations found in the given path as a dict with the name as key
+    and a list of tuple as value. The tuple have the format (name, value, description).
+    """
     moduleInfos = {}
     for definition in findDefinitions(const.MODULE_CONFIGURATION, path):
         moduleName = definition[0].replace("cfg_", "").replace(".h", "")
         moduleInfos[moduleName] = []
-        for element in getDefinitionBlocks(open(definition[1] + "/" + definition[0], "r").read()):
-            moduleInfos[moduleName].append(element)
+        for description, define in getDefinitionBlocks(open(definition[1] + "/" + definition[0], "r").read()):
+            name, value = formatModuleNameValue(define)
+            moduleInfos[moduleName].append((name, value, description))
     return moduleInfos