Add Ruff linting (#1795)

Author: mkrnr

.github/workflows/ci.yml

@@ -808,8 +808,11 @@ jobs:
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt -r reqs/code_quality.txt        
 
-      - name: Run Ruff (format check)
-        run: ruff format --check .
+      - name: Run linting check (Ruff)
+        run: ruff check
+
+      - name: Run format check (Ruff)
+        run: ruff format --check
 
       - name: Update skip cache 1
         uses: actions/cache@v4

.github/workflows/ci/workflow_template.yml

@@ -156,8 +156,11 @@ jobs:
 
       <% endif %>
       <% if j.type == 'test_code_quality' %>
-      - name: Run Ruff (format check)
-        run: ruff format --check .
+      - name: Run linting check (Ruff)
+        run: ruff check
+
+      - name: Run format check (Ruff)
+        run: ruff format --check
 
       <% endif %>
       <% if j.type in ['build', 'test_packaging'] %>

.pre-commit-config.yaml

@@ -1,7 +1,10 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.12.1 # also update constraints.txt
+  rev: v0.14.8 # also update constraints.txt
   hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
     # Run the formatter.
     - id: ruff-format

doc/conf.py

@@ -1,4 +1,7 @@
 # Configuration file for the Sphinx documentation builder.
+from pygments.lexer import RegexLexer, bygroups
+from pygments import token as t
+from sphinx.highlighting import lexers
 
 # -- Project information -----------------------------------------------------
 
@@ -69,10 +72,6 @@
     "dark_logo": "dolores.svg",
 }
 
-from pygments.lexer import RegexLexer, bygroups
-from pygments import token as t
-from sphinx.highlighting import lexers
-
 
 class RTFLexer(RegexLexer):
     name = "rtf"

doc/developer_guide.md

@@ -84,7 +84,7 @@ any other virtual environment](https://virtualenv.pypa.io/en/latest/user_guide.h
 
 The configuration also provides support for lightweight tests only environment:
 `pyX`, where `X` is the version of the Python interpreter to use. E.g. running
-`tox -e 'py3,py36,py37,py38,py39` will execute the testsuite for each version
+`tox -e 'py3,py310,py311,py312` will execute the testsuite for each version
 of Python we support.
 
 # Creating a binary distribution

osx/dmg_resources/settings.py

@@ -3,6 +3,9 @@
 import plistlib
 import os.path
 
+# `defines` is injected by dmgbuild; default to empty for linters.
+defines = globals().get("defines", {})
+
 application = defines.get("app", "./dist/Plover.app")
 appname = os.path.basename(application)
 

plover/__init__.py

@@ -11,7 +11,9 @@
     # exec from `setup.py`, package data
     # may not be available, and we don't
     # want to translate anyway.
-    _ = lambda s: s
+    def _(s):
+        return s
+
 
 __version__ = "5.1.0"
 __copyright__ = "(C) Open Steno Project"

plover/dictionary/loading_manager.py

@@ -75,7 +75,7 @@ def __init__(self, filename, state_change_callback):
     def needs_reloading(self):
         try:
             new_timestamp = resource_timestamp(self.filename)
-        except:
+        except Exception:
             # Bad resource name, permission denied, path
             # does not exist, ...
             new_timestamp = None

plover/formatting.py

@@ -370,7 +370,10 @@ def remove_listener(self, callback):
 
     def set_output(self, output):
         """Set the output class."""
-        noop = lambda x: None
+
+        def noop(x):
+            return None
+
         output_type = self.output_type
         fields = output_type._fields
         self._output = output_type(*[getattr(output, f, noop) for f in fields])
@@ -921,7 +924,7 @@ def apply_case(text, case):
 
 def apply_mode(text, case, space_char, begin, last_action):
     # Should title case be applied to the beginning of the next string?
-    lower_title_case = begin and not last_action.case in (
+    lower_title_case = begin and last_action.case not in (
         Case.CAP_FIRST_WORD,
         Case.UPPER_FIRST_WORD,
     )

plover/gui_qt/console_widget.py

@@ -62,7 +62,7 @@ def _subprocess(self):
         while True:
             try:
                 line = self._proc.stdout.readline()
-            except:
+            except Exception:
                 break
             if not line:
                 break