doc strings.

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -239,7 +239,7 @@ def _on_property_bin_changed(self, node_id, prop_name, prop_value):
         Args:
             node_id (str): node id.
             prop_name (str): node property name.
-            prop_value (object): python object.
+            prop_value (object): python built in types.
         """
         if not self._editable:
             return

NodeGraphQt/base/node.py

@@ -319,7 +319,7 @@ def set_property(self, name, value):
 
         Args:
             name (str): name of the property.
-            value (object): property data.
+            value (object): property data (python built in types).
         """
 
         # prevent signals from causing a infinite loop.

NodeGraphQt/widgets/viewer.py

@@ -452,6 +452,15 @@ def dragLeaveEvent(self, event):
         event.ignore()
 
     def keyPressEvent(self, event):
+        """
+        Key press event re-implemented to update the states for attributes:
+        - ALT_state
+        - CTRL_state
+        - SHIFT_state
+
+        Args:
+            event (QtGui.QKeyEvent): key event.
+        """
         self.ALT_state = event.modifiers() == QtCore.Qt.AltModifier
         self.CTRL_state = event.modifiers() == QtCore.Qt.ControlModifier
         self.SHIFT_state = event.modifiers() == QtCore.Qt.ShiftModifier
@@ -464,6 +473,15 @@ def keyPressEvent(self, event):
         super(NodeViewer, self).keyPressEvent(event)
 
     def keyReleaseEvent(self, event):
+        """
+        Key release event re-implemented to update the states for attributes:
+        - ALT_state
+        - CTRL_state
+        - SHIFT_state
+
+        Args:
+            event (QtGui.QKeyEvent): key event.
+        """
         self.ALT_state = event.modifiers() == QtCore.Qt.AltModifier
         self.CTRL_state = event.modifiers() == QtCore.Qt.ControlModifier
         self.SHIFT_state = event.modifiers() == QtCore.Qt.ShiftModifier
@@ -709,7 +727,11 @@ def establish_connection(self, start_port, end_port):
     @staticmethod
     def acyclic_check(start_port, end_port):
         """
-        validate the connection so it doesn't loop itself.
+        Validate the node connections so it doesn't loop itself.
+
+        Args:
+            start_port (PortItem): port item.
+            end_port (PortItem): port item.
 
         Returns:
             bool: True if port connection is valid.
@@ -761,10 +783,27 @@ def context_menus(self):
 
     @staticmethod
     def question_dialog(text, title='Node Graph'):
+        """
+        Prompt node viewer question dialog widget with "yes", "no" buttons.
+
+        Args:
+            text (str): dialog text.
+            title (str): dialog window title.
+
+        Returns:
+            bool: true if user click yes.
+        """
         return BaseDialog.question_dialog(text, title)
 
     @staticmethod
     def message_dialog(text, title='Node Graph'):
+        """
+        Prompt node viewer message dialog widget with "ok" button.
+
+        Args:
+            text (str): dialog text.
+            title (str): dialog window title.
+        """
         BaseDialog.message_dialog(text, title)
 
     def load_dialog(self, current_dir=None, ext=None):
@@ -794,31 +833,56 @@ def save_dialog(self, current_dir=None, ext=None):
         return file_path
 
     def all_pipes(self):
-        pipes = []
+        """
+        Returns all pipe qgraphic items.
+
+        Returns:
+            list[Pipe]: instances of pipe items.
+        """
         excl = [self._LIVE_PIPE, self._SLICER_PIPE]
-        for item in self.scene().items():
-            if isinstance(item, Pipe) and item not in excl:
-                pipes.append(item)
-        return pipes
+        return [i for i in self.scene().items()
+                if isinstance(i, Pipe) and i not in excl]
 
     def all_nodes(self):
-        nodes = []
-        for item in self.scene().items():
-            if isinstance(item, AbstractNodeItem):
-                nodes.append(item)
-        return nodes
+        """
+        Returns all node qgraphic items.
+
+        Returns:
+            list[AbstractNodeItem]: instances of node items.
+        """
+        return [i for i in self.scene().items()
+                if isinstance(i, AbstractNodeItem)]
 
     def selected_nodes(self):
-        nodes = [item for item in self.scene().selectedItems() \
+        """
+        Returns selected node qgraphic items.
+
+        Returns:
+            list[AbstractNodeItem]: instances of node items.
+        """
+        nodes = [item for item in self.scene().selectedItems()
                  if isinstance(item, AbstractNodeItem)]
         return nodes
 
     def selected_pipes(self):
-        pipes = [item for item in self.scene().selectedItems() \
+        """
+        Returns selected pipe qgraphic items.
+
+        Returns:
+            list[Pipe]: pipe items.
+        """
+        pipes = [item for item in self.scene().selectedItems()
                  if isinstance(item, Pipe)]
         return pipes
 
     def selected_items(self):
+        """
+        Return selected graphic items in the scene.
+
+        Returns:
+            tuple(list[AbstractNodeItem], list[Pipe]):
+                selected (node items, pipe items).
+        """
         nodes = []
         pipes = []
         for item in self.scene().selectedItems():
@@ -829,13 +893,26 @@ def selected_items(self):
         return nodes, pipes
 
     def add_node(self, node, pos=None):
+        """
+        Add node item into the scene.
+
+        Args:
+            node (AbstractNodeItem): node item instance.
+            pos (tuple or list): node scene position.
+        """
         pos = pos or (self._previous_pos.x(), self._previous_pos.y())
         node.pre_init(self, pos)
         self.scene().addItem(node)
         node.post_init(self, pos)
 
     @staticmethod
     def remove_node(node):
+        """
+        Remove node item from the scene.
+
+        Args:
+            node (AbstractNodeItem): node item instance.
+        """
         if isinstance(node, AbstractNodeItem):
             node.delete()
 
@@ -888,25 +965,57 @@ def center_selection(self, nodes=None):
             self.centerOn(rect.center().x(), rect.center().y())
 
     def get_pipe_layout(self):
+        """
+        Returns the pipe layout mode.
+
+        Returns:
+            int: pipe layout mode.
+        """
         return self._pipe_layout
 
     def set_pipe_layout(self, layout):
+        """
+        Sets the pipe layout mode and redraw all pipe items in the scene.
+
+        Args:
+            layout (int): pipe layout mode. (see the contants module)
+        """
         self._pipe_layout = layout
         for pipe in self.all_pipes():
             pipe.draw_path(pipe.input_port, pipe.output_port)
 
     def reset_zoom(self, cent=None):
-        self._scene_range = QtCore.QRectF(0, 0, self.size().width(), self.size().height())
+        """
+        Reset the viewer zoom level.
+
+        Args:
+            cent (QtCore.QPoint): specified center.
+        """
+        self._scene_range = QtCore.QRectF(0, 0,
+                                          self.size().width(),
+                                          self.size().height())
         if cent:
             self._scene_range.translate(cent - self._scene_range.center())
         self._update_scene()
 
     def get_zoom(self):
+        """
+        Returns the viewer zoom level.
+
+        Returns:
+            float: zoom level.
+        """
         transform = self.transform()
         cur_scale = (transform.m11(), transform.m22())
         return float('{:0.2f}'.format(cur_scale[0] - 1.0))
 
     def set_zoom(self, value=0.0):
+        """
+        Set the viewer zoom level.
+
+        Args:
+            value (float): zoom level
+        """
         if value == 0.0:
             self.reset_zoom()
             return