adding pre-commit with static type checking

Author: bhowiebkr

.gitignore

@@ -106,4 +106,4 @@ venv.bak/
 temp
 
 #vscode settings
-settings.json
+settings.json

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0  # Use the ref you want to point at
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+
+-   repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+    -   id: black
+        args: [--line-length=120]
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.2
+    hooks:
+    -   id: mypy
+        args: [--strict, --ignore-missing-imports]
+
+-   repo: https://github.com/pycqa/flake8
+    rev: 7.1.1
+    hooks:
+    -   id: flake8
+        additional_dependencies: [flake8-typing-imports==1.12.0]
+        args: [--max-line-length=120]
+
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.13.0
+    hooks:
+    -   id: reorder-python-imports
+        args: [--py37-plus, --add-import, 'from __future__ import annotations']
+
+-   repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v2.5.0
+    hooks:
+    -   id: setup-cfg-fmt

Example_Project/Add_node.py

@@ -1,12 +1,16 @@
+from __future__ import annotations
+
+from typing import Tuple
+
 from node_editor.node import Node
 
 
 class Add_Node(Node):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
-        self.title_text = "Add"
-        self.type_text = "Logic Nodes"
+        self.title_text: str = "Add"
+        self.type_text: str = "Logic Nodes"
         self.set_color(title_color=(0, 128, 0))
 
         self.add_pin(name="Ex In", is_output=False, execution=True)
@@ -16,3 +20,15 @@ def __init__(self):
         self.add_pin(name="input B", is_output=False)
         self.add_pin(name="output", is_output=True)
         self.build()
+
+    def set_color(self, title_color: Tuple[int, int, int]) -> None:
+        # Assuming set_color is defined in the parent class
+        super().set_color(title_color=title_color)
+
+    def add_pin(self, name: str, is_output: bool, execution: bool = False) -> None:
+        # Assuming add_pin is defined in the parent class
+        super().add_pin(name=name, is_output=is_output, execution=execution)
+
+    def build(self) -> None:
+        # Assuming build is defined in the parent class
+        super().build()

Example_Project/Print_node.py

@@ -1,15 +1,31 @@
+from __future__ import annotations
+
+from typing import Tuple
+
 from node_editor.node import Node
 
 
 class Print_Node(Node):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
-        self.title_text = "Print"
-        self.type_text = "Debug Nodes"
+        self.title_text: str = "Print"
+        self.type_text: str = "Debug Nodes"
         self.set_color(title_color=(160, 32, 240))
 
         self.add_pin(name="Ex In", is_output=False, execution=True)
 
         self.add_pin(name="input", is_output=False)
         self.build()
+
+    def set_color(self, title_color: Tuple[int, int, int]) -> None:
+        # Assuming set_color is defined in the parent class
+        super().set_color(title_color=title_color)
+
+    def add_pin(self, name: str, is_output: bool, execution: bool = False) -> None:
+        # Assuming add_pin is defined in the parent class
+        super().add_pin(name=name, is_output=is_output, execution=execution)
+
+    def build(self) -> None:
+        # Assuming build is defined in the parent class
+        super().build()

Example_Project/Scaler_node.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 from PySide6 import QtWidgets
 
-from node_editor.node import Node
 from Example_Project.common_widgets import FloatLineEdit
+from node_editor.node import Node
 
 
 class Scaler_Node(Node):

Example_Project/__init__.py

@@ -1,28 +1,35 @@
-from PySide6 import QtWidgets
+from __future__ import annotations
+
+from typing import Optional
+from typing import Tuple
+
 from PySide6 import QtGui
+from PySide6 import QtWidgets
 from PySide6.QtCore import Qt
 
-class FloatLineEdit(QtWidgets.QLineEdit):
-    def __init__(self, parent=None):
+
+class FloatLineEdit(QtWidgets.QLineEdit):  # type: ignore
+    def __init__(self, parent: Optional[QtWidgets.QWidget] = None) -> None:
         super().__init__(parent)
         self.setValidator(FloatValidator())
 
-    def keyPressEvent(self, event):
+    def keyPressEvent(self, event: QtGui.QKeyEvent) -> None:
         if event.key() == Qt.Key_Space:
             event.ignore()
         else:
             super().keyPressEvent(event)
 
