Merge pull request #347 from tinymovr/studio/GUI_console

Add GUI console

Author: yconst

studio/Python/setup.py

@@ -60,6 +60,7 @@
         "docopt",
         "flatten-dict",
         "pint",
+        "pretty_errors"
     ],
     extras_require={"gui": ["pyside6", "pyqtgraph>=0.13.3"]},
     entry_points={

studio/Python/tinymovr/gui/__init__.py

@@ -7,11 +7,14 @@
     display_file_open_dialog,
     display_file_save_dialog,
     magnitude_of,
+    StreamRedirector,
+    QTextBrowserLogger,
     TimedGetter,
     check_selected_items,
     get_dynamic_attrs,
     is_dark_mode,
-    strtobool
+    strtobool,
+    configure_pretty_errors
 )
 from tinymovr.gui.widgets import (
     NodeTreeWidgetItem,

studio/Python/tinymovr/gui/helpers.py

@@ -16,16 +16,29 @@
 """
 
 import time
+import logging
+from datetime import datetime
 import os
 import enum
 import pint
 from PySide6 import QtGui
-from PySide6.QtGui import QGuiApplication, QPalette
+from PySide6.QtGui import QGuiApplication, QPalette, QTextCursor
 from PySide6.QtWidgets import QMessageBox, QFileDialog
 from avlos.definitions import RemoteAttribute, RemoteEnum, RemoteBitmask
+import pretty_errors
 import tinymovr
 
 
+class ConsoleColor:
+    NORMAL = "<font color='white'>"
+    ERROR = "<font color='red'>"
+    WARNING = "<font color='orange'>"
+    INFO = "<font color='lightblue'>"
+    DEBUG = "<font color='lightgreen'>"
+    TIMESTAMP = "<font color='gray'>"
+    END = "</font>"
+
+
 app_stylesheet = """
 
 /* --------------------------------------- QPushButton -----------------------------------*/
@@ -466,6 +479,67 @@ def magnitude_of(val):
     return val
 
 
+class StreamRedirector(object):
+    """
+    A class to redirect writes from a stream to a QPlainTextEdit, including pretty_errors handling and timestamps.
+    """
+    def __init__(self, widget):
+        self.widget = widget
+        self.buffer = ''
+
+    def write(self, message):
+        # Timestamp the message
+        timestamp = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
+        message_with_timestamp = f"[{timestamp}] {message}"
+
+        # Redirect to the QPlainTextEdit widget
+        self.widget.moveCursor(QtGui.QTextCursor.End)
+        self.widget.insertPlainText(message_with_timestamp)
+        self.widget.ensureCursorVisible()
+
+    def flush(self):
+        pass
+
+
+class QTextBrowserLogger(logging.Handler):
+    """A logging handler that directs logging output to a QTextBrowser widget."""
+    def __init__(self, widget):
+        super().__init__()
+        self.widget = widget
+        self.widget.setReadOnly(True)
+        self.setFormatter(logging.Formatter('%(levelname)s: %(message)s'))
+
+    def emit(self, record):
+        msg = self.format(record)
+        self.widget.append(self.colorize_message(record.levelno, msg))
+
+    def colorize_message(self, level, message):
+        color = {
+            logging.DEBUG: "lightgreen",
+            logging.INFO: "lightblue",
+            logging.WARNING: "orange",
+            logging.ERROR: "red",
+            logging.CRITICAL: "purple"
+        }.get(level, "black")
+        timestamp = datetime.now().strftime('%H:%M:%S')
+        return f'<font color="gray">[{timestamp}]</font> <font color="{color}">{message}</font>'
+    
+
+def configure_pretty_errors():
+    pretty_errors.configure(
+        separator_character='*',
+        filename_display=pretty_errors.FILENAME_EXTENDED,
+        line_number_first=True,
+        display_link=True,
+        lines_before=5,
+        lines_after=2,
+        line_color=pretty_errors.RED + '> ' + pretty_errors.default_config.line_color,
+        code_color='  ' + pretty_errors.default_config.code_color,
+        truncate_code=True,  # Truncate code lines to not overflow in the GUI
+        display_locals=True
+    )
+
+
 class TimedGetter:
     """
     An interface class that maintains timing

studio/Python/tinymovr/gui/window.py

@@ -15,6 +15,7 @@
 this program. If not, see <http://www.gnu.org/licenses/>.
 """
 
+import sys
 import time
 import logging
 import pkg_resources
@@ -28,13 +29,13 @@
     QMenuBar,
     QWidget,
     QFrame,
-    QHBoxLayout,
     QVBoxLayout,
     QHeaderView,
     QLabel,
     QMessageBox,
     QTreeWidgetItem,
-    QSplitter
+    QSplitter,
+    QTextBrowser
 )
 from PySide6.QtGui import QAction
 import pyqtgraph as pg
