Allow for an option to close other outputs for all scripts in pyrevit settings

dev/pyRevitLabs.PyRevit.Runtime/ScriptConsole.cs

@@ -376,6 +376,64 @@ public string GetFullHtml() {
             return ScriptConsoleConfigs.DOCTYPE + head.OuterHtml + ActiveDocument.Body.OuterHtml;
         }
 
+        private static (bool closeOthers, string closeMode) ReadCloseOtherOutputsSetting() {
+            try {
+                var appData = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
+                var cfg = System.IO.Path.Combine(appData, "pyRevit", "pyRevit_config.ini");
+                if (!System.IO.File.Exists(cfg))
+                    return (false, "current_command");
+
+                bool inCore = false;
+                bool close = false;
+                string mode = "current_command";
+                foreach (var raw in System.IO.File.ReadAllLines(cfg)) {
+                    var line = raw.Trim();
+                    if (line.Length == 0 || line.StartsWith("#") || line.StartsWith(";"))
+                        continue;
+
+                    if (line == "[core]") { inCore = true; continue; }
+                    if (line.StartsWith("[") && line.EndsWith("]")) { inCore = false; continue; }
+
+                    if (!inCore) continue;
+
+                    if (line.StartsWith("close_other_outputs", StringComparison.InvariantCultureIgnoreCase))
+                        close = line.IndexOf("true", StringComparison.InvariantCultureIgnoreCase) >= 0;
+
+                    else if (line.StartsWith("close_mode", StringComparison.InvariantCultureIgnoreCase)) {
+                        var parts = line.Split(new[] { '=' }, 2);
+                        if (parts.Length == 2)
+                            mode = parts[1].Trim().Trim('"');
+                    }
+                }
+                return (close, mode);
+            }
+            catch {
+                return (false, "current_command");
+            }
+        }
+
+        public void CloseOtherOutputs(bool filterByCommandId = true) {
+            try {
+                var filterId = filterByCommandId ? this.OutputId : null;
+                ScriptConsoleManager.CloseActiveOutputWindows(excludeOutputWindow: this, filterOutputWindowId: filterId);
+            }
+            catch {
+            }
+        }
+
+        private void ApplyCloseOtherOutputsIfConfigured() {
+            var (close, mode) = ReadCloseOtherOutputsSetting();
+            if (!close) return;
+
+            this.Dispatcher.BeginInvoke(new Action(() => {
+                if (string.Equals(mode, "current_command", StringComparison.InvariantCultureIgnoreCase))
+                    CloseOtherOutputs(filterByCommandId: true);
+                else if (string.Equals(mode, "close_all", StringComparison.InvariantCultureIgnoreCase)) {
+                    CloseOtherOutputs(filterByCommandId: false);
+                }
+            }));
+        }
+
         private void SetupDefaultPage(string styleSheetFilePath = null) {
             string cssFilePath;
             if (styleSheetFilePath != null)
@@ -448,7 +506,7 @@ public void FocusOutput() {
 
         public System.Windows.Forms.HtmlElement ComposeEntry(string contents, string HtmlElementType) {
             WaitReadyBrowser();
-            
+
             // order is important
             // "<"      --->    &lt;
             contents = ScriptConsoleConfigs.EscapeForHtml(contents);
@@ -552,7 +610,7 @@ public string GetInput() {
                     dbgMode = true;
                 }
             }
-            
+
             // if no debugger, find other patterns
             if (!dbgMode &&
                     new string[] { "select", "file" }.All(x => lastLine.Contains(x)))
@@ -782,6 +840,7 @@ public void SelfDestructTimer(int seconds) {
         private void Window_Loaded(object sender, System.EventArgs e) {
             var outputWindow = (ScriptConsole)sender;
             ScriptConsoleManager.AppendToOutputWindowList(this);
+            ApplyCloseOtherOutputsIfConfigured();
         }
 
         private void Window_Closing(object sender, System.ComponentModel.CancelEventArgs e) {

extensions/pyRevitCore.extension/pyRevit.tab/pyRevit.panel/Settings.smartbutton/SettingsWindow.ResourceDictionary.en_us.xaml

@@ -57,6 +57,23 @@
     <system:String x:Key="CoreSettings.Development.Description">Misc options for pyRevit development</system:String>
     <system:String x:Key="CoreSettings.Development.LoadBeta">Load Beta Tools (Scripts with __beta__ = True, Reload is required)</system:String>
 
+    <system:String x:Key="CoreSettings.CloseOtherConsoles">Close other open consoles</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Description">
+        If enabled, pyRevit will close other output consoles when a new script is run.
+        This helps to reduce the number of open output windows. Activate this option, unless you want to compare
+        multiple output data.
+    </system:String>
+
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Current">Current command consoles</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Current.Description">
+        Close all console windows associated with the current running command.
+    </system:String>
+
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.CloseAll">All consoles</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.CloseAll.Description">
+        Close all currently open console windows, even those that are not associated with the running command.
+    </system:String>
+
     <system:String x:Key="CoreSettings.Caching">Caching</system:String>
     <system:String x:Key="CoreSettings.Caching.Button">Reset Caching to default</system:String>
     <system:Double x:Key="CoreSettings.Caching.Button.With">200</system:Double>

extensions/pyRevitCore.extension/pyRevit.tab/pyRevit.panel/Settings.smartbutton/SettingsWindow.ResourceDictionary.fr_fr.xaml

@@ -57,6 +57,23 @@
     <system:String x:Key="CoreSettings.Development.Description">Options diverses pour le développement de pyRevit</system:String>
     <system:String x:Key="CoreSettings.Development.LoadBeta">Charger les outils bêta (Scripts avec __beta__ = True, le rechargement est requis)</system:String>
 
+    <system:String x:Key="CoreSettings.CloseOtherConsoles">Fermer les consoles ouvertes</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Description">
+        Si activé, pyRevit fermera les autres consoles de sortie lors de l'exécution d'un nouveau script.
+        Cela permet de réduire le nombre de fenêtres de sortie ouvertes. Activez cette option, sauf si vous
+        voulez comparez les sorties de plusieurs scripts.
+    </system:String>
+
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Current">Consoles de la commande actuelle</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Current.Description">
+        Fermer toutes les fenêtres de console associées à la commande en cours d'exécution.
+    </system:String>
+
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.CloseAll">Toutes les consoles</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.CloseAll.Description">
+        Fermer toutes les fenêtres de console actuellement ouvertes, même celles qui ne sont pas associées à la commande en cours.
+    </system:String>
+
     <system:String x:Key="CoreSettings.Caching">Mise en cache</system:String>
     <system:String x:Key="CoreSettings.Caching.Button">Reset la mise en cache par défaut</system:String>
     <system:Double x:Key="CoreSettings.Caching.Button.With">200</system:Double>

extensions/pyRevitCore.extension/pyRevit.tab/pyRevit.panel/Settings.smartbutton/SettingsWindow.ResourceDictionary.ru.xaml

@@ -58,6 +58,23 @@
     <system:String x:Key="CoreSettings.Development.Description">Разные настройки разработки pyRevit</system:String>
     <system:String x:Key="CoreSettings.Development.LoadBeta">Загружать бета-инструменты (Скрипты с __beta__ = True, требуется перезапуск)</system:String>
 
+    <system:String x:Key="CoreSettings.CloseOtherConsoles">Закрывать другие открытые консоли</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Description">
+        Если включено, pyRevit будет закрывать другие консоли вывода при запуске нового скрипта.
+        Это помогает уменьшить количество открытых окон вывода. Активируйте эту опцию, если вам
+        не требуется сравнивать данные из нескольких окон вывода.
+    </system:String>
+
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Current">Консоли текущей команды</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.Current.Description">
+        Закрыть все окна консоли, связанные с текущей выполняемой командой.
+    </system:String>
+
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.CloseAll">Все консоли</system:String>
+    <system:String x:Key="CoreSettings.CloseOtherConsoles.CloseAll.Description">
+        Закрыть все открытые в данный момент окна консоли, даже те, которые не связаны с выполняемой командой.
+    </system:String>
+
     <system:String x:Key="CoreSettings.Caching">Кеширование</system:String>
     <system:String x:Key="CoreSettings.Caching.Button">Сбросить настройки кеширования</system:String>
     <system:Double x:Key="CoreSettings.Caching.Button.With">220</system:Double>

extensions/pyRevitCore.extension/pyRevit.tab/pyRevit.panel/Settings.smartbutton/SettingsWindow.xaml

@@ -205,6 +205,23 @@
                                     <ToggleButton Style="{StaticResource AnimatedSwitch}" Height="24" x:Name="loadbetatools_cb" IsChecked="False"/>
                                     <TextBlock Margin="30,4,0,0" Text="{DynamicResource CoreSettings.Development.LoadBeta}"/>
                                 </WrapPanel>
+
+                                <StackPanel Margin="10,5,10,10">
+                                    <TextBlock FontWeight="Medium" Margin="0,5,0,0" Text="{DynamicResource CoreSettings.CloseOtherConsoles}"/>
+                                    <TextBlock TextWrapping="WrapWithOverflow" Margin="0,5,0,0" Text="{DynamicResource CoreSettings.CloseOtherConsoles.Description}"/>
+                                    <WrapPanel Margin="0,15,0,0">
+                                        <ToggleButton Style="{StaticResource AnimatedSwitch}" Height="24" x:Name="minimize_consoles_cb" IsChecked="False"/>
+                                        <TextBlock Margin="30,4,0,0" Text="Minimize the number of open consoles:" />
+                                    </WrapPanel>
+                                </StackPanel>
+
+                                <StackPanel Margin="26,0,0,10" IsEnabled="{Binding ElementName=minimize_consoles_cb, Path=IsChecked}">
+                                    <RadioButton x:Name="closewindows_current_rb" GroupName="console_close_mode" Margin="0,5,0,5" IsChecked="False" Content="{DynamicResource CoreSettings.CloseOtherConsoles.Current}"/>
+                                    <TextBlock TextWrapping="WrapWithOverflow" Margin="20,0,0,5" Text="{DynamicResource CoreSettings.CloseOtherConsoles.Current.Description}"/>
+
+                                    <RadioButton x:Name="closewindows_close_all_rb" GroupName="console_close_mode" Margin="0,10,0,5" IsChecked="False" Content="{DynamicResource CoreSettings.CloseOtherConsoles.CloseAll}"/>
+                                    <TextBlock TextWrapping="WrapWithOverflow" Margin="20,0,0,0" Text="{DynamicResource CoreSettings.CloseOtherConsoles.CloseAll.Description}"/>
+                                </StackPanel>
                             </StackPanel>
                         </GroupBox>
                         <GroupBox Header="{DynamicResource CoreSettings.Caching}" Margin="0,10,0,0">

extensions/pyRevitCore.extension/pyRevit.tab/pyRevit.panel/Settings.smartbutton/bundle.yaml

@@ -38,3 +38,5 @@ tooltip:
 
     Zeigt die Konfigurationsdatei im Explorer an. 
 context: zero-doc
+engine:
+  clean: true

extensions/pyRevitCore.extension/pyRevit.tab/pyRevit.panel/Settings.smartbutton/script.py

@@ -157,6 +157,15 @@ def _setup_core_options(self):
 
         self.loadbetatools_cb.IsChecked = user_config.load_beta
 
+        self.minimize_consoles_cb.IsChecked = user_config.output_close_others
+
+        if user_config.output_close_mode == 'current_command':
+            self.closewindows_current_rb.IsChecked = True
+            self.closewindows_close_all_rb.IsChecked = False
+        else: # 'close_all'
+            self.closewindows_current_rb.IsChecked = False
+            self.closewindows_close_all_rb.IsChecked = True
+
     def _setup_engines(self):
         """Sets up the list of available engines."""
         attachment = user_config.get_current_attachment()
@@ -846,6 +855,12 @@ def _save_core_options(self):
 
         user_config.load_beta = self.loadbetatools_cb.IsChecked
 
+        user_config.output_close_others = self.minimize_consoles_cb.IsChecked
+        if self.closewindows_current_rb.IsChecked:
+            user_config.output_close_mode = 'current_command'
+        else:
+            user_config.output_close_mode = 'close_all'
+
     def _save_engines(self):
         # set active cpython engine
         engine_cfg = self.cpythonEngines.SelectedItem

pyrevitlib/pyrevit/script.py

@@ -264,7 +264,7 @@ def get_data_file(file_id, file_ext, add_cmd_name=False):
         script.get_data_file('mydata', 'data', add_cmd_name=True)
         ```
         '/pyRevit_2018_Command Name_mydata.data'
-        
+
 
     Data files are not cleaned up at pyRevit startup.
     Script should manage cleaning up these files.
@@ -547,7 +547,7 @@ def load_ui(ui_instance, ui_file='ui.xaml', handle_esc=True, set_owner=True):
     """Load xaml file into given window instance.
 
     If window instance defines a method named `setup` it
-    will be called after loading 
+    will be called after loading
 
     Args:
         ui_instance (forms.WPFWindow): ui form instance
@@ -679,29 +679,29 @@ def store_data(slot_name, data, this_project=True):
         ```python
         from pyrevit import revit
             from pyrevit import script
-        
-        
+
+
             class CustomData(object):
                 def __init__(self, count, element_ids):
                     self._count = count
                     # serializes the Revit native objects
                     self._elmnt_ids = [revit.serialize(x) for x in element_ids]
-        
+
                 @property
                 def count(self):
                     return self._count
-        
+
                 @property
                 def element_ids(self):
                     # de-serializes the Revit native objects
                     return [x.deserialize() for x in self._elmnt_ids]
-        
-        
+
+
             mydata = CustomData(
                 count=3,
                 element_ids=[<DB.ElementId>, <DB.ElementId>, <DB.ElementId>]
             )
-        
+
             script.store_data("Selected Elements", mydata)
         ```
 
@@ -740,24 +740,24 @@ def load_data(slot_name, this_project=True):
         ```python
         from pyrevit import revit
         from pyrevit import script
-        
-        
+
+
             class CustomData(object):
                 def __init__(self, count, element_ids):
                     self._count = count
                     # serializes the Revit native objects
                     self._elmnt_ids = [revit.serialize(x) for x in element_ids]
-        
+
                 @property
                 def count(self):
                     return self._count
-        
+
                 @property
                 def element_ids(self):
                     # de-serializes the Revit native objects
                     return [x.deserialize() for x in self._elmnt_ids]
-        
-        
+
+
             mydata = script.load_data("Selected Elements")
             mydata.element_ids
         ```

pyrevitlib/pyrevit/userconfig.py

@@ -50,7 +50,21 @@
 from pyrevit.coreutils import configparser
 from pyrevit.coreutils import logger
 from pyrevit.versionmgr import upgrade
+# pylint: disable=C0103,C0413,W0703
+import os
+import os.path as op
 
+from pyrevit import EXEC_PARAMS, HOME_DIR, HOST_APP
+from pyrevit import EXTENSIONS_DEFAULT_DIR, THIRDPARTY_EXTENSIONS_DEFAULT_DIR
+from pyrevit import PYREVIT_ALLUSER_APP_DIR, PYREVIT_APP_DIR
+from pyrevit import PyRevitException
+from pyrevit import coreutils
+from pyrevit.compat import winreg as wr
+from pyrevit.coreutils import appdata
+from pyrevit.coreutils import configparser
+from pyrevit.coreutils import logger
+from pyrevit.labs import PyRevit
+from pyrevit.versionmgr import upgrade
 
 DEFAULT_CSV_SEPARATOR = ','
 
@@ -302,6 +316,36 @@ def load_beta(self, state):
             value=state
         )
 
+    @property
+    def output_close_others(self):
+        """Whether to close other output windows."""
+        return self.core.get_option(
+            'close_other_outputs',
+            default_value=False,
+        )
+
+    @output_close_others.setter
+    def output_close_others(self, state):
+        self.core.set_option(
+            'close_other_outputs',
+            value=state
+        )
+
+    @property
+    def output_close_mode(self):
+        """Output window closing mode: 'current_command' or 'close_all'."""
+        return self.core.get_option(
+            'close_mode',
+            default_value='current_command',
+        )
+
+    @output_close_mode.setter
+    def output_close_mode(self, mode):
+        self.core.set_option(
+            'close_mode',
+            value=mode
+        )
+
     @property
     def cpython_engine_version(self):
         """CPython engine version to use."""