Restructure the project. Fix int too large bug. Fix restore last view when jumping into and out of groups. Fix Entering livegroups from outliner.

Author: maxWiklund

README.md

@@ -11,4 +11,4 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-__import__("pkg_resources").declare_namespace(__name__)
+__version__ = "0.3.0"

nkview/nuke_parser/__init__.py nk_parser/nuke_parser/__init__.pynkview/nuke_parser/__init__.py renamed to nk_parser/nuke_parser/__init__.py

@@ -167,7 +167,7 @@ def fullName(self) -> str:
         return ".".join(path)
 
     def _addChild(self, child: Node) -> None:
-        """Add child to node. This should only be called from the parser.
+        """Add child to node. This should only be called from the nk_parser.
 
         Args:
             child: Child node to add.
@@ -207,7 +207,7 @@ def isGizmo(self) -> bool:
         return self._class == "gizmo" or self._is_gizmo
 
     def setInput(self, i: int, node: Node) -> None:
-        """Add input to node. This should only be called from the parser.
+        """Add input to node. This should only be called from the nk_parser.
 
         Args:
             i: Input index.
@@ -386,7 +386,7 @@ def _parseNk(file_path: str, gizmos: Optional[dict] = None) -> Node:
 
     Args:
         file_path: File path to nuke script.
-        gizmos: Dict of parser gizmos {gizmo name: Gizmo class}.
+        gizmos: Dict of nk_parser gizmos {gizmo name: Gizmo class}.
 
     Returns:
         Root node of nuke scene description.
@@ -523,7 +523,7 @@ def _parseLiveGroup(live_group: Node, gizmos: Dict[str, Node]) -> None:
 
     Args:
         live_group: Live group node to update with parsed nuke file.
