Ruff configuration and CI (#502)

Author: fsoubelet

.github/workflows/checks.yml

@@ -0,0 +1,21 @@
+name: Ruff linting
+
+defaults:
+  run:
+    shell: bash
+
+# Runs on any push event in a PR
+on: [ pull_request ]
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # This runs ruff check by default
+      - uses: astral-sh/ruff-action@v3
+        with:
+          version: "latest"
+          src: "omc3/"

omc3/harpy/frequency.py

@@ -30,7 +30,7 @@ def _get_resonance_lines(order):
     # Get all the rdts up to a given order
     fterms = get_all_to_order(order)
     # Some rdts can't be seen depending on the plane, filter them
-    for (j,k,l,m) in fterms:
+    for (j,k,l,m) in fterms:  # noqa: E741 (these variable names are ok)
         if j != 0:
             resonances['X'].append((1-j+k, m-l, 0))
         if l != 0:

omc3/model/model_creators/abstract_model_creator.py

@@ -38,7 +38,6 @@
     measurement_madx,
 )
 from omc3.segment_by_segment.propagables import Propagable
-from omc3.segment_by_segment.propagables.coupling import Coupling
 from omc3.segment_by_segment.segments import Segment
 from omc3.utils import iotools, logging_tools
 

omc3/plotting/plot_kmod_results.py

@@ -68,7 +68,7 @@
 from generic_parser import EntryPointParameters, entrypoint
 from generic_parser.entry_datatypes import DictAsString
 
-from omc3.optics_measurements.constants import BEAM, BETASTAR, ERR, MDL, WAIST
+from omc3.optics_measurements.constants import BEAM, BETASTAR, ERR, WAIST
 from omc3.plotting.utils import style as pstyle
 from omc3.utils import logging_tools
 from omc3.utils.iotools import PathOrStr, PathOrStrOrDataFrame, save_config

omc3/scripts/kmod_lumi_imbalance.py

@@ -68,7 +68,6 @@
     EXT,
     IMBALANCE,
     LUMINOSITY,
-    MDL,
     NAME,
 )
 from omc3.utils import logging_tools

omc3/segment_by_segment/propagables/utils.py

@@ -7,9 +7,6 @@
 """
 from __future__ import annotations
 
-from dataclasses import dataclass
-
-import numpy as np
 import pandas as pd
 
 from omc3.optics_measurements.constants import ERR

omc3/utils/logging_tools.py

@@ -15,7 +15,7 @@
 from contextlib import contextmanager
 from io import StringIO
 from logging import (  # make them available directly
-    CRITICAL,
+    CRITICAL,  # noqa: F401
     DEBUG,
     ERROR,
     INFO,

pyproject.toml

@@ -109,3 +109,35 @@ markers = [
 # log_cli = true
 # log_cli_level = "DEBUG"
 # log_format = "%(levelname)7s | %(message)s | %(name)s"
+
+# ----- Dev Tools Configuration ----- #
+
+[tool.ruff]
+exclude = [
+  ".eggs",
+  ".git",
+  ".mypy_cache",
+  ".venv",
+  "_build",
+  "build",
+  "dist",
+]
+
+# Assume Python 3.10+
+target-version = "py310"
+
+line-length = 100
+indent-width = 4
+
+[tool.ruff.lint]
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+ignore = [
+  "FBT001",  # boolean-type-hint-positional-argument
+  "FBT002",  # boolean-default-value-positional-argument
+  "PT019",  # pytest-fixture-param-without-value (but suggested solution fails)
+]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []