Merge pull request #314 from PowerGridModel/feature/add-ruff

Linting and Formatting: replacing current linters and formatters with Ruff, fixing issues caught by Ruff

Author: mgovers

.github/workflows/check-code-quality.yml

@@ -29,25 +29,16 @@ jobs:
       - name: Upgrade pip
         run: pip install --upgrade pip
 
-      - name: Install and run isort
-        run: |
-          pip install isort
-          isort .
-
-      - name: Install and run black
-        run: |
-          pip install black[jupyter]
-          black .
-
       - name: Install and run mypy
         run: |
           pip install mypy
           mypy src
 
-      - name: Install and run pylint
+      - name: Install and run ruff
         run: |
-          pip install pylint .
-          pylint power_grid_model_io
+          pip install ruff .
+          ruff check .
+          ruff format .
 
       - name: If needed raise error
         run: |

.pre-commit-config.yaml

@@ -7,29 +7,22 @@ repos:
     rev: v5.0.2
     hooks:
       - id: reuse
-  - repo: https://github.com/pycqa/isort
-    rev: 6.0.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.11.12
     hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-      - id: black-jupyter
+      # Run the linter.
+      - id: ruff-check
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.16.0
     hooks:
       - id: mypy
         additional_dependencies: [numpy, pandas]
   - repo: local
     hooks:
-      - id: pylint
-        name: pylint
-        entry: pylint
-        files: ^src/.+\.py$
-        language: system
-        types: [ python ]
-        args: [ "--rcfile=pyproject.toml" ]
-        require_serial: true
       - id: pytest
         name: pytest
         entry: pytest

docs/examples/arrow_example.ipynb