-        gizmos: Dict of parser gizmos {gizmo name: Gizmo class}.
+        gizmos: Dict of nk_parser gizmos {gizmo name: Gizmo class}.
 
     """
     if not live_group.knob("file"):

parser/nuke_parser/parser.py nk_parser/nuke_parser/parser.pyparser/nuke_parser/parser.py renamed to nk_parser/nuke_parser/parser.py

@@ -39,5 +39,5 @@
         "Programming Language :: Python :: 3.12",
         "Topic :: Text Processing",
     ],
-    description="Nuke script (nk) parser.",
+    description="Nuke script (nk) nk_parser.",
 )

parser/nuke_parser/stack.py nk_parser/nuke_parser/stack.pyparser/nuke_parser/stack.py renamed to nk_parser/nuke_parser/stack.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"

parser/setup.py nk_parser/setup.pyparser/setup.py renamed to nk_parser/setup.py

@@ -18,12 +18,12 @@
 import platform
 import sys
 
-import nuke_parser.nkview
-from nuke_parser.nkview import utils
-from nuke_parser.nkview.constants import QT_STYLE
-from nuke_parser.nkview.graph_view import NukeNodeGraphWidget
-from nuke_parser.nkview.outliner import OutlinerWidget
-from nuke_parser.nkview.qt import QtCore, QtGui, QtWebEngineWidgets, QtWidgets
+import nkview
+from nkview import utils
+from nkview.constants import QT_STYLE
+from nkview.graph_view import NukeNodeGraphWidget
+from nkview.outliner import OutlinerWidget
+from nkview.qt import QtCore, QtGui, QtWebEngineWidgets, QtWidgets
 from nuke_parser.parser import _parseGizmos
 
 
@@ -153,7 +153,7 @@ def run() -> None:
     args = _setupCli()
     if platform.system() == "Windows":
         # Fix app icon on taskbar on Windows.
-        app_id = f"nuke_parser.nkview.{nuke_parser.nkview.__version__}"
+        app_id = f"nkview.{nkview.__version__}"
         ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(app_id)
 
     app = QtWidgets.QApplication(sys.argv)

nkview/nuke_parser/nkview/__init__.py nkview/nkview/__init__.pynkview/nuke_parser/nkview/__init__.py renamed to nkview/nkview/__init__.py

@@ -11,8 +11,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from nuke_parser.nkview.icons import qresource
-from nuke_parser.nkview.qt import QtGui
+from nkview.icons import qresource
+from nkview.qt import QtGui
 
 qresource.qInitResources()
 

nkview/nuke_parser/nkview/app.py nkview/nkview/app.pynkview/nuke_parser/nkview/app.py renamed to nkview/nkview/app.py

@@ -13,17 +13,22 @@
 # limitations under the License.
 from __future__ import annotations
 
+import platform
 import sys
 from typing import List, Optional, Union, Tuple
 
-from nuke_parser.nkview.gui_nodes import GroupNode, GuiNode
-from nuke_parser.nkview.navbar import NavigationBar
-from nuke_parser.nkview.qt import QtCore, QtGui, QtWidgets
-from nuke_parser.nkview.utils import qt_cursor
+from nkview.gui_nodes import GroupNode, GuiNode
+from nkview.navbar import NavigationBar
+from nkview.qt import QtCore, QtGui, QtWidgets
+from nkview.utils import qt_cursor
 from nuke_parser.parser import parseNk, Node
 
 INT_MAX = sys.maxsize // 2
 INT_MIN = ~sys.maxsize // 2
+if platform.system() == "Windows":
+    # https://github.com/maxWiklund/nuke_parser/issues/1
+    INT_MAX = (2**31) - 1  # Maximum value for a signed 32-bit integer
+    INT_MIN = -(2**31)  # Minimum value for a signed 32-bit integer
 
 
 class _PrivateApi:
@@ -45,6 +50,9 @@ def selectedItems(self) -> List[QtWidgets.QGraphicsItem]:
     def guiNodeFromPath(self, path: str) -> Optional[GuiNode]:
         return self._node_view._scene_map.get(path)
 
+    def clearSelection(self) -> None:
+        self._node_view.scene().clearSelection()
+
 
 class _NkGraphView(QtWidgets.QGraphicsView):
     """Private node graph view to to visualize nuke script."""
@@ -165,6 +173,7 @@ def mouseDoubleClickEvent(self, event: QtGui.QMouseEvent) -> None:
         if not gui_node or not isinstance(gui_node, GroupNode):
             super().mouseDoubleClickEvent(event)
             return
+
         self.stepIntoNode(gui_node)
 
     def stepIntoNode(self, gui_node: GroupNode) -> None:
@@ -176,9 +185,18 @@ def stepIntoNode(self, gui_node: GroupNode) -> None:
         """
         nk_node = gui_node.nk_node
         if nk_node.children() or nk_node.Class() in ("Group", "Root"):
+            # Store last viewport position to use when exiting the group.
+            viewport_rect = self.mapToScene(self.viewport().geometry()).boundingRect()
+            self.scene().groupNode().setViewportRect(viewport_rect)
+
             self.scene().clearSelection()
             self.setScene(gui_node.getScene())
-            self.frameSelected()
+
+            rect = gui_node.viewportRect()
+            if rect:
+                self.fitInView(rect, QtCore.Qt.KeepAspectRatio)
+            else:
+                self.frameSelected()
             self.sceneChanged.emit(gui_node)
 
     def frameSelected(self) -> None:
@@ -338,7 +356,7 @@ def privateApi(self) -> _PrivateApi:
         return self._private_api
 
     def selectedNodes(self) -> Tuple[Node, ...]:
-        """Get selected nodes as parser nodes."""
+        """Get selected nodes as nk_parser nodes."""
         return tuple(
             [
                 node.nk_node
@@ -347,9 +365,6 @@ def selectedNodes(self) -> Tuple[Node, ...]:
             ]
         )
 
