port locking updates

Author: jchanvfx

NodeGraphQt/base/model.py

@@ -39,6 +39,8 @@ def to_dict(self):
                     'name': 'port',
                     'display_name': True,
                     'multi_connection': False,
+                    'visible': True,
+                    'locked': False,
                     'connected_ports': {<node_id>: [<port_name>, <port_name>]}
                 }
         """

NodeGraphQt/base/port.py

@@ -6,6 +6,7 @@
                        NodeInputDisconnectedCmd)
 from .model import PortModel
 from ..constants import IN_PORT, OUT_PORT
+from ..errors import PortError
 
 
 class Port(object):
@@ -102,15 +103,6 @@ def visible(self):
         """
         return self.model.visible
 
-    def locked(self):
-        """
-        Port locked state.
-
-        Returns:
-            bool: true if visible.
-        """
-        return self.model.locked
-
     def set_visible(self, visible=True):
         """
         Sets weather the port should be visible or not.
@@ -129,14 +121,42 @@ def set_visible(self, visible=True):
         undo_stack.push(PortVisibleCmd(self))
         undo_stack.endMacro()
 
-    def set_locked(self, locked=False):
+    def locked(self):
+        """
+        Returns the locked state.
+
+        If ports are locked then new pipe connections can't be connected
+        and current connected pipes can't be disconnected.
+
+        Returns:
+            bool: true if locked.
         """
-        Sets the port locked state when locked new pipe connections can't be
-        connected or disconnected from the node graph gui.
+        return self.model.locked
+
+    def lock(self):
+        """
+        Lock the port so new pipe connections can't be connected and
+        current connected pipes can't be disconnected.
+
+        This is the same as calling :meth:`Port.set_locked` with the arg
+        set to ``True``
+        """
+        self.set_locked(True)
+
+    def unlock(self):
+        """
+        Unlock the port so new pipe connections can be connected and
+        existing connected pipes can be disconnected.
 
-        Note:
-            pipes can still be connected/disconnected to locked ports through
-            the api.
+        This is the same as calling :meth:`Port.set_locked` with the arg
+        set to ``False``
+        """
+        self.set_locked(False)
+
+    def set_locked(self, locked=False):
+        """
+        Sets the port locked state. When locked pipe connections can't be
+        connected or disconnected from this port.
 
         Args:
             locked (Bool): true if locked.
@@ -176,6 +196,11 @@ def connect_to(self, port=None):
         if self in port.connected_ports():
             return
 
+        if self.locked() or port.locked():
+            name = [p.name() for p in [self, port] if p.locked()][0]
+            raise PortError(
+                'Can\'t connect port because "{}" is locked.'.format(name))
+
         graph = self.node().graph
         viewer = graph.viewer()
 
@@ -227,6 +252,12 @@ def disconnect_from(self, port=None):
         """
         if not port:
             return
+
+        if self.locked() or port.locked():
+            name = [p.name() for p in [self, port] if p.locked()][0]
+            raise PortError(
+                'Can\'t disconnect port because "{}" is locked.'.format(name))
+
         graph = self.node().graph
         graph.undo_stack().beginMacro('disconnect port')
         graph.undo_stack().push(PortDisconnectedCmd(self, port))

NodeGraphQt/errors.py

@@ -14,4 +14,7 @@ class NodeWidgetError(Exception): pass
 class NodeRegistrationError(Exception): pass
 
 
+class PortError(Exception): pass
+
+
 class PortRegistrationError(Exception): pass

NodeGraphQt/qgraphics/port.py

@@ -316,6 +316,7 @@ def paint(self, painter, option, widget):
                 'multi_connection': self.multi_connection,
                 'connected': bool(self.connected_pipes),
                 'hovered': self.hovered,
+                'locked': self.locked,
             }
             self._port_painter(painter, port_rect, port_info)
         else: