PR: Add Ruff support for linting (Completions/Linting) (#24908)

Author: dalthviz

binder/environment.yml

@@ -42,6 +42,7 @@ dependencies:
 - pyqt >=5.15,<5.16
 - pyqtwebengine >=5.15,<5.16
 - python-lsp-black >=2.0.0,<3.0.0
+- python-lsp-ruff >=2.2.2,<3.0.0
 - python-lsp-server >=1.13.0,<1.14.0
 - pyuca >=1.2
 - pyxdg >=0.26

requirements/main.yml

@@ -40,6 +40,7 @@ dependencies:
   - pyqt >=5.15,<5.16
   - pyqtwebengine >=5.15,<5.16
   - python-lsp-black >=2.0.0,<3.0.0
+  - python-lsp-ruff >=2.2.2,<3.0.0
   - python-lsp-server >=1.13.0,<1.14.0
   - pyuca >=1.2
   - pyzmq >=24.0.0

setup.py

@@ -300,6 +300,7 @@ def run(self):
     'pylint-venv>=3.0.2',
     'pyls-spyder>=0.4.0',
     'python-lsp-black>=2.0.0,<3.0.0',
+    'python-lsp-ruff>=2.2.2,<3.0.0',
     'python-lsp-server[all]>=1.13.0,<1.14.0',
     'pyuca>=1.2',
     'pyxdg>=0.26;platform_system=="Linux"',

spyder/config/lsp.py

@@ -138,9 +138,12 @@
                     'enabled': False,
                 },
                 'ruff': {
-                    # Disable it until we have a graphical option for users to
-                    # enable it.
                     'enabled': False,
+                    'formatedEnabled': False,
+                    'exclude': [],
+                    'extendSelect': [],
+                    'extendIgnore': [],
+                    'lineLength': 79,
                 },
                 'no_linting': {
                     'enabled' : False

spyder/dependencies.py

@@ -60,6 +60,7 @@
 PYLINT_VENV_REQVER = '>=3.0.2'
 PYLSP_REQVER = '>=1.13.0,<1.14.0'
 PYLSP_BLACK_REQVER = '>=2.0.0,<3.0.0'
+PYLSP_RUFF_REQVER = '>=2.2.2,<3.0.0'
 PYLS_SPYDER_REQVER = '>=0.4.0'
 PYUCA_REQVER = '>=1.2'
 PYXDG_REQVER = '>=0.26'
@@ -220,6 +221,10 @@
      'features': _("Autoformat Python files in the Editor with the Black "
                    "package"),
      'required_version': PYLSP_BLACK_REQVER},
+    {'modname': 'pylsp_ruff',
+     'package_name': 'python-lsp-ruff',
+     'features': _("Provide linting with the Ruff package"),
+     'required_version': PYLSP_RUFF_REQVER},
     {'modname': 'pyls_spyder',
      'package_name': 'pyls-spyder',
      'features': _('Spyder plugin for the Python LSP Server'),

spyder/plugins/completion/providers/languageserver/conftabs/linting.py

@@ -61,17 +61,22 @@ def __init__(self, parent):
             'flake8',
             button_group=linting_bg
         )
-        
+        ruff_linting_radio = self.create_radiobutton(
+            _("Ruff (Advanced)"),
+            'ruff',
+            button_group=linting_bg
+        )
         disable_linting_radio = self.create_radiobutton(
             _("Disable linting"),
             'no_linting',
             button_group=linting_bg
         )
-        
+
         linting_select_layout = QVBoxLayout()
         linting_select_layout.addSpacing(3 * AppStyle.MarginSize)
         linting_select_layout.addWidget(basic_linting_radio)
         linting_select_layout.addWidget(flake_linting_radio)
+        linting_select_layout.addWidget(ruff_linting_radio)
         linting_select_layout.addWidget(disable_linting_radio)
         linting_select_group.setLayout(linting_select_layout)
 
@@ -89,6 +94,43 @@ def __init__(self, parent):
         configuration_options_group = QGroupBox(_("Provider options"))
         configuration_options_layout = QVBoxLayout()
 
