Merge pull request #213 from jchanvfx/cleanup

clean up

Author: jchanvfx

NodeGraphQt/base/commands.py

@@ -145,7 +145,7 @@ class NodeRemovedCmd(QtWidgets.QUndoCommand):
 
     Args:
         graph (NodeGraphQt.NodeGraph): node graph.
-        node (NodeGraphQt.NodeObject): node.
+        node (NodeGraphQt.BaseNode or NodeGraphQt.NodeObject): node.
     """
 
     def __init__(self, graph, node):

NodeGraphQt/base/factory.py

@@ -1,5 +1,4 @@
 #!/usr/bin/python
-
 from ..errors import NodeRegistrationError
 
 
@@ -45,7 +44,7 @@ def nodes(self):
 
     def create_node_instance(self, node_type=None, alias=None):
         """
-        create node class by the node type identifier or alias.
+        create node object by the node type identifier or alias.
 
         Args:
             node_type (str): node type.

NodeGraphQt/base/graph.py

@@ -172,7 +172,7 @@ def _on_insert_node(self, pipe, node_id, prev_node_pos):
         node = self.get_node_by_id(node_id)
 
         # exclude the BackdropNode
-        if not isinstance(node, BaseNode):
+        if isinstance(node, BackdropNode):
             return
 
         disconnected = [(pipe.input_port, pipe.output_port)]
@@ -348,7 +348,7 @@ def _on_search_triggered(self, node_type, pos):
 
         Args:
             node_type (str): node identifier.
-            pos (tuple): x,y position for the node.
+            pos (tuple or list): x, y position for the node.
         """
         self.create_node(node_type, pos=pos)
 
@@ -578,7 +578,7 @@ def set_grid_mode(self, mode=VIEWER_GRID_LINES):
             * :attr:`NodeGraphQt.constants.VIEWER_GRID_LINES`
 
         Args:
-            mode (int): background styles.
+            mode (int): background style.
         """
         self.scene().grid_mode = mode
         self._viewer.force_update()
@@ -819,7 +819,7 @@ def registered_nodes(self):
         """
         Return a list of all node types that have been registered.
 
-        Hint:
+        See Also:
             To register a node :meth:`NodeGraph.register_node`
 
         Returns:
@@ -843,7 +843,7 @@ def register_nodes(self, nodes):
         Register the nodes to the :meth:`NodeGraph.node_factory`
 
         Args:
-            nodes (list[NodeGraphQt.NodeObject]): list of nodes.
+            nodes (list): list of nodes.
         """
         [self._node_factory.register_node(n) for n in nodes]
         self._viewer.rebuild_tab_search()
@@ -865,7 +865,7 @@ def create_node(self, node_type, name=None, selected=True, color=None,
             pos (list[int, int]): initial x, y position for the node (default: ``(0, 0)``).
 
         Returns:
-            NodeGraphQt.NodeObject: the created instance of the node.
+            BaseNode or NodeObject: the created instance of the node.
         """
         if not self._editable:
             return
@@ -1285,6 +1285,7 @@ def _deserialize(self, data, relative_pos=False, pos=None, set_parent=True):
                 # set custom properties.
                 for prop, val in n_data.get('custom', {}).items():
                     node.model.set_property(prop, val)
+
                 nodes[n_id] = node
 
                 if isinstance(node, SubGraph):

NodeGraphQt/base/menu.py

@@ -177,6 +177,7 @@ def add_command(self, name, func=None, node_type=None, node_class=None):
         """
         if not node_type and not node_class:
             raise NodeMenuError('Node type or Node class not specified!')
+
         if node_class:
             node_type = node_class.__name__
 

NodeGraphQt/base/model.py

@@ -11,6 +11,9 @@
 
 
 class PortModel(object):
+    """
+    Data dump for a port object.
+    """
 
     def __init__(self, node):
         self.node = node
@@ -51,6 +54,9 @@ def to_dict(self):
 
 
 class NodeModel(object):
+    """
+    Data dump for a node object.
+    """
 
     def __init__(self):
         self.type_ = None
@@ -225,9 +231,11 @@ def to_dict(self):
                     'disabled': False,
                     'visible': True,
                     'inputs': {
-                        <port_name>: {<node_id>: [<port_name>, <port_name>]}},
+                        <port_name>: {<node_id>: [<port_name>, <port_name>]}
+                    },
                     'outputs': {
-                        <port_name>: {<node_id>: [<port_name>, <port_name>]}},
+                        <port_name>: {<node_id>: [<port_name>, <port_name>]}
+                    },
                     'input_ports': [<port_name>, <port_name>],
                     'output_ports': [<port_name>, <port_name>],
                     'width': 0.0,

NodeGraphQt/base/node.py

@@ -30,7 +30,7 @@
                                     NodeFilePath)
 
 
-class classproperty(object):
+class _ClassProperty(object):
 
     def __init__(self, f):
         self.f = f
@@ -72,7 +72,7 @@ def __repr__(self):
         return '<{}("{}") object at {}>'.format(
             self.__class__.__name__, self.NODE_NAME, hex(id(self)))
 
-    @classproperty
+    @_ClassProperty
     def type_(cls):
         """
         Node type identifier followed by the class name.
@@ -642,7 +642,7 @@ def add_custom_widget(self, widget, widget_type=NODE_PROP_QLABEL, tab=None):
             up to the :meth:`NodeObject.set_property` function.
 
         Args:
-            widget_cls (NodeBaseWidget): node widget class object.
+            widget (NodeBaseWidget): node widget class object.
             widget_type: widget flag to display in the
                 :class:`NodeGraphQt.PropertiesBinWidget` (default: QLabel).
             tab (str): name of the widget tab to display in.
@@ -1221,7 +1221,8 @@ def __init__(self):
         # override base default color.
         self.model.color = (5, 129, 138, 255)
         self.create_property('backdrop_text', '',
-                             widget_type=NODE_PROP_QTEXTEDIT, tab='Backdrop')
+                             widget_type=NODE_PROP_QTEXTEDIT,
+                             tab='Backdrop')
 
     def on_backdrop_updated(self, update_prop, value=None):
         """

