wxGUI/treemodel: refactor TreeModel to allow more flexible Node classes. (#797)

Label is now python property

gui/wxpython/core/menutree.py

@@ -184,7 +184,7 @@ class MenuTreeModelBuilder:
 def removeSeparators(model, node=None):
     if not node:
         node = model.root
-    if node.label:
+    if node.label or node is model.root:
         for child in reversed(node.children):
             removeSeparators(model, child)
     else:

gui/wxpython/core/treemodel.py

@@ -28,12 +28,12 @@ class TreeModel(object):
 
     >>> tree = TreeModel(DictNode)
     >>> root = tree.root
-    >>> n1 = tree.AppendNode(parent=root, label='node1')
-    >>> n2 = tree.AppendNode(parent=root, label='node2')
-    >>> n11 = tree.AppendNode(parent=n1, label='node11', data={'xxx': 1})
-    >>> n111 = tree.AppendNode(parent=n11, label='node111', data={'xxx': 4})
-    >>> n12 = tree.AppendNode(parent=n1, label='node12', data={'xxx': 2})
-    >>> n21 = tree.AppendNode(parent=n2, label='node21', data={'xxx': 1})
+    >>> n1 = tree.AppendNode(parent=root, data={"label": "node1"})
+    >>> n2 = tree.AppendNode(parent=root, data={"label": "node2"})
+    >>> n11 = tree.AppendNode(parent=n1, data={"label": "node11", "xxx": 1})
+    >>> n111 = tree.AppendNode(parent=n11, data={"label": "node111", "xxx": 4})
+    >>> n12 = tree.AppendNode(parent=n1, data={"label": "node12", "xxx": 2})
+    >>> n21 = tree.AppendNode(parent=n2, data={"label": "node21", "xxx": 1})
     >>> [node.label for node in tree.SearchNodes(key='xxx', value=1)]
     ['node11', 'node21']
     >>> [node.label for node in tree.SearchNodes(key='xxx', value=5)]
@@ -44,15 +44,22 @@ class TreeModel(object):
     'node12'
     >>> print(tree)
     node1
+      * label : node1
       node11
+        * label : node11
         * xxx : 1
         node111
+          * label : node111
           * xxx : 4
       node12
+        * label : node12
         * xxx : 2
     node2
+      * label : node2
       node21
+        * label : node21
         * xxx : 1
+
     """
 
     def __init__(self, nodeClass):
@@ -60,23 +67,21 @@ class TreeModel(object):
 
         :param nodeClass: class which is used for creating nodes
         """
-        self._root = nodeClass('root')
+        self._root = nodeClass()
         self.nodeClass = nodeClass
 
     @property
     def root(self):
         return self._root
 
-    def AppendNode(self, parent, label, data=None):
+    def AppendNode(self, parent, **kwargs):
         """Create node and append it to parent node.
 
         :param parent: parent node of the new node
-        :param label: node label
-        :param data: optional node data
 
         :return: new node
         """
-        node = self.nodeClass(label=label, data=data)
+        node = self.nodeClass(**kwargs)
         # useful for debugging deleting nodes
         # weakref.finalize(node, print, "Deleted node {}".format(label))
         parent.children.append(node)
@@ -157,22 +162,23 @@ class TreeModel(object):
 class DictNode(object):
     """Node which has data in a form of dictionary."""
 
-    def __init__(self, label, data=None):
+    def __init__(self, data=None):
         """Create node.
 
-        :param label: node label (displayed in GUI)
         :param data: data as dictionary or None
         """
-
-        self.label = label
-        if data is None:
-            self.data = dict()
+        if not data:
+            self.data = {"label": ""}
         else:
             self.data = data
         self._children = []
         self.parent = None
 
     @property
+    def label(self):
+        return self.data["label"]
+
+    @property
     def children(self):
         return self._children
 
@@ -202,8 +208,15 @@ class DictNode(object):
 class ModuleNode(DictNode):
     """Node representing module."""
 
-    def __init__(self, label, data=None):
-        super(ModuleNode, self).__init__(label=label, data=data)
+    def __init__(self, label=None, data=None):
+        super(ModuleNode, self).__init__(data=data)
+        self._label = label if label else ''
+        if not data:
+            self.data = {}
+
+    @property
+    def label(self):
+        return self._label
 
     def match(self, key, value, case_sensitive=False):
         """Method used for searching according to command,

gui/wxpython/datacatalog/tree.py

@@ -229,8 +229,12 @@ class NameEntryDialog(TextEntryDialog):
 class DataCatalogNode(DictNode):
     """Node representing item in datacatalog."""
 
-    def __init__(self, label, data=None):
-        super(DataCatalogNode, self).__init__(label=label, data=data)
+    def __init__(self, data=None):
+        super(DataCatalogNode, self).__init__(data=data)
+
+    @property
+    def label(self):
+        return self.data["name"]
 
     def match(self, **kwargs):
         """Method used for searching according to given parameters.
@@ -328,12 +332,11 @@ class DataCatalogTree(TreeView):
             nlocations = len(locations)
             grassdata_node = self._model.AppendNode(
                 parent=self._model.root,
-                label=grassdatabase,
                 data=dict(type='grassdb', name=grassdatabase))
             for location in locations:
                 results[location] = dict()
                 varloc = self._model.AppendNode(
-                    parent=grassdata_node, label=location, data=dict(
+                    parent=grassdata_node, data=dict(
                         type='location', name=location))
                 location_nodes.append(varloc)
                 loc_count += 1
@@ -363,8 +366,7 @@ class DataCatalogTree(TreeView):
                         for key in sorted(maps.keys()):
                             mapset_node = self._model.AppendNode(
                                 parent=location_nodes[i],
-                                label=key, data=dict(
-                                    type='mapset', name=key))
+                                data=dict(type='mapset', name=key))
                             self._populateMapsetItem(mapset_node, maps[key])
 
                     proc_count = 0
@@ -432,7 +434,7 @@ class DataCatalogTree(TreeView):
         for elem in data:
             if data[elem]:
                 for layer in data[elem]:
-                    self._model.AppendNode(parent=mapset_node, label=layer,
+                    self._model.AppendNode(parent=mapset_node,
                                            data=dict(type=elem, name=layer))
         self._model.SortChildren(mapset_node)
 
@@ -883,14 +885,14 @@ class DataCatalogTree(TreeView):
 
     def InsertLayer(self, name, mapset_node, element_name):
         """Insert layer into model and refresh tree"""
-        self._model.AppendNode(parent=mapset_node, label=name,
+        self._model.AppendNode(parent=mapset_node,
                                data=dict(type=element_name, name=name))
         self._model.SortChildren(mapset_node)
         self.RefreshNode(mapset_node, recursive=True)
 
     def InsertMapset(self, name, location_node):
         """Insert mapset into model and refresh tree"""
-        self._model.AppendNode(parent=location_node, label=name,
+        self._model.AppendNode(parent=location_node,
                                data=dict(type="mapset", name=name))
         self._model.SortChildren(location_node)
         self.RefreshNode(location_node, recursive=True)
@@ -898,7 +900,7 @@ class DataCatalogTree(TreeView):
     def InsertGrassDb(self, name):
         """Insert grass db into model and refresh tree"""
         self.grassdatabases.append(name)
-        self._model.AppendNode(parent=self._model.root, label=name,
+        self._model.AppendNode(parent=self._model.root,
                                data=dict(type="grassdb", name=name))
         self._model.SortChildren(self._model.root)
         self.ReloadTreeItems()

gui/wxpython/gui_core/query.py

@@ -220,13 +220,13 @@ def QueryTreeBuilder(data, column):
     def addNode(parent, data, model):
         for k, v in six.iteritems(data):
             if isinstance(v, dict):
-                node = model.AppendNode(parent=parent, label=k)
+                node = model.AppendNode(parent=parent, data={"label": k})
                 addNode(parent=node, data=v, model=model)
             else:
                 if not isinstance(v, six.string_types):
                     v = str(v)
-                node = model.AppendNode(parent=parent, label=k,
-                                        data={column: v})
+                node = model.AppendNode(parent=parent,
+                                        data={"label": k, column: v})
 
     model = TreeModel(DictNode)
     for part in data:

gui/wxpython/gui_core/treeview.py

@@ -274,19 +274,16 @@ class TreeFrame(wx.Frame):
 def main():
     tree = TreeModel(DictNode)
     root = tree.root
-    n1 = tree.AppendNode(parent=root, label='node1')
-    n2 = tree.AppendNode(parent=root, label='node2')
-    n3 = tree.AppendNode(parent=root, label='node3')  # pylint: disable=W0612
-    n11 = tree.AppendNode(parent=n1, label='node11', data={'xxx': 'A'})
+    n1 = tree.AppendNode(parent=root, data={"label": "node1"})
+    n2 = tree.AppendNode(parent=root, data={"label": "node2"})
+    n3 = tree.AppendNode(parent=root, data={"label": "node3"})  # pylint: disable=W0612
+    n11 = tree.AppendNode(parent=n1, data={"label": "node11", "xxx": "A"})
     n12 = tree.AppendNode(
-        parent=n1, label='node12', data={
-            'xxx': 'B'})  # pylint: disable=W0612
+        parent=n1, data={"label": "node12", "xxx": "B"})  # pylint: disable=W0612
     n21 = tree.AppendNode(
-        parent=n2, label='node21', data={
-            'xxx': 'A'})  # pylint: disable=W0612
+        parent=n2, data={"label": "node21", "xxx": "A"})  # pylint: disable=W0612
     n111 = tree.AppendNode(
-        parent=n11, label='node111', data={
-            'xxx': 'A'})  # pylint: disable=W0612
+        parent=n11, data={"label": "node111", "xxx": "A"})  # pylint: disable=W0612
 
     app = wx.App()
     frame = TreeFrame(model=tree)