Merge pull request #247 from DuguidLab/celefthe/issue246

Migrate linting & formatting to ruff

Author: celefthe

.coveragerc

@@ -8,11 +8,12 @@ on:
 
 jobs:
   lint:
-    name: "lint"
+    name: "ruff"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: psf/black@stable
+      - uses: astral-sh/ruff-action@v3
         with:
           src: "./src"
-          # use_pyproject: true
+      # - run: ruff check
+      # - run: ruff format

.github/workflows/black.yml .github/workflows/format.yml.github/workflows/black.yml renamed to .github/workflows/format.yml

@@ -7,7 +7,16 @@ repos:
     -   id: check-merge-conflict
     -   id: debug-statements
     -   id: no-commit-to-branch
--   repo: https://github.com/psf/black
-    rev: 23.10.1
-    hooks:
-    -   id: black
+# -   repo: https://github.com/psf/black
+#     rev: 23.10.1
+#     hooks:
+#     -   id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.8.6
+  hooks:
+    # Run the linter.
+    # - id: ruff
+    #   args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

.pre-commit-config.yaml

@@ -12,6 +12,7 @@ Versions follow [Semantic Versioning](https://semver.org) (`<major>.<minor>.<pat
 - Update Flask and Werkzeug to >v3.0 ([#227](https://github.com/DuguidLab/visiomode/issues/227)).
 - Changed testing framework to pytest ([[#239](https://github.com/DuguidLab/visiomode/issues/239)], [[#242](https://github.com/DuguidLab/visiomode/issues/242)]).
 - Enhanced test coverage ([[#240](https://github.com/DuguidLab/visiomode/issues/240)], [[#211](https://github.com/DuguidLab/visiomode/issues/211)], [[#71](https://github.com/DuguidLab/visiomode/issues/71)], [[#72](https://github.com/DuguidLab/visiomode/issues/72)]).
+- Switch to `ruff` for linting and formatting ([[[#246](https://github.com/DuguidLab/visiomode/issues/246)]]).
 
 ## [0.6.0] - 2024-08-29
 

CHANGELOG.md

@@ -60,10 +60,6 @@ path = "src/visiomode/__about__.py"
 [tool.hatch.envs.default]
 python = "3.9"
 
-[tool.hatch.envs.develop]
-python = "3.9"
-dependencies = ["black", "pylint", "pre-commit"]
-
 [tool.hatch.envs.docs]
 dependencies = [
   "mkdocs",
@@ -92,25 +88,23 @@ python = ["3.9", "3.10", "3.11", "3.12"]
 
 [tool.hatch.envs.test.scripts]
 run-coverage = "pytest --cov-config=pyproject.toml --cov=visiomode --cov=tests --cov-report term --cov-report xml:coverage.xml"
-run-coverage-ci = "run-coverage --cov-report=xml"
+run-coverage-ci = "run-coverage --cov-report=xml:coverage.xml"
 run = "run-coverage --no-cov"
 
 [tool.hatch.envs.lint]
 detached = true
 dependencies = [
-  "black>=23.1.0",
   "mypy>=1.0.0",
   "ruff>=0.0.243",
 ]
 [tool.hatch.envs.lint.scripts]
 typing = "mypy --install-types --non-interactive {args:src/visiomode tests}"
 style = [
-  "ruff {args:.}",
-  "black --check --diff {args:.}",
+  "ruff check {args:src/visiomode tests}",
 ]
 fmt = [
-  "black {args:.}",
-  "ruff --fix {args:.}",
+  "ruff check --fix {args:src/visiomode tests}",
+  "ruff format {args:src/visiomode tests}",
   "style",
 ]
 all = [
@@ -119,9 +113,9 @@ all = [
 ]
 
 [tool.ruff]
-target-version = "py311"
+target-version = "py39"
 line-length = 120
-select = [
+lint.select = [
   "A",
   "ARG",
   "B",
@@ -148,27 +142,34 @@ select = [
   "W",
   "YTT",
 ]
-ignore = [
+lint.ignore = [
   # Allow non-abstract empty methods in abstract base classes
   "B027",
   # Allow boolean positional values in function calls, like `dict.get(... True)`
   "FBT003",
   # Ignore checks for possible passwords
   "S105", "S106", "S107",
   # Ignore complexity
-  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915",
-]
-unfixable = [
-  # Don't touch unused imports
-  "F401",
+  "C901", "PLR0911", "PLR0912", "PLR0913", "PLR0915", "ISC001",
+  # Ignore binding to all interfaces
+  "S104",
+  # Ignore timezone guff
+  "DTZ005"
 ]
+# unfixable = [
+#   # Don't touch unused imports
+#   "F401",
+# ]
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 known-first-party = ["visiomode"]
 
-[tool.ruff.flake8-tidy-imports]
+[tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "all"
 
-[tool.ruff.per-file-ignores]
-# Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+[tool.ruff.lint.flake8-unused-arguments]
+ignore-variadic-names = true
+
+[tool.ruff.lint.per-file-ignores]
+# Tests can use magic values, assertions, relative and unused imports, and unused arguments
+"tests/**/*" = ["PLR2004", "S101", "TID252", "F401", "ARG001"]

MANIFEST.in

@@ -5,9 +5,9 @@
 #  Distributed under the terms of the MIT Licence.
 
 import faulthandler  # report segmentation faults as tracebacks
-import visiomode.core
 
-from visiomode.__about__ import __version__
+import visiomode.core
+from visiomode.__about__ import __version__  # noqa: F401
 
 faulthandler.enable()
 

pylintrc

@@ -27,20 +27,17 @@
     "height": 800,
     "fullscreen": False,
     "devices": "devices",
-    "input_device_address": (
-        ports.comports()[1].device if len(ports.comports()) > 1 else "/dev/ttyS0"
-    ),
-    "reward_device_address": (
-        ports.comports()[0].device if len(ports.comports()) else "/dev/ttyS0"
-    ),
+    "input_device_address": (ports.comports()[1].device if len(ports.comports()) > 1 else "/dev/ttyS0"),
+    "reward_device_address": (ports.comports()[0].device if len(ports.comports()) else "/dev/ttyS0"),
     "config_path": ".visiomode.json",
 }
 
 
 class Config:
     """App configuration class.
 
-    This class loads and saves configuration from a JSON file. If no config file exists, it creates one with default values.
+    This class loads and saves configuration from a JSON file. If no config file exists, it creates one with default
+    values.
 
     Attributes:
         debug: Debug mode flag.
@@ -91,7 +88,7 @@ def __new__(
                                          DEFAULT_CONFIG_PATH. Only used if it exists.
         """
         if cls._instance is None:
-            cls._instance = super(Config, cls).__new__(cls)
+            cls._instance = super().__new__(cls)
 
             if config_path is None:
                 config_path = DEFAULT_CONFIG["config_path"]
@@ -108,9 +105,7 @@ def __new__(
             os.makedirs(cls._instance.cache_dir, exist_ok=True)
             os.makedirs(cls._instance.db_dir, exist_ok=True)
         elif config_path is not None:
-            logging.warning(
-                "Config has already been loaded, ignoring `config_path` passed to constructor."
-            )
+            logging.warning("Config has already been loaded, ignoring `config_path` passed to constructor.")
 
         return cls._instance
 
@@ -132,14 +127,14 @@ def _load_config(self, config_path: str):
         Args:
             config_path: Path to config JSON file.
         """
-        with open(config_path, "r") as f:
+        with open(config_path) as f:
             config = json.load(f)
 
         for key, value in config.items():
             if key in DEFAULT_CONFIG:
                 setattr(self, key, value)
             else:
-                logging.warning("Unknown config key: {}".format(key))
+                logging.warning(f"Unknown config key: {key}")
 
         self._validate()
 
@@ -151,9 +146,7 @@ def _set_defaults(self):
     def _validate(self) -> None:
         for key, value in DEFAULT_CONFIG.items():
             if not hasattr(self, key):
-                logging.warning(
-                    f"Config is malformed, it does not have attribute '{key}'. Using default value."
-                )
+                logging.warning(f"Config is malformed, it does not have attribute '{key}'. Using default value.")
                 setattr(self, key, value)
 
 

pyproject.toml

@@ -5,23 +5,18 @@
 #  Copyright (c) 2024 Olivier Delree <odelree@ed.ac.uk>
 #  Distributed under the terms of the MIT Licence.
 
-import importlib.resources as resources
-import os
-import logging
-import time
 import datetime
-import threading
+import logging
+import os
 import queue
+import threading
+import time
+from importlib import resources
 
 import pygame as pg
 
 import visiomode.config as conf
-import visiomode.devices as devices
-import visiomode.models as models
-import visiomode.plugins as plugins
-import visiomode.stimuli as stimuli
-import visiomode.tasks as tasks
-import visiomode.webpanel as webpanel
+from visiomode import devices, models, plugins, stimuli, tasks, webpanel
 
 # Register mouse events as touch events - useful for debugging.
 os.environ["SDL_MOUSE_TOUCH_EVENTS"] = "1"
@@ -37,9 +32,9 @@ class Visiomode:
 
     def __init__(
         self,
-        run_application_loop: bool = True,
-        run_webpanel: bool = True,
-        load_plugins: bool = True,
+        # run_application_loop: bool = True,
+        # run_webpanel: bool = True,
+        # load_plugins: bool = True,
     ):
         """Initialise application.
 
@@ -90,7 +85,7 @@ def run(self) -> None:
 
         self.run_main()
 
-    def loading_screen(self):
+    def loading_screen(self, max_angle=1080, angle_rotation=5):
         """Rotating logo to entertain user and mouse while the webpanel is loading."""
         # Fill background
         self.background = pg.Surface(self.screen.get_size())
@@ -122,13 +117,13 @@ def loading_screen(self):
         pg.display.flip()
 
         angle = 0
-        while angle != 1080:
+        while angle != max_angle:
             events = pg.event.get()
             for event in events:
                 if event.type == pg.QUIT:
                     return
 
-            angle += 5
+            angle += angle_rotation
 
             image, rect = rotate(loading_img, loading_img_pos, angle)
 
@@ -143,9 +138,7 @@ def loading_screen(self):
 
         textpos = text.get_rect()
         textpos.centerx = self.background.get_rect().centerx
-        textpos.centery = (
-            self.background.get_rect().centery + 60
-        )  # TODO calculate offset at runtime
+        textpos.centery = self.background.get_rect().centery + 60  # TODO calculate offset at runtime
 
         self.background.blit(text, textpos)
         self.screen.blit(self.background, (0, 0))
@@ -167,8 +160,7 @@ def run_main(self):
                 self.session.trials = self.session.task.trials
             if self.session and (
                 not self.session.task.is_running
-                or time.time() - self.session.task.start_time
-                > self.session.duration * 60
+                or time.time() - self.session.task.start_time > self.session.duration * 60
             ):
                 logging.info("Session finished.")
                 self.session.task.stop()
@@ -201,17 +193,15 @@ def request_listener(self):
         while True:
             request = self.action_q.get()
             if "type" not in request.keys():
-                logging.error("Invalid request - {}".format(request))
+                logging.error(f"Invalid request - {request}")
                 continue
             if request["type"] == "start":
                 # Update config
                 conf.Config().input_device_address = (
-                    request["data"].get("response_address")
-                    or conf.Config().input_device_address
+                    request["data"].get("response_address") or conf.Config().input_device_address
                 )
                 conf.Config().reward_device_address = (
-                    request["data"].get("reward_address")
-                    or conf.Config().reward_device_address
+                    request["data"].get("reward_address") or conf.Config().reward_device_address
                 )
                 conf.Config().save()