clean up

Author: jchanvfx

NodeGraphQt/__init__.py

@@ -51,6 +51,6 @@
 
 from .base.actions import setup_context_menu
 from .base.graph import NodeGraph
-from .base.node import NodeObject, BaseNode, Backdrop
+from .base.node import NodeObject, BaseNode, BackdropNode
 from .base.port import Port
 from .base.menu import Menu, MenuCommand

NodeGraphQt/base/graph.py

@@ -15,7 +15,7 @@
 from NodeGraphQt.base.node import NodeObject
 from NodeGraphQt.base.port import Port
 from NodeGraphQt.constants import DRAG_DROP_ID
-from NodeGraphQt.widgets.node_list import NodeListWidget
+from NodeGraphQt.widgets.node_tree import NodeTreeWidget
 from NodeGraphQt.widgets.properties_bin import PropertiesBinWidget
 from NodeGraphQt.widgets.viewer import NodeViewer
 
@@ -254,10 +254,10 @@ def nodes_list(self):
         Initializes the nodes list widget when first called.
 
         Returns:
-            NodeListWidget: the initialized widget.
+            NodeTreeWidget: the initialized widget.
         """
         if self._nodes_list is None:
-            self._nodes_list = NodeListWidget()
+            self._nodes_list = NodeTreeWidget()
             self._nodes_list.set_node_factory(self._node_factory)
         return self._nodes_list
 

NodeGraphQt/base/node.py

@@ -562,15 +562,15 @@ def set_output(self, index, port):
         src_port.connect_to(port)
 
 
-class Backdrop(NodeObject):
+class BackdropNode(NodeObject):
     """
     base class of a Backdrop node.
     """
 
     NODE_NAME = 'Backdrop'
 
     def __init__(self):
-        super(Backdrop, self).__init__(BackdropNodeItem())
+        super(BackdropNode, self).__init__(BackdropNodeItem())
         # override base default color.
         self.model.color = (5, 129, 138, 255)
         self.create_property('bg_text', '')

NodeGraphQt/widgets/node_list.py renamed to NodeGraphQt/widgets/node_tree.py

@@ -8,24 +8,24 @@
 TYPE_CATEGORY = QtWidgets.QTreeWidgetItem.UserType + 2
 
 
-class BaseListWidgetItem(QtWidgets.QListWidgetItem):
+class BaseNodeTreeItem(QtWidgets.QTreeWidgetItem):
 
     def __eq__(self, other):
         return id(self) == id(other)
 
 
-class NodeListWidget(QtWidgets.QTreeWidget):
+class NodeTreeWidget(QtWidgets.QTreeWidget):
 
     def __init__(self, parent=None):
-        super(NodeListWidget, self).__init__(parent)
+        super(NodeTreeWidget, self).__init__(parent)
         self.setDragDropMode(QtWidgets.QAbstractItemView.DragOnly)
         self.setHeaderHidden(True)
         self._factory = None
         self._custom_labels = {}
 
     def mimeData(self, items):
         node_ids = ','.join(i.toolTip(0) for i in items)
-        mime_data = super(NodeListWidget, self).mimeData(items)
+        mime_data = super(NodeTreeWidget, self).mimeData(items)
         mime_data.setText('<${}>:{}'.format(DRAG_DROP_ID, node_ids))
         return mime_data
 
@@ -47,9 +47,7 @@ def _build_tree(self):
                 label = self._custom_labels[category]
             else:
                 label = '- {}'.format(category)
-            cat_item = QtWidgets.QTreeWidgetItem(
-                self, [label], type=TYPE_CATEGORY
-            )
+            cat_item = BaseNodeTreeItem(self, [label], type=TYPE_CATEGORY)
             cat_item.setFirstColumnSpanned(True)
             cat_item.setFlags(QtCore.Qt.ItemIsEnabled)
             self.addTopLevelItem(cat_item)
@@ -60,14 +58,11 @@ def _build_tree(self):
             category = '.'.join(node_id.split('.')[:-1])
             category_item = category_items[category]
 
-            item = QtWidgets.QTreeWidgetItem(
-                category_item, [node_name], type=TYPE_NODE
-            )
+            item = BaseNodeTreeItem(category_item, [node_name], type=TYPE_NODE)
             item.setToolTip(0, node_id)
 
             category_item.addChild(item)
 
-
     def set_node_factory(self, factory):
         """
         Set current node factory.

docs/nodes.rst

@@ -2,10 +2,10 @@ Nodes
 *****
 
 
-Node Object
-===========
+Object
+======
 
-**Inherited by:** :class:`NodeGraphQt.BaseNode`, :class:`NodeGraphQt.Backdrop`
+**Inherited by:** :class:`NodeGraphQt.BaseNode`, :class:`NodeGraphQt.BackdropNode`
 
 The ``NodeObject`` class is the main base class that all nodes inherit from.
 
@@ -25,8 +25,8 @@ The ``NodeObject`` class is the main base class that all nodes inherit from.
     :exclude-members: model, NODE_NAME
 
 
-Base Node
-=========
+Node
+====
 
 **Inherited from:** :class:`NodeGraphQt.NodeObject`
 
@@ -43,18 +43,18 @@ The ``BaseNode`` class is the base class for nodes that allows port connections
     :exclude-members: update_model
 
 
-Backdrop Node
-=============
+Backdrop
+========
 
 **Inherited from:** :class:`NodeGraphQt.NodeObject`
 
-The ``Backdrop`` class allows other node object to be nested inside, it's mainly good for grouping nodes together.
+The ``BackdropNode`` class allows other node object to be nested inside, it's mainly good for grouping nodes together.
 
 .. image:: _images/backdrop.png
     :width: 250px
 
 ----
 
-.. autoclass:: NodeGraphQt.Backdrop
+.. autoclass:: NodeGraphQt.BackdropNode
     :members:
 

example.py

@@ -3,7 +3,7 @@
 import os
 import sys
 
-from NodeGraphQt import NodeGraph, BaseNode, Backdrop, setup_context_menu
+from NodeGraphQt import NodeGraph, BaseNode, BackdropNode, setup_context_menu
 from NodeGraphQt import QtWidgets, QtCore
 
 # import example nodes from the "example_nodes" package
@@ -65,7 +65,7 @@ def show_nodes_list(node):
 
     # registered nodes.
     reg_nodes = [
-        Backdrop, MyNode,
+        BackdropNode, MyNode,
         basic_nodes.FooNode,
         basic_nodes.BarNode,
         widget_nodes.DropdownMenuNode,