-class FloatValidator(QtGui.QDoubleValidator):
-    def __init__(self, parent=None):
+
+class FloatValidator(QtGui.QDoubleValidator):  # type: ignore
+    def __init__(self, parent: Optional[QtGui.QObject] = None) -> None:
         super().__init__(parent)
 
-    def validate(self, input_str, pos):
+    def validate(self, input_str: str, pos: int) -> Tuple[QtGui.QValidator.State, str, int]:
         state, num, pos = super().validate(input_str, pos)
         if state == QtGui.QValidator.Acceptable:
             return QtGui.QValidator.Acceptable, num, pos
-        if str(num).count('.') > 1:
+        if str(num).count(".") > 1:
             return QtGui.QValidator.Invalid, num, pos
-        if input_str[pos-1] == '.':
+        if input_str[pos - 1] == ".":
             return QtGui.QValidator.Acceptable, num, pos
-        return QtGui.QValidator.Invalid, num, pos
+        return QtGui.QValidator.Invalid, num, pos

Example_Project/common_widgets.py

@@ -63,4 +63,4 @@
             "end_pin": "Ex In"
         }
     ]
-}
+}

Example_Project/test.json

@@ -6,7 +6,7 @@ The tool is designed to allow you to write Python code in individual files per c
 
 My goal with this project is to provide a new and innovative way of organizing and working with Python code. While the tool is still in the development phase, I am constantly working to improve its functionality and features.
 
