Use ruff as linter and code formatter (#502)

Author: tkrabel

.github/workflows/static.yml

@@ -38,14 +38,12 @@ jobs:
       # If we don't install pycodestyle, pylint will throw an unused-argument error in pylsp/plugins/pycodestyle_lint.py:72
       # This error cannot be resolved by adding a pylint: disable=unused-argument comment ...
       - run: |
-          pip install -e .[pylint,pycodestyle,pyflakes]
-          pip install black
-      - name: Pylint checks
-        run: pylint pylsp test
-      - name: Code style checks with black
-        run: black --check pylsp test
-      - name: Pyflakes checks
-        run: pyflakes pylsp test
+          pip install -e .[pylint,pycodestyle]
+          pip install ruff
+      - name: ruff linter and code style checks
+        run: ruff check pylsp test
+      - name: ruff code formatter check
+        run: ruff format --check pylsp test
       - name: Validate JSON schema
         run: echo {} | jsonschema pylsp/config/schema.json
       - name: Ensure JSON schema and Markdown docs are in sync

.pylintrc

@@ -28,4 +28,4 @@ reports = no
 
 generated-members =
     pylsp_*
-    cache_clear
+    cache_clear

MANIFEST.in

@@ -2,5 +2,6 @@ include README.md
 include versioneer.py
 include pylsp/_version.py
 include LICENSE
+include ruff.toml
 include .pylintrc
 recursive-include test *.py

README.md

@@ -185,6 +185,13 @@ To run the test suite:
 pytest
 ```
 
+Running ruff as a linter and code formatter on the repo:
+```sh
+ruff check .  # linter
+ruff check --fix .  # fix all auto-fixable lint issues
+ruff format .  # format the document
+```
+
 After adding configuration options to `schema.json`, refresh the `CONFIGURATION.md` file with
 
 ```

pylsp/__init__.py

@@ -2,7 +2,9 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import os
+
 import pluggy
+
 from . import _version
 from ._version import __version__
 

pylsp/__main__.py

@@ -9,16 +9,16 @@
 
 try:
     import ujson as json
-except Exception:  # pylint: disable=broad-except
+except Exception:
     import json
 
+from ._version import __version__
 from .python_lsp import (
     PythonLSPServer,
     start_io_lang_server,
     start_tcp_lang_server,
     start_ws_lang_server,
 )
-from ._version import __version__
 
 LOG_FORMAT = "%(asctime)s {0} - %(levelname)s - %(name)s - %(message)s".format(
     time.localtime().tm_zone

pylsp/_utils.py

@@ -61,7 +61,7 @@ def throttle(seconds=1):
 
     def decorator(func):
         @functools.wraps(func)
-        def wrapper(*args, **kwargs):  # pylint: disable=inconsistent-return-statements
+        def wrapper(*args, **kwargs):
             if not hasattr(wrapper, "last_call"):
                 wrapper.last_call = 0
             if time.time() - wrapper.last_call >= seconds:

pylsp/config/config.py

@@ -1,6 +1,5 @@
 # Copyright 2017-2020 Palantir Technologies, Inc.
 # Copyright 2021- Python Language Server Contributors.
-# pylint: disable=import-outside-toplevel
 
 import logging
 import sys
@@ -10,7 +9,7 @@
 import pluggy
 from pluggy._hooks import HookImpl
 
-from pylsp import _utils, hookspecs, uris, PYLSP
+from pylsp import PYLSP, _utils, hookspecs, uris
 
 # See compatibility note on `group` keyword:
 #   https://docs.python.org/3/library/importlib.metadata.html#entry-points
@@ -38,7 +37,7 @@ def _hookexec(
         # enable_tracing will set its own wrapping function at self._inner_hookexec
         try:
             return self._inner_hookexec(hook_name, methods, kwargs, firstresult)
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:
             log.warning(f"Failed to load hook {hook_name}: {e}", exc_info=True)
             return []
 
@@ -79,7 +78,7 @@ def __init__(self, root_uri, init_opts, process_id, capabilities):
         for entry_point in entry_points(group=PYLSP):
             try:
                 entry_point.load()
-            except Exception as e:  # pylint: disable=broad-except
+            except Exception as e:
                 log.info(
                     "Failed to load %s entry point '%s': %s", PYLSP, entry_point.name, e
                 )

pylsp/config/flake8_conf.py

@@ -3,7 +3,9 @@
 
 import logging
 import os
+
 from pylsp._utils import find_parents
+
 from .source import ConfigSource
 
 log = logging.getLogger(__name__)

pylsp/config/pycodestyle_conf.py

@@ -2,9 +2,10 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import pycodestyle
+
 from pylsp._utils import find_parents
-from .source import ConfigSource
 
+from .source import ConfigSource
 
 CONFIG_KEY = "pycodestyle"
 USER_CONFIGS = [pycodestyle.USER_CONFIG] if pycodestyle.USER_CONFIG else []