fix(monaco_dock): update editor metadata handling and improve open_file method

bec_widgets/applications/views/developer_view/developer_widget.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 import markdown
@@ -13,6 +15,7 @@ from bec_widgets.utils.toolbars.bundles import ToolbarBundle
 from bec_widgets.utils.toolbars.toolbar import ModularToolBar
 from bec_widgets.widgets.containers.advanced_dock_area.advanced_dock_area import AdvancedDockArea
 from bec_widgets.widgets.containers.advanced_dock_area.basic_dock_area import DockAreaWidget
+from bec_widgets.widgets.containers.qt_ads import CDockWidget
 from bec_widgets.widgets.editors.monaco.monaco_dock import MonacoDock
 from bec_widgets.widgets.editors.monaco.monaco_widget import MonacoWidget
 from bec_widgets.widgets.editors.web_console.web_console import WebConsole
@@ -124,6 +127,7 @@ class DeveloperWidget(DockAreaWidget):
         # Connect editor signals
         self.explorer.file_open_requested.connect(self._open_new_file)
         self.monaco.macro_file_updated.connect(self.explorer.refresh_macro_file)
+        self.monaco.focused_editor.connect(self._on_focused_editor_changed)
 
         self.toolbar.show_bundles(["save", "execution", "settings"])
 
@@ -280,14 +284,17 @@ class DeveloperWidget(DockAreaWidget):
 
     @SafeSlot()
     def on_save(self):
+        """Save the currently focused file in the Monaco editor."""
         self.monaco.save_file()
 
     @SafeSlot()
     def on_save_as(self):
+        """Save the currently focused file in the Monaco editor with a 'Save As' dialog."""
         self.monaco.save_file(force_save_as=True)
 
     @SafeSlot()
     def on_vim_triggered(self):
+        """Toggle Vim mode in the Monaco editor."""
         self.monaco.set_vim_mode(self.toolbar.components.get_action("vim").action.isChecked())
 
     @SafeSlot(bool)
@@ -310,16 +317,26 @@ class DeveloperWidget(DockAreaWidget):
 
     @SafeSlot()
     def on_stop(self):
+        """Stop the execution of the currently running script"""
         if not self.current_script_id:
             return
         self.console.send_ctrl_c()
 
     @property
     def current_script_id(self):
+        """Get the ID of the currently running script."""
         return self._current_script_id
 
     @current_script_id.setter
     def current_script_id(self, value: str | None):
+        """
+        Set the ID of the currently running script.
+
+        Args:
+            value (str | None): The script ID to set.
+        Raises:
+            ValueError: If the provided value is not a string or None.
+        """
         if value is not None and not isinstance(value, str):
             raise ValueError("Script ID must be a string.")
         old_script_id = self._current_script_id
@@ -336,6 +353,28 @@ class DeveloperWidget(DockAreaWidget):
                 self.on_script_execution_info, MessageEndpoints.script_execution_info(new_script_id)
             )
 
+    @SafeSlot(CDockWidget)
+    def _on_focused_editor_changed(self, tab_widget: CDockWidget):
+        """
+        Disable the run button if the focused editor is a macro file.
+        Args:
+            tab_widget: The currently focused tab widget in the Monaco editor.
+        """
+        if not isinstance(tab_widget, CDockWidget):
+            return
+        widget = tab_widget.widget()
+        if not isinstance(widget, MonacoWidget):
+            return
+        file_scope = widget.metadata.get("scope", "")
+        run_action = self.toolbar.components.get_action("run")
+        stop_action = self.toolbar.components.get_action("stop")
+        if "macro" in file_scope:
+            run_action.action.setEnabled(False)
+            stop_action.action.setEnabled(False)
+        else:
+            run_action.action.setEnabled(True)
+            stop_action.action.setEnabled(True)
+
     @SafeSlot(dict, dict)
     def on_script_execution_info(self, content: dict, metadata: dict):
         """
@@ -359,6 +398,7 @@ class DeveloperWidget(DockAreaWidget):
         widget.set_highlighted_lines(line_number, line_number)
 
     def cleanup(self):
+        """Clean up resources used by the developer widget."""
         self.delete_all()
         return super().cleanup()
 

bec_widgets/widgets/editors/monaco/monaco_dock.py

@@ -142,9 +142,12 @@ class MonacoDock(DockAreaWidget):
             # Temporarily disable read-only mode if the editor is read-only
             # so we can clear the content for reuse
             monaco_widget.set_readonly(False)
-            monaco_widget.set_text("")
+            monaco_widget.set_text("", reset=True)
             dock.setWindowTitle("Untitled")
             dock.setTabToolTip("Untitled")
+            monaco_widget.metadata["scope"] = ""
+            icon = self._resolve_dock_icon(monaco_widget, dock_icon=None, apply_widget_icon=True)
+            dock.setIcon(icon)
             return
 
         # Otherwise, proceed to close and delete the dock
@@ -249,10 +252,15 @@ class MonacoDock(DockAreaWidget):
         self.last_focused_editor = dock
         return dock
 
-    def open_file(self, file_name: str, scope: str | None = None) -> None:
+    def open_file(self, file_name: str, scope: str = "") -> None:
         """
         Open a file in the specified area. If the file is already open, activate it.
+
+        Args:
+            file_name (str): The path to the file to open.
+            scope (str): The scope to set for the editor metadata.
         """
+
         open_files = self._get_open_files()
         if file_name in open_files:
             dock = self._get_editor_dock(file_name)
@@ -281,8 +289,7 @@ class MonacoDock(DockAreaWidget):
                 editor_dock.setWindowTitle(file)
                 editor_dock.setTabToolTip(file_name)
                 editor_widget.open_file(file_name)
-                if scope is not None:
-                    editor_widget.metadata["scope"] = scope
+                editor_widget.metadata["scope"] = scope
                 self.last_focused_editor = editor_dock
                 return
 
@@ -290,8 +297,7 @@ class MonacoDock(DockAreaWidget):
         editor_dock = self.add_editor(title=file, tooltip=file_name)
         widget = cast(MonacoWidget, editor_dock.widget())
         widget.open_file(file_name)
-        if scope is not None:
-            widget.metadata["scope"] = scope
+        widget.metadata["scope"] = scope
         editor_dock.setAsCurrentTab()
         self.last_focused_editor = editor_dock