Add linting rules in CI using Ruff

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
       - id: ruff
         name: ruff
         description: "Run 'ruff' for extremely fast Python linting"
-        entry: ruff check --force-exclude
+        entry: poetry run ruff check --force-exclude
         language: python
         types_or: [ python, pyi, jupyter ]
         args: [ ]
@@ -26,7 +26,7 @@ repos:
       - id: ruff-format
         name: ruff-format
         description: "Run 'ruff format' for extremely fast Python formatting"
-        entry: ruff format --force-exclude
+        entry: poetry run ruff format --force-exclude
         language: python
         types_or: [ python, pyi, jupyter ]
         args: [ ]

devutils/rename_vars.py

@@ -18,8 +18,8 @@
 
 import fileinput
 import os
-import os.path as pth
 import re
+from pathlib import Path
 
 import numpy as np
 
@@ -33,10 +33,10 @@
 from fastoad.io.xml.variable_io_standard import BasicVarXpathTranslator
 from tests import root_folder_path
 
-SRC_PATH = pth.join(root_folder_path, "src")
-TEST_PATH = pth.join(root_folder_path, "tests")
-NOTEBOOK_PATH = pth.join(root_folder_path, "notebooks")
-VAR_NAME_FILE = pth.join(pth.dirname(__file__), "rename_vars.txt")
+SRC_PATH = Path(root_folder_path) / "src"
+TEST_PATH = Path(root_folder_path) / "tests"
+NOTEBOOK_PATH = Path(root_folder_path) / "notebooks"
+VAR_NAME_FILE = Path(__file__).parent / "rename_vars.txt"
 
 
 def build_translator(var_names_match: np.ndarray) -> VarXpathTranslator:
@@ -64,30 +64,31 @@ def convert_xml(file_path: str, translator: VarXpathTranslator):
     :param translator:
     """
     reader = VariableIO(file_path, formatter=VariableXmlBaseFormatter(translator))
-    vars = reader.read()
-    VariableIO(file_path).write(vars)
+    variables = reader.read()
+    VariableIO(file_path).write(variables)
 
 
 def replace_var_names(file_path, var_names_match):
     """
     Modifies provided text file by modifying old OpenMDAO variable names
     to new ones.
 