NodeGraphQt/qgraphics/node_abstract.py

@@ -1,5 +1,4 @@
 #!/usr/bin/python
-
 from Qt import QtCore, QtWidgets
 
 from ..constants import (Z_VAL_NODE, NODE_WIDTH, NODE_HEIGHT, ITEM_CACHE_MODE)
@@ -13,6 +12,7 @@ class AbstractNodeItem(QtWidgets.QGraphicsItem):
     def __init__(self, name='node', parent=None):
         super(AbstractNodeItem, self).__init__(parent)
         self.setFlags(self.ItemIsSelectable | self.ItemIsMovable)
+        self.setCacheMode(ITEM_CACHE_MODE)
         self.setZValue(Z_VAL_NODE)
         self._properties = {
             'id': None,
@@ -28,8 +28,6 @@ def __init__(self, name='node', parent=None):
         self._width = NODE_WIDTH
         self._height = NODE_HEIGHT
 
-        self.setCacheMode(ITEM_CACHE_MODE)
-
     def __repr__(self):
         return '{}.{}(\'{}\')'.format(
             self.__module__, self.__class__.__name__, self.name)

NodeGraphQt/qgraphics/node_base.py

@@ -121,6 +121,12 @@ def mousePressEvent(self, event):
         super(NodeItem, self).mousePressEvent(event)
 
     def mouseReleaseEvent(self, event):
+        """
+        Re-implemented to ignore event if Alt modifier is pressed.
+
+        Args:
+            event (QtWidgets.QGraphicsSceneMouseEvent): mouse event.
+        """
         if event.modifiers() == QtCore.Qt.AltModifier:
             event.ignore()
             return
@@ -149,6 +155,13 @@ def mouseDoubleClickEvent(self, event):
         super(NodeItem, self).mouseDoubleClickEvent(event)
 
     def itemChange(self, change, value):
+        """
+        Re-implemented to update pipes on selection changed.
+
+        Args:
+            change:
+            value:
+        """
         if change == self.ItemSelectedChange and self.scene():
             self.reset_pipes()
             if value:
@@ -161,7 +174,7 @@ def itemChange(self, change, value):
 
     def _tooltip_disable(self, state):
         """
-        updates the node tooltip when the node is enabled/disabled.
+        Updates the node tooltip when the node is enabled/disabled.
 
         Args:
             state (bool): node disable state.
@@ -213,7 +226,7 @@ def activate_pipes(self):
 
     def highlight_pipes(self):
         """
-        highlight pipe color.
+        Highlight pipe color.
         """
         ports = self.inputs + self.outputs
         for port in ports:
@@ -400,6 +413,7 @@ def draw_node(self):
         (re-implemented for vertical layout design)
         """
         height = self._text_item.boundingRect().height()
+
         # setup initial base size.
         self._set_base_size(add_w=0.0, add_h=height)
         # set text color when node is initialized.

NodeGraphQt/qgraphics/pipe.py

@@ -93,9 +93,9 @@ def paint(self, painter, option, widget):
             pen_width += 0.2
             pen_style = PIPE_STYLES.get(PIPE_STYLE_DOTTED)
 
-        pen = QtGui.QPen(color, pen_width)
-        pen.setStyle(pen_style)
+        pen = QtGui.QPen(color, pen_width, pen_style)
         pen.setCapStyle(QtCore.Qt.RoundCap)
+        pen.setJoinStyle(QtCore.Qt.MiterJoin)
 
         painter.save()
         painter.setPen(pen)
@@ -125,7 +125,11 @@ def paint(self, painter, option, widget):
             pen_width = 0.6
             if dist < 1.0:
                 pen_width *= (1.0 + dist)
-            painter.setPen(QtGui.QPen(color, pen_width))
+
+            pen = QtGui.QPen(color, pen_width)
+            pen.setCapStyle(QtCore.Qt.RoundCap)
+            pen.setJoinStyle(QtCore.Qt.MiterJoin)
+            painter.setPen(pen)
 
             transform = QtGui.QTransform()
             transform.translate(cen_x, cen_y)

NodeGraphQt/qgraphics/port.py

@@ -1,5 +1,5 @@
 #!/usr/bin/python
-from .. import QtGui, QtCore, QtWidgets
+from Qt import QtGui, QtCore, QtWidgets
 
 from ..constants import (
     IN_PORT, OUT_PORT,
@@ -23,6 +23,7 @@ class PortItem(QtWidgets.QGraphicsItem):
     def __init__(self, parent=None):
         super(PortItem, self).__init__(parent)
         self.setAcceptHoverEvents(True)
+        self.setCacheMode(ITEM_CACHE_MODE)
         self.setFlag(self.ItemIsSelectable, False)
         self.setFlag(self.ItemSendsScenePositionChanges, True)
         self.setZValue(Z_VAL_PORT)
@@ -39,8 +40,6 @@ def __init__(self, parent=None):
         self._multi_connection = False
         self._locked = False
 
-        self.setCacheMode(ITEM_CACHE_MODE)
-
     def __str__(self):
         return '{}.PortItem("{}")'.format(self.__module__, self.name)