refactor clean up & implement set_context_menu_from_file()

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -158,21 +158,13 @@ def __init__(self, parent=None, **kwargs):
             kwargs.get('viewer') or NodeViewer(undo_stack=self._undo_stack))
         self._viewer.set_layout_direction(layout_direction)
 
-        self._build_context_menu()
         self._register_builtin_nodes()
         self._wire_signals()
 
     def __repr__(self):
         return '<{}("root") object at {}>'.format(
             self.__class__.__name__, hex(id(self)))
 
-    def _build_context_menu(self):
-        """
-        build the essential menus commands for the graph context menu.
-        """
-        from NodeGraphQt.base.graph_actions import build_context_menu
-        build_context_menu(self)
-
     def _register_builtin_nodes(self):
         """
         Register the default builtin nodes to the :meth:`NodeGraph.node_factory`
@@ -703,6 +695,117 @@ def get_context_menu(self, menu):
             elif menu == 'nodes':
                 return NodesMenu(self, menus[menu])
 
+    @staticmethod
+    def _build_context_menu_command(menu, data):
+        """
+        Create context menu command from serialized data.
+
+        Args:
+            menu (NodeGraphQt.NodeGraphMenu or NodeGraphQt.NodesMenu):
+                menu object.
+            data (dict): serialized menu command data.
+        """
+        import sys
+        import importlib.util
+
+        full_path = os.path.abspath(data['file'])
+        base_dir, file_name = os.path.split(full_path)
+        base_name = os.path.basename(base_dir)
+        file_name, _ = file_name.split('.')
+
+        mod_name = '{}.{}'.format(base_name, file_name)
+
+        spec = importlib.util.spec_from_file_location(mod_name, full_path)
+        mod = importlib.util.module_from_spec(spec)
+        sys.modules[mod_name] = mod
+        spec.loader.exec_module(mod)
+
+        cmd_func = getattr(mod, data['function_name'])
+        cmd_name = data.get('label') or '<command>'
+        cmd_shortcut = data.get('shortcut')
+        menu.add_command(cmd_name, cmd_func, cmd_shortcut)
+
+    def _build_context_menu(self, menu, menu_data):
+        """
+        Populate context menu from a dictionary.
+
+        Args:
+            menu (NodeGraphQt.NodeGraphMenu or NodeGraphQt.NodesMenu):
+                parent context menu.
+            menu_data (list[dict] or dict): serialized menu data.
+        """
+        if not menu:
+            raise ValueError('No context menu named: "{}"'.format(menu))
+
+        if isinstance(menu_data, dict):
+            item_type = menu_data.get('type')
+            if item_type == 'separator':
+                menu.add_separator()
+            elif item_type == 'command':
+                self._build_context_menu_command(menu, menu_data)
+            elif item_type == 'menu':
+                sub_menu = menu.add_menu(menu_data['label'])
+                items = menu_data.get('items', [])
+                self._build_context_menu(sub_menu, items)
+        elif isinstance(menu_data, list):
+            for item_data in menu_data:
+                self._build_context_menu(menu, item_data)
+
+    def set_context_menu(self, menu_name, data):
+        """
+        Populate a context menu from serialized data.
+
+        serialized menu data example:
+
+        .. highlight:: python
+        .. code-block:: python
+
+            [
+                {
+                    'type': 'menu',
+                    'label': 'test sub menu',
+                    'items': [
+                        {
+                            'type': 'command',
+                            'label': 'test command',
+                            'file': '../path/to/my/test_module.py',
+                            'function': 'run_test',
+                            'shortcut': 'Ctrl+b'
+                        },
+
+                    ]
+                },
+            ]
+
+        Args:
+            menu_name (str): name of the parent context menu to populate under.
+            data (dict): serialized menu data.
+        """
+        context_menu = self.get_context_menu(menu_name)
+        self._build_context_menu(context_menu, data)
+
+    def set_context_menu_from_file(self, file_path, menu=None):
+        """
+        Populate a context menu from a serialized json file.
+
+        Menu Types:
+            - ``"graph"`` context menu from the node graph.
+            - ``"nodes"`` context menu for the nodes.
+
+        Args:
+            menu (str): name of the parent context menu to populate under.
+            file_path (str): serialized menu commands json file.
+        """
+        menu = menu or 'graph'
+        if not os.path.isfile(file_path):
+            return
+
+        with open(file_path) as f:
+            data = json.load(f)
+        context_menu = self.get_context_menu(menu)
+        self._build_context_menu(context_menu, data)
+
+
     def disable_context_menu(self, disabled=True, name='all'):
         """
         Disable/Enable context menus from the node graph.
