documentation and clean up #285

Author: jchanvfx

NodeGraphQt/base/port.py

@@ -378,21 +378,23 @@ def clear_connections(self, push_undo=True):
             for cp in self.connected_ports():
                 self.disconnect_from(cp, push_undo=False)
 
-    def add_accept_port_type(self, port_name, port_type, port_node_type):
+    def add_accept_port_type(self, port_name, port_type, node_type):
         """
         Add a constrain to "accept" a pipe connection.
 
         Once a constrain has been added only ports of that type specified will
         be allowed a pipe connection.
 
+        `Implemented in` ``v0.6.0``
+
         See Also:
             :meth:`NodeGraphQt.Port.add_reject_ports_type`,
             :meth:`NodeGraphQt.BaseNode.add_accept_port_type`
 
         Args:
             port_name (str): name of the port.
             port_type (str): port type.
-            port_node_type (str): port node type.
+            node_type (str): port node type.
         """
         # storing the connection constrain at the graph level instead of the
         # port level so we don't serialize the same data for every port
@@ -402,7 +404,7 @@ def add_accept_port_type(self, port_name, port_type, port_node_type):
             port_type_data={
                 'port_name': port_name,
                 'port_type': port_type,
-                'node_type': port_node_type,
+                'node_type': node_type,
             }
         )
 
@@ -419,21 +421,23 @@ def accepted_port_types(self):
         """
         return self.node().accepted_port_types(self)
 
-    def add_reject_port_type(self, port_name, port_type, port_node_type):
+    def add_reject_port_type(self, port_name, port_type, node_type):
         """
         Add a constrain to "reject" a pipe connection.
 
         Once a constrain has been added only ports of that type specified will
         be rejected a pipe connection.
 
+        `Implemented in` ``v0.6.0``
+
         See Also:
             :meth:`NodeGraphQt.Port.add_accept_ports_type`,
             :meth:`NodeGraphQt.BaseNode.add_reject_port_type`
 
         Args:
             port_name (str): name of the port.
             port_type (str): port type.
-            port_node_type (str): port node type.
+            node_type (str): port node type.
         """
         # storing the connection constrain at the graph level instead of the
         # port level so we don't serialize the same data for every port
@@ -443,7 +447,7 @@ def add_reject_port_type(self, port_name, port_type, port_node_type):
             port_type_data={
                 'port_name': port_name,
                 'port_type': port_type,
-                'node_type': port_node_type,
+                'node_type': node_type,
             }
         )
 

NodeGraphQt/nodes/base_node.py

@@ -664,16 +664,22 @@ def add_accept_port_type(self, port, port_type_data):
         Once a constrain has been added only ports of that type specified will
         be allowed a pipe connection.
 
+        port type data example
+
+        .. highlight:: python
+        .. code-block:: python
+            {
+                'port_name': 'foo'
+                'port_type': PortTypeEnum.IN.value
+                'node_type': 'io.github.jchanvfx.NodeClass'
+            }
+
+        See Also:
+            :meth:`NodeGraphQt.BaseNode.accepted_port_types`
+
         Args:
             port (NodeGraphQt.Port): port to assign constrain to.
             port_type_data (dict): port type data to accept a connection
-                eg.
-                .. code-block:: python
-                    {
-                        'port_name': 'test 1'
-                        'port_type': PortTypeEnum.IN.value
-                        'node_type': 'io.github.jchanvfx.ExampleNode'
-                    }
         """
         node_ports = self._inputs + self._outputs
         if port not in node_ports:
@@ -717,16 +723,22 @@ def add_reject_port_type(self, port, port_type_data):
         Once a constrain has been added only ports of that type specified will
         NOT be allowed a pipe connection.
 
+        port type data example
+
+        .. highlight:: python
+        .. code-block:: python
+            {
+                'port_name': 'foo'
+                'port_type': PortTypeEnum.IN.value
+                'node_type': 'io.github.jchanvfx.NodeClass'
+            }
+
+        See Also:
+            :meth:`NodeGraphQt.Port.rejected_port_types`
+
         Args:
             port (NodeGraphQt.Port): port to assign constrain to.
             port_type_data (dict): port type data to reject a connection
-                eg.
-                .. code-block:: python
-                    {
-                        'port_name': 'test 1'
-                        'port_type': PortTypeEnum.IN.value
-                        'node_type': 'io.github.jchanvfx.ExampleNode'
-                    }
         """
         node_ports = self._inputs + self._outputs
         if port not in node_ports:

docs/examples/ex_port.rst

@@ -141,3 +141,68 @@ And here's another example function for drawing a Square port.
         painter.drawRect(rect)
 
         painter.restore()
+
+
+Connection Constrains
+*********************
+
+From version ``v0.6.0`` port object can now have pipe connection constraints the functions implemented are:
+
+:meth:`NodeGraphQt.Port.add_accept_ports_type` and :meth:`NodeGraphQt.Port.add_reject_ports_type`
+
+this can also be set on the ``BaseNode`` level as well with:
+:meth:`NodeGraphQt.BaseNode.add_accept_port_type`, :meth:`NodeGraphQt.BaseNode.add_accept_port_type`
+
+Here's an example snippet to add pipe connection constraints to a port.
+
+.. code-block:: python
+    :linenos:
+
+    from NodeGraphQt import BaseNode
+    from NodeGraphQt.constants import PortTypeEnum
+
+
+    class BasicNodeA(BaseNode):
+
+        # unique node identifier.
+        __identifier__ = 'io.github.jchanvfx'
+
+        # initial default node name.
+        NODE_NAME = 'node A'
+
+        def __init__(self):
+            super(BasicNode, self).__init__()
+
+            # create node output ports.
+            self.add_output('output 1')
+            self.add_output('output 2')
+
+
+    class BasicNodeB(BaseNode):
+
+        # unique node identifier.
+        __identifier__ = 'io.github.jchanvfx'
+
+        # initial default node name.
+        NODE_NAME = 'node B'
+
+        def __init__(self):
+            super(BasicNode, self).__init__()
+
+            # create node inputs.
+
+            # port "in A" will only accept pipe connections from port "output 1" under the node "BasicNodeA".
+            in_port_a = self.add_input('in A')
+            in_port_a.add_accept_port_type(
+                port_name='output 1',
+                port_type=PortTypeEnum.OUT.value,
+                node_type='io.github.jchanvfx.BasicNodeA'
+            )
+
+            # port "in A" will reject pipe connections from port "output 1" under the node "BasicNodeA".
+            in_port_b = self.add_input('in B')
+            in_port_b.add_reject_port_type(
+                port_name='output 1',
+                port_type=PortTypeEnum.OUT.value,
+                node_type='io.github.jchanvfx.BasicNodeA'
+            )