-    def clearSelection(self) -> None:
-        self._view.scene().clearSelection()
-
     def _sceneLoadedCallback(self, root_node: GroupNode) -> None:
         """Scene loaded callback to deal with nav_bar.
 
@@ -367,9 +382,20 @@ def _changeSceneCallback(self, node: GroupNode) -> None:
             node: Node to view children of.
 
         """
+        # Store the current viewport position if the user wants to set into the group again.
+        viewport_rect = self._view.mapToScene(
+            self._view.viewport().geometry()
+        ).boundingRect()
+        self._view.scene().groupNode().setViewportRect(viewport_rect)
+
         self._view.setScene(node.getScene())
         self._view.scene().clearSelection()
-        self._view.frameSelected()
+
+        rect = node.viewportRect()
+        if rect:
+            self._view.fitInView(rect, QtCore.Qt.KeepAspectRatio)
+        else:
+            self.frameSelected()
 
     def _selectionChangedCallback(self) -> None:
         """Callback to emit selection change."""
@@ -418,7 +444,10 @@ def navigateToNode(self, path: str) -> None:
         if not gui_node:
             return
 
-        if not (gui_node.nk_node.isGizmo() or gui_node.nk_node.Class() == "Group"):
+        if not (
+            gui_node.nk_node.isGizmo()
+            or gui_node.nk_node.Class() in ("Group", "LiveGroup")
+        ):
             return
         nodes = []
 

nkview/nuke_parser/nkview/constants.py nkview/nkview/constants.pynkview/nuke_parser/nkview/constants.py renamed to nkview/nkview/constants.py

@@ -19,8 +19,8 @@
 
 import networkx as nx
 
-from nuke_parser.nkview import constants
-from nuke_parser.nkview.qt import QtCore, QtGui, QtWidgets, PYSIDE6
+from nkview import constants
+from nkview.qt import QtCore, QtGui, QtWidgets, PYSIDE6
 from nuke_parser.parser import Node
 from nuke_parser.stack import Stack
 
@@ -569,7 +569,24 @@ class GroupNode(DagNode):
     def __init__(self, nk_node: Node, scene_map: Dict[str, DagNode]):
         super(GroupNode, self).__init__(nk_node)
         scene_map[nk_node.path()] = self
-        self._scene = NkScene(nk_node, scene_map)
+        self._scene = NkScene(nk_node, scene_map, self)
+        self._viewport_rect = None
+
+    def viewportRect(self) -> Union[QtCore.QRectF, None]:
+        """Returns the viewport rect from the node (The scene area that was last viewed to restore
+        the view where the user left it).
+
+        """
+        return self._viewport_rect
+
+    def setViewportRect(self, rect: QtCore.QRect) -> None:
+        """Set the viewport rect on the node (the visible rectangle of the graphics-view).
+
+        Args:
+            rect: Rect to store.
+
+        """
+        self._viewport_rect = rect
 
     def getScene(self) -> QtWidgets.QGraphicsScene:
         """Get scene from node."""
@@ -622,8 +639,9 @@ def niceInputName(index: int, Class: str) -> str:
 class NkScene(QtWidgets.QGraphicsScene):
     """Scene that performs automatic layout on any node with missing position values."""
 
-    def __init__(self, root: Node, scene_map: Dict[str, DagNode]):
+    def __init__(self, root: Node, scene_map: Dict[str, DagNode], parent: GroupNode):
         super().__init__()
+        self._group_node = parent
         node_map = {}
         self._autoLayout(list(root.children()))
 
@@ -663,6 +681,15 @@ def __init__(self, root: Node, scene_map: Dict[str, DagNode]):
                 line.setPen(pen)
                 self.addItem(line)
 
+    def groupNode(self) -> GroupNode:
+        """Get the group node (the parent node of all nodes in the graphics scene).
+
+        Returns:
+            Parent node (GUI node) of all nodes in graphics scene.
+
+        """
+        return self._group_node
+
     @staticmethod
     def _assingLevels(G: nx.DiGraph) -> Dict[int, List[Node]]:
         """Assign levels to nodes in the graph based on their positions