custom errors & clean up

jchanvfx · jchanvfx · commit 551ae11b1d24 · 2019-03-03T18:01:40.000+13:00
diff --git a/NodeGraphQt/base/factory.py b/NodeGraphQt/base/factory.py
@@ -1,27 +1,28 @@
 #!/usr/bin/python
 
+from NodeGraphQt.errors import NodeRegistrationError
+
 
 class NodeFactory(object):
     """
     Node factory that stores all the node types.
     """
 
-    def __init__(self):
-        self._aliases = {}
-        self._names = {}
-        self._nodes = {}
+    __aliases = {}
+    __names = {}
+    __nodes = {}
 
     @property
     def names(self):
-        return self._names
+        return self.__names
 
     @property
     def aliases(self):
-        return self._aliases
+        return self.__aliases
 
     @property
     def nodes(self):
-        return self._nodes
+        return self.__nodes
 
     def create_node_instance(self, node_type=None, alias=None):
         """
@@ -32,15 +33,15 @@ def create_node_instance(self, node_type=None, alias=None):
             alias (str): alias name (optional).
 
         Returns:
-            NodeGraphQt.Node: new node instance object.
+            NodeGraphQt.Node: new node class object.
         """
         if alias and self.aliases.get(alias):
             node_type = self.aliases[alias]
 
-        NodeInstance = self._nodes.get(node_type)
-        if not NodeInstance:
+        NodeClass = self.__nodes.get(node_type)
+        if not NodeClass:
             print('can\'t find node type {}'.format(node_type))
-        return NodeInstance
+        return NodeClass
 
     def register_node(self, node, alias=None):
         """
@@ -56,30 +57,32 @@ def register_node(self, node, alias=None):
         name = node.NODE_NAME
         node_type = node.type_
 
-        if self._nodes.get(node_type):
-            raise AssertionError(
-                'Node: {} already exists! '
-                'Please specify a new plugin class name or identifier.'
+        if self.__nodes.get(node_type):
+            raise NodeRegistrationError(
+                'id "{}" already registered! '
+                'Please specify a new plugin class name or __identifier__.'
                 .format(node_type))
-        self._nodes[node_type] = node
+        self.__nodes[node_type] = node
 
-        if self._names.get(node_type):
-            raise AssertionError(
+        if self.__names.get(node_type):
+            raise NodeRegistrationError(
                 'Node Name: {} already exists!'
                 'Please specify a new node name for node: {}'
                 .format(name, node_type))
-        self._names[name] = node_type
+        self.__names[name] = node_type
 
         if alias:
-            if self._aliases.get(alias):
-                raise AssertionError(
-                    'Node Alias: {} already taken!'.format(alias))
-            self._aliases[alias] = node_type
+            if self.__aliases.get(alias):
+                raise NodeRegistrationError(
+                    'Alias: "{}" already registered to "{}"'
+                    .format(alias, self.__aliases.get(alias))
+                )
+            self.__aliases[alias] = node_type
             
     def clear_registered_nodes(self):
         """
         clear out registered nodes, to prevent conflicts on reset.
         """
-        self._nodes.clear()
-        self._names.clear()
-        self._aliases.clear()
+        self.__nodes.clear()
+        self.__names.clear()
+        self.__aliases.clear()
diff --git a/NodeGraphQt/base/model.py b/NodeGraphQt/base/model.py
@@ -7,6 +7,7 @@
                                    NODE_PROP_QLINEEDIT,
                                    NODE_PROP_QCHECKBOX,
                                    NODE_PROP_COLORPICKER)
+from NodeGraphQt.errors import NodePropertyError
 
 
 class PortModel(object):
@@ -104,9 +105,11 @@ def add_property(self, name, value, items=None, range=None,
         tab = tab or 'Properties'
 
         if name in self.properties.keys():
-            raise AssertionError('"{}" reserved for default property.'.format(name))
+            raise NodePropertyError(
+                '"{}" reserved for default property.'.format(name))
         if name in self._custom_prop.keys():
-            raise AssertionError('"{}" property already exists.'.format(name))
+            raise NodePropertyError(
+                '"{}" property already exists.'.format(name))
 
         self._custom_prop[name] = value
 
@@ -134,7 +137,7 @@ def set_property(self, name, value):
         elif name in self._custom_prop.keys():
             self._custom_prop[name] = value
         else:
-            raise KeyError('No property "{}"'.format(name))
+            raise NodePropertyError('No property "{}"'.format(name))
 
     def get_property(self, name):
         if name in self.properties.keys():
diff --git a/NodeGraphQt/base/node.py b/NodeGraphQt/base/node.py
@@ -7,6 +7,7 @@
                                    NODE_PROP_QCOMBO,
                                    NODE_PROP_QCHECKBOX,
                                    IN_PORT, OUT_PORT)
+from NodeGraphQt.errors import PortRegistrationError
 from NodeGraphQt.widgets.node_backdrop import BackdropNodeItem
 from NodeGraphQt.widgets.node_base import NodeItem
 
@@ -48,14 +49,6 @@ def __init__(self, node=None):
     def __repr__(self):
         return '{}(\'{}\')'.format(self.type_, self.NODE_NAME)
 
-    def __eq__(self, other):
-        if isinstance(other, self.__class__):
-            return self.id == other.id
-        return False
-
-    def __ne__(self, other):
-        return not self.__eq__(other)
-
     @classproperty
     def type_(cls):
         """
@@ -457,7 +450,8 @@ def add_input(self, name='input', multi_input=False, display_name=True):
             NodeGraphQt.Port: the created port object.
         """
         if name in self.inputs().keys():
-            raise AssertionError('port name "{}" already taken.'.format(name))
+            raise PortRegistrationError(
+                'port name "{}" already taken.'.format(name))
         view = self.view.add_input(name, multi_input, display_name)
         port = Port(self, view)
         port.model.type_ = IN_PORT
@@ -481,7 +475,8 @@ def add_output(self, name='output', multi_output=True, display_name=True):
             NodeGraphQt.Port: the created port object.
         """
         if name in self.outputs().keys():
-            raise AssertionError('port name "{}" already taken.'.format(name))
+            raise PortRegistrationError(
+                'port name "{}" already taken.'.format(name))
         view = self.view.add_output(name, multi_output, display_name)
         port = Port(self, view)
         port.model.type_ = OUT_PORT
diff --git a/NodeGraphQt/base/port.py b/NodeGraphQt/base/port.py
@@ -22,14 +22,6 @@ def __repr__(self):
         port = str(self.__class__.__name__)
         return 'NodeGraphQt.{}(\'{}\')'.format(port, self.name())
 
-    def __eq__(self, other):
-        if isinstance(other, self.__class__):
-            return self.node().id == other.node().id
-        return False
-
-    def __ne__(self, other):
-        return not self.__eq__(other)
-
     @property
     def view(self):
         """
diff --git a/NodeGraphQt/errors.py b/NodeGraphQt/errors.py
@@ -0,0 +1,17 @@
+#!/usr/bin/python
+
+
+class NodePropertyError(Exception):
+    pass
+
+
+class NodeWidgetError(Exception):
+    pass
+
+
+class NodeRegistrationError(Exception):
+    pass
+
+
+class PortRegistrationError(Exception):
+    pass
diff --git a/NodeGraphQt/widgets/node_abstract.py b/NodeGraphQt/widgets/node_abstract.py
@@ -26,10 +26,6 @@ def __init__(self, name='node', parent=None):
         self._width = NODE_WIDTH
         self._height = NODE_HEIGHT
 
-    def __str__(self):
-        return '{}.{}(\'{}\')'.format(
-            self.__module__, self.__class__.__name__, self.name)
-
     def __repr__(self):
         return '{}.{}(\'{}\')'.format(
             self.__module__, self.__class__.__name__, self.name)
diff --git a/NodeGraphQt/widgets/node_base.py b/NodeGraphQt/widgets/node_base.py
@@ -6,6 +6,7 @@
                                    NODE_ICON_SIZE, ICON_NODE_BASE,
                                    NODE_SEL_COLOR, NODE_SEL_BORDER_COLOR,
                                    Z_VAL_NODE, Z_VAL_NODE_WIDGET)
+from NodeGraphQt.errors import NodeWidgetError
 from NodeGraphQt.widgets.node_abstract import AbstractNodeItem
 from NodeGraphQt.widgets.node_widgets import (NodeBaseWidget,
                                               NodeComboBox,
@@ -689,13 +690,13 @@ def add_widget(self, widget):
         if isinstance(widget, NodeBaseWidget):
             self._widgets[widget.name] = widget
         else:
-            raise TypeError('{} is not an instance of a node widget.')
+            raise NodeWidgetError('{} is not an instance of a node widget.')
 
     def get_widget(self, name):
         widget = self._widgets.get(name)
         if widget:
             return widget
-        raise KeyError('node has no widget "{}"'.format(name))
+        raise NodeWidgetError('node has no widget "{}"'.format(name))
 
     def delete(self):
         for port, text in self._input_items.items():
diff --git a/NodeGraphQt/widgets/pipe.py b/NodeGraphQt/widgets/pipe.py
@@ -37,12 +37,6 @@ def __init__(self, input_port=None, output_port=None):
         self._arrow.append(QtCore.QPointF(0.0, -size * 2))
         self._arrow.append(QtCore.QPointF(size, size))
 
-    def __str__(self):
-        in_name = self._input_port.name if self._input_port else ''
-        out_name = self._output_port.name if self._output_port else ''
-        return '{}.Pipe(\'{}\', \'{}\')'.format(
-            self.__module__, in_name, out_name)
-
     def __repr__(self):
         in_name = self._input_port.name if self._input_port else ''
         out_name = self._output_port.name if self._output_port else ''
diff --git a/NodeGraphQt/widgets/properties.py b/NodeGraphQt/widgets/properties.py
@@ -9,6 +9,7 @@
                                    NODE_PROP_QSPINBOX,
                                    NODE_PROP_COLORPICKER,
                                    NODE_PROP_SLIDER)
+from NodeGraphQt.errors import NodePropertyError
 
 
 class BaseProperty(QtWidgets.QWidget):
diff --git a/NodeGraphQt/widgets/viewer.py b/NodeGraphQt/widgets/viewer.py
@@ -81,10 +81,6 @@ def __init__(self, parent=None):
         self.RMB_state = False
         self.MMB_state = False
 
-    def __str__(self):
-        return '{}.{}()'.format(
-            self.__module__, self.__class__.__name__)
-
     def __repr__(self):
         return '{}.{}()'.format(
             self.__module__, self.__class__.__name__)