+        # ruff options
+        self.ruff_exclude = self.create_lineedit(
+            _("Exclude these files or directories:"),
+            'ruff/exclude',
+            alignment=Qt.Horizontal,
+            word_wrap=False,
+            placeholder=_("Exclude test files: (?!test_).*\\.py"),
+        )
+
+        ruff_select = self.create_lineedit(
+            _("Show these errors or warnings:"),
+            'ruff/extendSelect',
+            alignment=Qt.Horizontal,
+            word_wrap=False,
+            placeholder=_("Example codes: E113, W391"),
+        )
+
+        ruff_ignore = self.create_lineedit(
+            _("Ignore these errors or warnings:"),
+            'ruff/extendIgnore',
+            alignment=Qt.Horizontal,
+            word_wrap=False,
+            placeholder=_("Default is: E"),
+        )
+
+        ruff_layout = QGridLayout()
+        ruff_layout.addWidget(self.ruff_exclude.label, 1, 0)
+        ruff_layout.addWidget(self.ruff_exclude.textbox, 1, 1)
+        ruff_layout.addWidget(ruff_select.label, 2, 0)
+        ruff_layout.addWidget(ruff_select.textbox, 2, 1)
+        ruff_layout.addWidget(ruff_ignore.label, 3, 0)
+        ruff_layout.addWidget(ruff_ignore.textbox, 3, 1)
+
+        ruff_grid_widget = QWidget()
+        ruff_grid_widget.setLayout(ruff_layout)
+
+        # Flake8 options
         self.flake8_filenames_match = self.create_lineedit(
             _("Only check these filenames:"),
             'flake8/filename',
@@ -130,38 +172,53 @@ def __init__(self, parent):
         flake8_layout.addWidget(flake8_select.textbox, 3, 1)
         flake8_layout.addWidget(flake8_ignore.label, 4, 0)
         flake8_layout.addWidget(flake8_ignore.textbox, 4, 1)
+        flake8_grid_widget = QWidget()
+        flake8_grid_widget.setLayout(flake8_layout)
 
+        # pyflakes options
         pyflakes_conf_options = QLabel(
             _("There are no configuration options for Pyflakes")
         )
-        not_select_conf_options = QLabel(_("Linting is disabled"))
 
-        grid_widget = QWidget()
-        grid_widget.setLayout(flake8_layout)
+        # Disabled linting options
+        not_select_conf_options = QLabel(_("Linting is disabled"))
 
-        configuration_options_layout.addWidget(grid_widget)
+        configuration_options_layout.addWidget(ruff_grid_widget)
+        configuration_options_layout.addWidget(flake8_grid_widget)
         configuration_options_layout.addWidget(pyflakes_conf_options)
         configuration_options_layout.addWidget(not_select_conf_options)
 
+        ruff_linting_radio.radiobutton.toggled.connect(
+            lambda checked: (
+                ruff_grid_widget.setVisible(checked),
+                flake8_grid_widget.setVisible(False),
+                pyflakes_conf_options.setVisible(False),
+                not_select_conf_options.setVisible(False)
+            ) if checked else None
+        )
+
         flake_linting_radio.radiobutton.toggled.connect(
             lambda checked: (
-                grid_widget.setVisible(checked),
-                pyflakes_conf_options.setVisible(not checked),
+                ruff_grid_widget.setVisible(False),
+                flake8_grid_widget.setVisible(checked),
+                pyflakes_conf_options.setVisible(False),
                 not_select_conf_options.setVisible(False)
             ) if checked else None
         )
 
         basic_linting_radio.radiobutton.toggled.connect(
             lambda checked: (
-                grid_widget.setVisible(False),
+                ruff_grid_widget.setVisible(False),
+                flake8_grid_widget.setVisible(False),
                 pyflakes_conf_options.setVisible(checked),
                 not_select_conf_options.setVisible(False)
             ) if checked else None
         )
 
         disable_linting_radio.radiobutton.toggled.connect(
             lambda checked: (
-                grid_widget.setVisible(False),
+                ruff_grid_widget.setVisible(False),
+                flake8_grid_widget.setVisible(False),
                 pyflakes_conf_options.setVisible(False),
                 not_select_conf_options.setVisible(checked)
             ) if checked else None
@@ -207,9 +264,16 @@ def is_valid(self):
             return False
 
         try:
+            # flake8 check
             flake8_excludes = self.flake8_exclude.textbox.text().split(",")
             for match in flake8_excludes:
                 re.compile(match.strip())
+
+            # ruff check
+            ruff_excludes = self.ruff_exclude.textbox.text().split(",")
+            for match in ruff_excludes:
+                re.compile(match.strip())
+
         except re.error:
             self.report_invalid_regex(files=False)
             return False

spyder/plugins/completion/providers/languageserver/provider.py

@@ -61,6 +61,7 @@ class LanguageServerProvider(SpyderCompletionProvider):
         ('pyflakes', True),
         ('mccabe', False),
         ('flake8', False),
+        ('ruff', False),
         ('no_linting', False),
         ('formatting', 'autopep8'),
         ('format_on_save', False),
@@ -69,6 +70,9 @@ class LanguageServerProvider(SpyderCompletionProvider):
         ('flake8/extendSelect', ''),
         ('flake8/extendIgnore', 'E,W,C90'),
         ('flake8/max_line_length', 79),
+        ('ruff/exclude', ''),
+        ('ruff/extendSelect', ''),
+        ('ruff/extendIgnore', 'E'),
         ('pydocstyle', False),
         ('pydocstyle/convention', 'numpy'),
         ('pydocstyle/select', ''),
@@ -723,8 +727,6 @@ def generate_python_config(self):
         host = self.get_conf('advanced/host', '127.0.0.1')
         port = self.get_conf('advanced/port', 2087)
 
-        
-
         # Flake8
         cs_max_line_length = self.get_conf('flake8/max_line_length', 79)
         f8_exclude = self.get_conf('flake8/exclude', '').split(',')
@@ -745,15 +747,6 @@ def generate_python_config(self):
             f8_indent.count(" ") + f8_indent.count("\t") * f8_tab_size
         )
 
-        pycodestyle = {
-            'maxLineLength': cs_max_line_length
-        }
-
-        # Linting - Pyflakes
-        pyflakes = {
-            'enabled': self.get_conf('pyflakes')
-        }
-
         flake8 = {
             "enabled": self.get_conf("flake8"),
             "filename": [
@@ -766,6 +759,36 @@ def generate_python_config(self):
             "maxLineLength": cs_max_line_length,
         }
 
+        # pycodestyle
+        pycodestyle = {
+            'maxLineLength': cs_max_line_length
+        }
+
+        # Linting - Pyflakes
+        pyflakes = {
+            'enabled': self.get_conf('pyflakes')
+        }
+
+        # Linting - ruff
+        ruff_exclude = self.get_conf('ruff/exclude', '').split(',')
+        ruff_select = self.get_conf('ruff/extendSelect', '').split(',')
+        ruff_ignore = self.get_conf('ruff/extendIgnore', '').split(',')
+
+        ruff = {
+            "enabled": self.get_conf("ruff"),
+            "exclude": [
+                exclude.strip() for exclude in ruff_exclude if exclude
+            ],
+            "extendSelect": [
+                select.strip() for select in ruff_select if select
+            ],
+            "extendIgnore": [
+                ignore.strip() for ignore in ruff_ignore if ignore
+            ],
+            "lineLength": cs_max_line_length,
+        }
+
+        # Linting disabled
         no_linting = {"enabled": self.get_conf("no_linting")}
 
         # Pydocstyle
@@ -875,6 +898,7 @@ def generate_python_config(self):
         plugins['pyflakes'].update(pyflakes)
         plugins['pycodestyle'].update(pycodestyle)
         plugins['flake8'].update(flake8)
+        plugins['ruff'].update(ruff)
         plugins['no_linting'].update(no_linting)
         plugins['pydocstyle'].update(pydocstyle)
         plugins['pyls_spyder'].update(pyls_spyder_options)