@@ -26,22 +26,20 @@
    "outputs": [],
    "source": [
     "%%capture cap --no-stderr\n",
-    "from IPython.display import display\n",
     "from typing import Iterable\n",
     "\n",
+    "import numpy as np\n",
+    "import pandas as pd\n",
+    "import pyarrow as pa\n",
+    "from IPython.display import display\n",
     "from power_grid_model import (\n",
-    "    PowerGridModel,\n",
-    "    initialize_array,\n",
-    "    CalculationMethod,\n",
-    "    power_grid_meta_data,\n",
+    "    ComponentAttributeFilterOptions,\n",
     "    ComponentType,\n",
     "    DatasetType,\n",
-    "    ComponentAttributeFilterOptions,\n",
+    "    PowerGridModel,\n",
+    "    power_grid_meta_data,\n",
     ")\n",
-    "from power_grid_model.data_types import SingleColumnarData\n",
-    "import pyarrow as pa\n",
-    "import pandas as pd\n",
-    "import numpy as np"
+    "from power_grid_model.data_types import SingleColumnarData"
    ]
   },
   {

docs/examples/pandapower_example.ipynb

@@ -42,6 +42,7 @@
    "outputs": [],
    "source": [
     "import warnings\n",
+    "\n",
     "import pandapower as pp\n",
     "\n",
     "warnings.filterwarnings(\"ignore\", module=\"pandapower\", category=FutureWarning)  # Hide warnings related to pandas\n",
@@ -1046,8 +1047,9 @@
    "source": [
     "%%capture cap --no-stderr\n",
     "\n",
-    "from power_grid_model import PowerGridModel, CalculationType\n",
+    "from power_grid_model import CalculationType, PowerGridModel\n",
     "from power_grid_model.validation import assert_valid_input_data\n",
+    "\n",
     "from power_grid_model_io.converters import PandaPowerConverter\n",
     "\n",
     "output_file = \"data/pandapower/example_simple_output.json\"\n",

docs/examples/pgm_json_example.ipynb

@@ -105,7 +105,8 @@
    ],
    "source": [
     "from pathlib import Path\n",
-    "from IPython.display import display, Markdown\n",
+    "\n",
+    "from IPython.display import Markdown, display\n",
     "\n",
     "with Path(source_file).open() as json_file:\n",
     "    display(Markdown(f\"<pre style='max-height: 160px; overflow: scroll; white-space: pre'>{json_file.read()}</pre>\"))"
@@ -578,7 +579,8 @@
    ],
    "source": [
     "from pathlib import Path\n",
-    "from IPython.display import display, Markdown\n",
+    "\n",
+    "from IPython.display import Markdown, display\n",
     "\n",
     "with Path(destination_file).open() as json_file:\n",
     "    display(Markdown(f\"<pre style='max-height: 160px; overflow: scroll; white-space: pre'>{json_file.read()}</pre>\"))"
@@ -599,6 +601,7 @@
    "source": [
     "%%capture cap --no-stderr\n",
     "from power_grid_model import PowerGridModel\n",
+    "\n",
     "from power_grid_model_io.converters import PgmJsonConverter\n",
     "\n",
     "source_file = \"data/tiny-net/input.json\"\n",

docs/examples/vision_example.ipynb

@@ -552,7 +552,8 @@
    ],
    "source": [
     "from pathlib import Path\n",
-    "from IPython.display import display, Markdown\n",
+    "\n",
+    "from IPython.display import Markdown, display\n",
     "\n",
     "with Path(destination_file).open() as json_file:\n",
     "    display(Markdown(f\"<pre style='max-height: 160px; overflow: scroll; white-space: pre'>{json_file.read()}</pre>\"))"
@@ -651,9 +652,10 @@
    "source": [
     "%%capture cap --no-stderr\n",
     "\n",
-    "from power_grid_model import PowerGridModel, CalculationType\n",
+    "from power_grid_model import CalculationType, PowerGridModel\n",
     "from power_grid_model.validation import assert_valid_input_data\n",
-    "from power_grid_model_io.converters import VisionExcelConverter, PgmJsonConverter\n",
+    "\n",
+    "from power_grid_model_io.converters import PgmJsonConverter, VisionExcelConverter\n",
     "\n",
     "source_file = \"data/vision/example.xlsx\"\n",
     "destination_file = \"data/vision/sym_output.json\"\n",

pyproject.toml

@@ -44,6 +44,7 @@ dev = [
     "pylint",
     "pytest",
     "pytest-cov",
+    "ruff",
     "pydantic>2", # Used in unit tests
     "pandapower>2.11.1",
 ]
@@ -89,33 +90,43 @@ addopts = [
 ]
 xfail_strict = true
 
-[tool.black]
+[tool.ruff]
+# Same as Black.
 line-length = 120
-target-version = ["py311", "py312", "py313"]
+indent-width = 4
+show-fixes = true
 
-[tool.isort]
-profile = "black"
-line_length = 120
+# Assume Python 3.11
+target-version = "py311"
 
-[tool.pylint]
-max-line-length = 120
-ignore-paths = [
-    "docs/",
-    "examples/",
-    "tests/",
-    "setup.py",
-]
-disable = [
-    "fixme", # allow todos
-]
-good-names=[
-    "ex",   # exception
-    "i",    # iterator or current
-    "p",    # active power
-    "q",    # reactive power
-    "s",    # power (p + q)
-    "v",    # voltage
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # isort
+    "I",
+    "SIM",
+    "YTT",
+    "BLE",
+    "PERF",
+    "Q",
+    "ICN",
+    "ISC",
+    "G",
+    "LOG",
+    "EXE",
+    "FA",
+    "FURB",
+    "FLY",
+    "SLOT",
 ]
+ignore = ["SIM108", "SIM118", "SIM110", "SIM211"]
+
+[tool.ruff.lint.isort]
+# Imports that are imported using keyword "as" and are from the same source - are combined.
+combine-as-imports = true
 
 [tool.mypy]
 follow_imports = "silent"

set_pypi_version.py

@@ -8,7 +8,6 @@
 
 import os
 from pathlib import Path
-from typing import cast
 
 import requests
 
@@ -26,7 +25,7 @@ def set_version(pkg_dir: Path):
         ref = os.environ["GITHUB_REF"]
         build_number = os.environ["GITHUB_RUN_NUMBER"]
         # short hash number in numeric
-        short_hash = f'{int(f"0x{sha[0:6]}", base=16):08}'
+        short_hash = f"{int(f'0x{sha[0:6]}', base=16):08}"
 
         if "main" in ref:
             # main branch

src/power_grid_model_io/converters/__init__.py

@@ -8,3 +8,5 @@
 from power_grid_model_io.converters.pandapower_converter import PandaPowerConverter
 from power_grid_model_io.converters.pgm_json_converter import PgmJsonConverter
 from power_grid_model_io.converters.vision_excel_converter import VisionExcelConverter
+
+__all__ = ["PandaPowerConverter", "PgmJsonConverter", "VisionExcelConverter"]

src/power_grid_model_io/converters/base_converter.py

@@ -4,6 +4,7 @@
 """
 Abstract converter class
 """
+
 import logging
 from abc import ABC, abstractmethod
 from typing import Generic, Optional, Tuple, TypeVar