Merge pull request #25028 from CAM-Gerlach/console-confpage-increase-buffer

PR: Increase default max console buffer and warn if it's big (IPython console)

Author: ccordoba12

spyder/config/main.py

@@ -160,7 +160,7 @@
               'show_calltips': True,
               'ask_before_closing': False,
               'show_reset_namespace_warning': True,
-              'buffer_size': 500,
+              'buffer_size': 5000,
               'pylab': True,
               'pylab/autoload': False,
               'pylab/backend': 'inline',
@@ -721,4 +721,4 @@
 #    or if you want to *rename* options, then you need to do a MAJOR update in
 #    version, e.g. from 3.0.0 to 4.0.0
 # 3. You don't need to touch this value if you're just adding a new option
-CONF_VERSION = '87.4.0'
+CONF_VERSION = '87.5.0'

spyder/plugins/ipythonconsole/confpage.py

@@ -11,8 +11,14 @@
 
 # Third party imports
 from qtpy.QtCore import Qt
-from qtpy.QtWidgets import (QGridLayout, QGroupBox, QHBoxLayout, QLabel,
-                            QVBoxLayout)
+from qtpy.QtWidgets import (
+    QGridLayout,
+    QGroupBox,
+    QHBoxLayout,
+    QLabel,
+    QMessageBox,
+    QVBoxLayout,
+)
 
 # Local imports
 from spyder.api.translations import _
@@ -21,6 +27,12 @@
 
 class IPythonConsoleConfigPage(PluginConfigPage):
 
+    def __init__(self, plugin, parent):
+        super().__init__(plugin, parent)
+
+        self.buffer_spin = None
+        self.apply_callback = self.warn_if_large_buffer
+
     def setup_page(self):
         newcb = self.create_checkbox
 
@@ -42,7 +54,7 @@ def setup_page(self):
             'show_elapsed_time',
             tip=_("Display the time since the current console was started "
                   "in the tab bar"),
-            )
+        )
 
         display_layout = QVBoxLayout()
         display_layout.addWidget(banner_box)
@@ -118,21 +130,19 @@ def setup_page(self):
 
         # Output group
         output_group = QGroupBox(_("Output"))
-
-        # Note: The maximum here is set to a relatively small value because
-        # larger ones make Spyder sluggish.
-        # Fixes spyder-ide/spyder#19091
-        buffer_spin = self.create_spinbox(
+        self.buffer_spin = self.create_spinbox(
             _("Buffer:"),
             _(" lines"),
             'buffer_size',
-            min_=-1,
-            max_=5000,
+            min_=100,
+            # >10k can make Spyder slow, see spyder-ide/spyder#19091
+            max_=50_000,
             step=100,
             tip=_(
                 "The maximum number of output lines "
-                "retained in each console at a time."
-                "\nSpecifying -1 means no limit (not recommended)."
+                "retained in each console at a time.\n"
+                "Warning; Buffer sizes greater than 10000 lines can slow "
+                "down Spyder."
             ),
         )
         sympy_box = newcb(
@@ -146,7 +156,7 @@ def setup_page(self):
         )
 
         output_layout = QVBoxLayout()
-        output_layout.addWidget(buffer_spin)
+        output_layout.addWidget(self.buffer_spin)
         output_layout.addWidget(sympy_box)
         output_group.setLayout(output_layout)
 
@@ -182,7 +192,7 @@ def setup_page(self):
             (inline, 'inline'),
             (automatic, 'auto'),
             ("Qt", 'qt'),
-            ("Tk", 'tk')
+            ("Tk", 'tk'),
         ]
 
         if sys.platform == 'darwin':
@@ -234,21 +244,31 @@ def setup_page(self):
             tip=_("Only used when the format is PNG. Default is 144."),
         )
         width_spin = self.create_spinbox(
-                          _("Width:")+"  ", " "+_("inches"),
-                          'pylab/inline/width', min_=2, max_=20, step=1,
-                          tip=_("Default is 6"))
+            _("Width:") + "  ",
+            " " + _("inches"),
+            'pylab/inline/width',
+            min_=2,
+            max_=20,
+            step=1,
+            tip=_("Default is 6"),
+        )
         height_spin = self.create_spinbox(
-                          _("Height:")+"  ", " "+_("inches"),
-                          'pylab/inline/height', min_=1, max_=20, step=1,
-                          tip=_("Default is 4"))
+            _("Height:") + "  ",
+            " " + _("inches"),
+            'pylab/inline/height',
+            min_=1,
+            max_=20,
+            step=1,
+            tip=_("Default is 4"),
+        )
         fontsize_spin = self.create_spinbox(
             _("Font size:") + "  ",
             " " + _("points"),
             'pylab/inline/fontsize',
             min_=5,
             max_=48,
             step=1.0,
-            tip=_("Default is 10")
+            tip=_("Default is 10"),
         )
         bottom_spin = self.create_spinbox(
             _("Bottom edge:") + "  ",
@@ -452,3 +472,19 @@ def setup_page(self):
             _("Advanced"),
             [autocall_group, autoreload_group, prompts_group, windows_group]
         )
+
+    def warn_if_large_buffer(self):
+        """Warn the user if the Console buffer size is very large."""
+        if "buffer_size" not in self.changed_options:
+            return
+
+        msg = None
+        buffer_size = self.buffer_spin.spinbox.value()
+
+        # >10k line buffers can make Spyder slow, see spyder-ide/spyder#19091
+        if buffer_size > 10_000:
+            msg = _("Buffer sizes over 10000 lines can slow down Spyder")
+        elif buffer_size == -1:
+            msg = _("Unlimited buffer size can slow down Spyder severely")
+        if msg:
+            QMessageBox.warning(self, _("Warning"), msg, QMessageBox.Ok)