@@ -52,11 +53,14 @@
     Worker,
     PlaceholderQTreeWidget,
     BoolTreeWidgetItem,
+    StreamRedirector,
+    QTextBrowserLogger,
     format_value,
     display_file_open_dialog,
     display_file_save_dialog,
     magnitude_of,
     check_selected_items,
+    configure_pretty_errors
 )
 
 
@@ -71,10 +75,8 @@ def __init__(self, app, arguments, logger):
         get_registry().default_format = ".6f~"
 
         self.start_time = time.time()
-        if logger is None:
-            self.logger = logging.getLogger("tinymovr")
-        else:
-            self.logger = logger
+        self.logger = logger if logger is not None else logging.getLogger("tinymovr")
+        configure_pretty_errors()
 
         self.attr_widgets_by_id = {}
         self.graphs_by_id = {}
@@ -86,6 +88,7 @@ def __init__(self, app, arguments, logger):
 
         self.file_menu = QMenu("File")
         self.help_menu = QMenu("Help")
+        self.view_menu = QMenu("View")
 
         self.export_action = QAction("Export Config...", self)
         self.import_action = QAction("Import Config", self)
@@ -97,11 +100,19 @@ def __init__(self, app, arguments, logger):
         self.file_menu.addAction(self.import_action)
         self.help_menu.addAction(self.about_action)
 
+        self.toggle_tree_action = QAction("Hide Tree", self)  # Assume tree is visible initially
+        self.toggle_tree_action.triggered.connect(self.toggle_tree)
+        self.toggle_console_action = QAction("Hide Console", self)  # Assume console is visible initially
+        self.toggle_console_action.triggered.connect(self.toggle_console)
+
+        self.view_menu.addAction(self.toggle_tree_action)
+        self.view_menu.addAction(self.toggle_console_action)
+
         self.menu_bar.addMenu(self.file_menu)
+        self.menu_bar.addMenu(self.view_menu)
         self.menu_bar.addMenu(self.help_menu)
         self.setMenuBar(self.menu_bar)
 
-        # Setup the tree widget
         self.tree_widget = PlaceholderQTreeWidget()
         self.tree_widget.itemChanged.connect(self.item_changed)
         self.tree_widget.itemExpanded.connect(self.update_visible_attrs)
@@ -111,14 +122,13 @@ def __init__(self, app, arguments, logger):
         self.status_label = QLabel()
         self.status_label.setStyleSheet("margin: 5px;")
 
-        # Create splitter and add frames
         self.splitter = QSplitter(QtCore.Qt.Horizontal)
         self.splitter.setHandleWidth(0)
+        self.splitter.splitterMoved.connect(self.check_tree_visibility)
 
         self.left_frame = QFrame(self)
         self.left_layout = QVBoxLayout()
         self.left_layout.addWidget(self.tree_widget)
-        self.left_layout.addWidget(self.status_label)
         self.left_layout.setSpacing(0)
         self.left_layout.setContentsMargins(0, 0, 0, 0)
         self.left_frame.setLayout(self.left_layout)
@@ -135,11 +145,24 @@ def __init__(self, app, arguments, logger):
         self.splitter.addWidget(self.left_frame)
         self.splitter.addWidget(self.right_frame)
 
+        self.console = QTextBrowser()
+        self.console.setReadOnly(True)
+        self.log_handler = QTextBrowserLogger(self.console)
+        self.logger.addHandler(self.log_handler)
+
+        self.main_splitter = QSplitter(QtCore.Qt.Vertical)
+        self.main_splitter.setHandleWidth(0)
+        self.main_splitter.showEvent = self.on_show_event
+        self.main_splitter.splitterMoved.connect(self.check_console_visibility)
+        self.main_splitter.addWidget(self.splitter)
+        self.main_splitter.addWidget(self.console)
+
         main_layout = QVBoxLayout()