-Visual scripting using nodes does have some benefits and drawbacks and it’s up to the end developer to decide when such a system is beneficial or not. 
+Visual scripting using nodes does have some benefits and drawbacks and it’s up to the end developer to decide when such a system is beneficial or not.
 
 ![nodes](https://github.com/bhowiebkr/simple-node-editor/blob/master/images/node_editor2.jpg)
 
@@ -16,7 +16,7 @@ Use it for:
 - enabling non-programmers a simple system to assemble blocks of logic
 - networks that require a high level of feedback throughout that network and not just the end result. Example shader building, sound synthesizing, machine learning, robotics and sensors. Each node can have a custom visual feedback such as images, graphs, sound timelines, spreadsheets etc.
 - prototyping logic.
-- Generator scripts. Taking an input or building up a result that gets saved for other uses. Example textures, images, sound, ML training data. 
+- Generator scripts. Taking an input or building up a result that gets saved for other uses. Example textures, images, sound, ML training data.
 
 Don’t use it for
 - Anything complex. 40 nodes or less. This is because the user not only needs to think of how nodes are logically connected, but also the visual composure of nodes in the graph. It’s always best to refactor code when a graph gets too complex to make sense of.
@@ -27,4 +27,3 @@ For minimal GUI code for creating a node network see [GUI-nodes-only](https://gi
 
 
 [![Video](http://img.youtube.com/vi/DOsFJ8lm9dU/0.jpg)](http://www.youtube.com/watch?v=DOsFJ8lm9dU)
-

README.md

@@ -0,0 +1,7 @@
+@echo off
+
+:: Activate the virtual environment
+call venv\Scripts\activate
+
+:: Start the three Python programs in separate command windows
+start cmd /k python .\main.py

launch.bat

@@ -9,28 +9,39 @@
 Author: Bryan Howard
 Repo: https://github.com/bhowiebkr/simple-node-editor
 """
+from __future__ import annotations
 
-import logging
-from pathlib import Path
 import importlib
 import inspect
+import logging
+import sys
+from pathlib import Path
+from typing import Any
+from typing import Dict
+from typing import Optional
 
-from PySide6 import QtCore, QtGui, QtWidgets
+import qdarktheme
+from PySide6 import QtCore
+from PySide6 import QtGui
+from PySide6 import QtWidgets
+from PySide6.QtCore import QByteArray  # Or from PySide2.QtCore import QByteArray
 
 from node_editor.gui.node_list import NodeList
 from node_editor.gui.node_widget import NodeWidget
 
 logging.basicConfig(level=logging.DEBUG)
 
 
-class NodeEditor(QtWidgets.QMainWindow):
+class NodeEditor(QtWidgets.QMainWindow):  # type: ignore
     OnProjectPathUpdate = QtCore.Signal(Path)
 
-    def __init__(self, parent=None):
+    def __init__(self, parent: Optional[QtWidgets.QWidget] = None) -> None:
         super().__init__(parent)
-        self.settings = None
-        self.project_path = None
-        self.imports = None  # we will store the project import node types here for now.
+        self.settings: Optional[QtCore.QSettings] = None
+        self.project_path: Optional[Path] = None
+        self.imports: Optional[Dict[str, Dict[str, Any]]] = (
+            None  # we will store the project import node types here for now.
+        )
 
         icon = QtGui.QIcon("resources\\app.ico")
         self.setWindowIcon(icon)
@@ -59,10 +70,10 @@ def __init__(self, parent=None):
         left_layout.setContentsMargins(0, 0, 0, 0)
 
         # Widgets
-        self.node_list = NodeList(self)
+        self.node_list: NodeList = NodeList(self)
         left_widget = QtWidgets.QWidget()
-        self.splitter = QtWidgets.QSplitter()
-        self.node_widget = NodeWidget(self)
+        self.splitter: QtWidgets.QSplitter = QtWidgets.QSplitter()
+        self.node_widget: NodeWidget = NodeWidget(self)
 
         # Add Widgets to layouts
         self.splitter.addWidget(left_widget)
@@ -72,25 +83,25 @@ def __init__(self, parent=None):
         main_layout.addWidget(self.splitter)
 
         # Load the example project
-        example_project_path = (Path(__file__).parent.resolve() / 'Example_project')
+        example_project_path = Path(__file__).parent.resolve() / "Example_project"
         self.load_project(example_project_path)
 
         # Restore GUI from last state
         if settings.contains("geometry"):
-            self.restoreGeometry(settings.value("geometry"))
+            self.restoreGeometry(QByteArray(settings.value("geometry")))
 
             s = settings.value("splitterSize")
             self.splitter.restoreState(s)
 
-    def save_project(self):
+    def save_project(self) -> None:
         file_dialog = QtWidgets.QFileDialog()
         file_dialog.setAcceptMode(QtWidgets.QFileDialog.AcceptSave)
         file_dialog.setDefaultSuffix("json")
         file_dialog.setNameFilter("JSON files (*.json)")
         file_path, _ = file_dialog.getSaveFileName()
         self.node_widget.save_project(file_path)
 
-    def load_project(self, project_path=None):
+    def load_project(self, project_path: Optional[Path] = None) -> None:
         if not project_path:
             return
 
@@ -101,36 +112,35 @@ def load_project(self, project_path=None):
             self.imports = {}
 
             for file in project_path.glob("*.py"):
-
-                if not file.stem.endswith('_node'):
-                    print('file:', file.stem)
+                if not file.stem.endswith("_node"):
+                    print("file:", file.stem)
                     continue
                 spec = importlib.util.spec_from_file_location(file.stem, file)
                 module = importlib.util.module_from_spec(spec)
                 spec.loader.exec_module(module)
 
                 for name, obj in inspect.getmembers(module):
-                    if not name.endswith('_Node'):
+                    if not name.endswith("_Node"):
                         continue
                     if inspect.isclass(obj):
                         self.imports[obj.__name__] = {"class": obj, "module": module}
-                        #break
+                        # break
 
             self.node_list.update_project(self.imports)
 
             # work on just the first json file. add the ablitity to work on multiple json files later
             for json_path in project_path.glob("*.json"):
-                self.node_widget.load_scene(json_path, self.imports)
+                self.node_widget.load_scene(str(json_path), self.imports)
                 break
 
-    def get_project_path(self):
+    def get_project_path(self) -> None:
         project_path = QtWidgets.QFileDialog.getExistingDirectory(None, "Select Project Folder", "")
         if not project_path:
             return
 
-        self.load_project(project_path)
+        self.load_project(Path(project_path))
 
-    def closeEvent(self, event):
+    def closeEvent(self, event: QtGui.QCloseEvent) -> None:
         """
         Handles the close event by saving the GUI state and closing the application.
 
@@ -151,9 +161,6 @@ def closeEvent(self, event):
 
 
 if __name__ == "__main__":
-    import sys
-
-    import qdarktheme
 
     app = QtWidgets.QApplication(sys.argv)
     app.setWindowIcon(QtGui.QIcon("resources\\app.ico"))

main.py

@@ -0,0 +1,4 @@
+[mypy]
+python_version = 3.8
+ignore_missing_imports = True
+strict = True

mypy.ini

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from enum import Enum