-    :param file_path:
-    :param var_names_match:
+    :param file_path: Path to the file to be modified.
+    :param var_names_match: List of (old_name, new_name) tuples.
     """
-    (_, ext) = pth.splitext(file_path)
+    ext = Path(file_path).suffix  # Extract file extension using pathlib
+
     with fileinput.FileInput(file_path, inplace=True) as file:
         for line in file:
             modified_line = line
             for old_name, new_name in var_names_match:
                 if ext == ".py":
                     # Python file: replacement is done only between (double) quotes
-                    regex = r"""(?<=['"])\b%s\b(?=['"])""" % old_name
+                    regex = rf"""(?<=['"])\b{old_name}\b(?=['"])"""
                 else:
                     # other files: just ensuring it is not part of a larger variable name
                     # by avoiding having ':' before or after.
-                    regex = r"(?<!:)\b%s\b(?!:)" % old_name
+                    regex = rf"(?<!:)\b{old_name}\b(?!:)"
                 modified_line = re.sub(regex, new_name, modified_line)
             print(modified_line, end="")
 
@@ -132,24 +133,24 @@ def get_xpath(self, var_name: str) -> str:
         "src/fastoad/notebooks/tutorial/data/CeRAS01_baseline.xml",
     ]
     for xml_file_path in file_list:
-        print("processing %s" % xml_file_path)
-        convert_xml(pth.join(root_folder_path, xml_file_path), old_new_translator)
+        print(f"processing {xml_file_path}")
+        convert_xml(root_folder_path / xml_file_path, old_new_translator)
 
     # replace var names
     for root_path in [SRC_PATH, TEST_PATH, NOTEBOOK_PATH]:
         for dir_path, dir_names, file_names in os.walk(root_path):
             for filename in file_names:
-                _, ext = pth.splitext(filename)
+                ext = Path(filename).suffix
                 if ext not in [
                     ".xml",
                     ".pyc",
                     ".exe",
                     ".png",
                     "",
                 ]:  # avoid processing useless files
-                    file_path = pth.join(dir_path, filename)
-                    print("processing %s" % file_path)
+                    file_path = dir_path / filename
+                    print(f"processing {file_path}")
                     try:
                         replace_var_names(file_path, old_new_names)
                     except UnicodeDecodeError:
-                        print("SKIPPED %s" % file_path)
+                        print(f"SKIPPED {file_path}")

docs/conf.py

@@ -17,9 +17,9 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-import os
 import sys
 from os import environ
+from pathlib import Path
 
 from sphinx.ext import apidoc
 
@@ -29,10 +29,10 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
 # For custom directives
-sys.path.insert(0, os.path.abspath("./directives"))
+sys.path.insert(0, str(Path("./directives").resolve()))
 
 # For autodoc... and custom directives
-sys.path.insert(0, os.path.abspath("../src"))
+sys.path.insert(0, str(Path("../src").resolve()))
 
 # Overload apidoc options, to add "inherited-members" (which was deactivated because of a bug
 # in earlier sphinx releases)
@@ -41,11 +41,12 @@
 
 # -- Run sphinx-apidoc ------------------------------------------------------
 def run_apidoc(_):
-    sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
-    cur_dir = os.path.abspath(os.path.dirname(__file__))
-    output_dir = os.path.join(cur_dir, "api")
-    module = os.path.join(cur_dir, "..", "src", "fastoad")
-    apidoc.main(["-d", "1", "-e", "-o", output_dir, module, "--force"])
+    sys.path.append(str(Path(__file__).parent.parent))  # Append project root
+    cur_dir = Path(__file__).parent.resolve()
+    output_dir = cur_dir / "api"
+    module = cur_dir.parent / "src" / "fastoad"
+
+    apidoc.main(["-d", "1", "-e", "-o", str(output_dir), str(module), "--force"])
 
 
 def setup(app):
@@ -54,7 +55,7 @@ def setup(app):
 
 # -- Project information -----------------------------------------------------
 project = "FAST-OAD"
-copyright = "2025, ONERA & ISAE-SUPAERO"
+copyright = "2025, ONERA & ISAE-SUPAERO"  # noqa: A001 copyright is a keyword for the sphinx setup
 
 # -- General configuration ---------------------------------------------------
 

docs/directives/segment_attributes.py

@@ -17,7 +17,6 @@
 
 from abc import ABC, abstractmethod
 from dataclasses import fields
-from typing import List, Tuple
 
 from docutils import nodes
 from sphinx.util.docutils import SphinxDirective
@@ -39,7 +38,7 @@ class AbstractLinkList(SphinxDirective, ABC):
     header_text = None
 
     @abstractmethod
-    def get_text_and_targets(self) -> List[Tuple[str, str]]:
+    def get_text_and_targets(self) -> list[tuple[str, str]]:
         """
         :return: a list of tuples for future hyperlinks (displayed text, rst target)
         """
@@ -97,7 +96,7 @@ def get_text_and_targets(self):
         attribute_name = self.content[0].strip()
 
         class_dict = RegisterSegment.get_classes()
-        segment_keywords = sorted(list(class_dict))
+        segment_keywords = sorted(class_dict)
 
         valid_keywords = [
             keyword for keyword in segment_keywords if hasattr(class_dict[keyword], attribute_name)
@@ -154,8 +153,9 @@ def check_targets(app, doctree):
             continue
 
         child_nodes = _generate_hyperlink_list(app, doctree, target_list)
-
-        directive_location += child_nodes
+        # Reassigning directive_location by appending children directly to the docutils node.
+        # This is intentional and required to inject generated content into the document tree.
+        directive_location += child_nodes  # noqa: PLW2901
 
 
 def _generate_hyperlink_list(app, doctree, target_list):