-        main_layout.addWidget(self.splitter)
+        main_layout.addWidget(self.main_splitter)
+        main_layout.addWidget(self.status_label)
         main_layout.setSpacing(0)
         main_layout.setContentsMargins(0, 0, 0, 0)
-
+        
         main_widget = QWidget()
         main_widget.setLayout(main_layout)
         main_widget.setMinimumHeight(600)
@@ -181,6 +204,18 @@ def __init__(self, app, arguments, logger):
         self.visibility_update_timer.timeout.connect(self.update_visible_attrs)
         self.visibility_update_timer.start(1000)
 
+    def on_show_event(self, event):
+        total_height = self.splitter.size().height()
+        top_percentage = 0.75  # 75% for the top widget
+        bottom_percentage = 0.25  # 25% for the bottom widget
+
+        top_size = int(total_height * top_percentage)
+        bottom_size = int(total_height * bottom_percentage)
+        
+        self.main_splitter.setSizes([top_size, bottom_size])
+
+        super(MainWindow, self).showEvent(event)
+
     @QtCore.Slot()
     def about_to_quit(self):
         self.visibility_update_timer.stop()
@@ -361,6 +396,60 @@ def show_about_box(self):
             ),
         )
 
+    def toggle_tree(self):
+        """
+        Toggle the visibility of the tree based on actual size.
+        """
+        tree_size = self.splitter.sizes()[0]
+        if tree_size > 0:
+            self.tree_widget.setVisible(False)
+            self.splitter.setSizes([0, self.splitter.size().width()])
+            self.toggle_tree_action.setText("Show Tree")
+        else:
+            self.tree_widget.setVisible(True)
+            total_size = self.splitter.size().width()
+            left_size = int(total_size * 0.25)
+            right_size = int(total_size * 0.75)
+            self.splitter.setSizes([left_size, right_size])
+            self.toggle_tree_action.setText("Hide Tree")
+
+    def toggle_console(self):
+        """
+        Toggle the visibility of the console based on actual size.
+        """
+        console_height = self.main_splitter.sizes()[-1]
+        if console_height > 0:
+            self.console.setVisible(False)
+            self.main_splitter.setSizes([self.main_splitter.size().height(), 0])
+            self.toggle_console_action.setText("Show Console")
+        else:
+            self.console.setVisible(True)
+            total_height = self.main_splitter.size().height()
+            top_height = int(total_height * 0.75)
+            bottom_height = int(total_height * 0.25)
+            self.main_splitter.setSizes([top_height, bottom_height])
+            self.toggle_console_action.setText("Hide Console")
+
+    def check_tree_visibility(self, pos, index):
+        """
+        Check tree visibility after splitter is moved and update the action text.
+        """
+        tree_size = self.splitter.sizes()[0]  # Assuming tree is always the first widget in the splitter
+        if tree_size == 0:
+            self.toggle_tree_action.setText("Show Tree")
+        else:
+            self.toggle_tree_action.setText("Hide Tree")
+
+    def check_console_visibility(self, pos, index):
+        """
+        Check console visibility after splitter is moved and update the action text.
+        """
+        console_size = self.main_splitter.sizes()[-1]  # Assuming console is always the last widget in the splitter
+        if console_size == 0:
+            self.toggle_console_action.setText("Show Console")
+        else:
+            self.toggle_console_action.setText("Hide Console")
+
     def is_widget_visible(self, widget):
         """
         Check if the given widget is visible, i.e., not hidden and all its

studio/Python/tinymovr/gui/worker.py

@@ -140,6 +140,7 @@ def _update(self):
     def _device_appeared(self, device, node_id):
         self.mutx.lock()
         display_name = "{}{}".format(device.name, node_id)
+        self.logger.info("Found {} (uid {})".format(display_name, device.uid))
         self.devices_by_name[display_name] = device
         self.names_by_id[node_id] = display_name
         device.name = display_name