@@ -1255,7 +1358,7 @@ def get_unique_name(self, name):
         if name not in node_names:
             return name
 
-        regex = re.compile(r'[\w ]+(?: )*(\d+)')
+        regex = re.compile(r'\w+ (\d+)$')
         search = regex.search(name)
         if not search:
             for x in range(1, len(node_names) + 2):

NodeGraphQt/base/menu.py

@@ -1,4 +1,5 @@
 #!/usr/bin/python
+import re
 from distutils.version import LooseVersion
 
 from Qt import QtGui, QtCore
@@ -129,6 +130,18 @@ def add_command(self, name, func=None, shortcut=None):
         action.graph = self._graph
         if LooseVersion(QtCore.qVersion()) >= LooseVersion('5.10'):
             action.setShortcutVisibleInContextMenu(True)
+
+        if isinstance(shortcut, str):
+            search = re.search(r'(?:\.|)QKeySequence\.(\w+)', shortcut)
+            if search:
+                shortcut = getattr(QtGui.QKeySequence, search.group(1))
+            elif all([i in ['Alt', 'Enter'] for i in shortcut.split('+')]):
+                shortcut = QtGui.QKeySequence(
+                    QtCore.Qt.ALT + QtCore.Qt.Key_Return
+                )
+            elif all([i in ['Return', 'Enter'] for i in shortcut.split('+')]):
+                shortcut = QtCore.Qt.Key_Return
+
         if shortcut:
             action.setShortcut(shortcut)
         if func:

NodeGraphQt/custom_widgets/nodes_palette.py

@@ -102,7 +102,7 @@ def paint(self, painter, option, index):
 
         font = painter.font()
         font_metrics = QtGui.QFontMetrics(font)
-        font_width = font_metrics.horizontalAdvance(item.text().replace(' ', '_'))
+        font_width = font_metrics.width(item.text().replace(' ', '_'))
         font_height = font_metrics.height()
         text_rect = QtCore.QRectF(
             sub_rect.center().x() - (font_width / 2),

NodeGraphQt/widgets/dialogs.py

@@ -48,7 +48,7 @@ def message_dialog(text='', title='Message'):
         dlg.setWindowTitle(title)
         dlg.setInformativeText(text)
         dlg.setStandardButtons(QtWidgets.QMessageBox.Ok)
-        return dlg.exec()
+        return dlg.exec_()
 
     @staticmethod
     def question_dialog(text='', title='Are you sure?'):
@@ -58,5 +58,5 @@ def question_dialog(text='', title='Are you sure?'):
         dlg.setStandardButtons(
             QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.No
         )
-        result = dlg.exec()
+        result = dlg.exec_()
         return bool(result == QtWidgets.QMessageBox.Yes)

NodeGraphQt/widgets/viewer_nav.py

@@ -75,7 +75,7 @@ def paint(self, painter, option, index):
 
         font = painter.font()
         font_metrics = QtGui.QFontMetrics(font)
-        font_width = font_metrics.horizontalAdvance(
+        font_width = font_metrics.width(
             item.text().replace(' ', '_')
         )
         font_height = font_metrics.height()
@@ -138,7 +138,7 @@ def add_label_item(self, label, node_id):
         item = QtGui.QStandardItem(label)
         item.setToolTip(node_id)
         metrics = QtGui.QFontMetrics(item.font())
-        width = metrics.horizontalAdvance(item.text()) + 30
+        width = metrics.width(item.text()) + 30
         item.setSizeHint(QtCore.QSize(width, 20))
         self.model().appendRow(item)
         self.selectionModel().setCurrentIndex(

basic_example.py renamed to examples/basic_example.py

@@ -13,14 +13,10 @@
 )
 
 # import example nodes from the "example_nodes" package
-from examples import group_node
-from examples.custom_nodes import (
-    basic_nodes,
-    custom_ports_node,
-    widget_nodes,
-)
+from nodes import basic_nodes, custom_ports_node, group_node, widget_nodes
 
 if __name__ == '__main__':
+
     # handle SIGINT to make the app terminate on CTRL+C
     signal.signal(signal.SIGINT, signal.SIG_DFL)
 
@@ -30,6 +26,7 @@
 
     # create graph controller.
     graph = NodeGraph()
+    graph.set_context_menu_from_file('/Users/jchan/PycharmProjects/NodeGraphQt/examples/hotkeys/hotkeys.json')
 
     # registered example nodes.
     graph.register_nodes([