chore: Replace pylint, black and isort with ruff (#323)

Author: luigibertaco

.github/README.md

@@ -103,28 +103,23 @@ The generated HTML will appear in the `docs/_build/html` directory.
 
 Code is formatted, linted and checked using the following tools:
 
-- [Black](https://github.com/psf/black)
-- [Pylint](https://pypi.org/project/pylint/)
-- [isort](https://github.com/timothycrosley/isort)
+- [Ruff](https://github.com/astral-sh/ruff) - A fast Python linter and formatter (replaces Black, isort, and Pylint)
 - [mypy](http://mypy-lang.org/)
 
 These checks are run on all code merged to master, and may also be run locally from the open-controls directory:
 
 ```shell
-pip install black isort mypy pylint
+pip install ruff mypy
 mypy
-isort --check .
-black --check .
-pylint .
+ruff check .
+ruff format --check .
 ```
 
-Note that you can speed up the execution of Pylint by running it in the parallel mode with the `-j` option: `pylint -j 0 .`. See the [official documentation](https://pylint.readthedocs.io/en/latest/user_guide/usage/run.html#parallel-execution) for details.
-
-Black and isort, in addition to checking code, can also automatically apply fixes. To fix all code in the open-controls tree, run:
+Ruff, in addition to checking code, can also automatically apply fixes. To fix all code in the open-controls tree, run:
 
 ```shell
-isort
-black .
+ruff check --fix .
+ruff format .
 ```
 
 You can also run these checks only in the files that you changed by using the `pre-commit` tool. To use it, run:

.pre-commit-config.yaml

@@ -11,34 +11,26 @@ repos:
     -   id: check-toml
 -   repo: local
     hooks:
-      - id: black
-        name: black
-        entry: poetry run black
+      - id: ruff-check
+        name: ruff-check
+        entry: poetry run ruff check
         language: system
         require_serial: true
         types: [python]
-      - id: isort
-        name: isort
-        entry: poetry run isort
-        require_serial: true
+        args: [--fix]
+      - id: ruff-format
+        name: ruff-format
+        entry: poetry run ruff format
         language: system
+        require_serial: true
         types: [python]
-        args: ['--filter-files']
       - id: mypy
         name: mypy
         entry: poetry run mypy
         require_serial: true
         language: system
         types: [python]
         exclude: docs/conf.py
-      - id: pylint
-        entry: poetry run pylint --rcfile=.pylintrc
-        name: pylint
-        language: system
-        types: [file, python]
-        # when passing in a single file as argument the ignore entry in the .pylintrc does
-        # not seem to be considered.
-        exclude: .*(venv|\.conf\.py)
 -   repo: https://github.com/pre-commit/mirrors-prettier
     rev: v3.0.0
     hooks:

.pylintrc

@@ -12,9 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""
-Configuration file for the Sphinx documentation builder.
-"""
+"""Configuration file for the Sphinx documentation builder."""
 
 # This file only contains a selection of the most common options. For a full
 # list see the documentation:
@@ -28,25 +26,24 @@
 
 import datetime
 import inspect
-import os
 import sys
+from pathlib import Path
 from typing import List
 
 import tomli
 
 import qctrlopencontrols
 
-# pylint:disable=invalid-name
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, str(Path("..").resolve()))
 
 # -- Project information -----------------------------------------------------
-with open("../pyproject.toml", "rb") as f:
+with Path("../pyproject.toml").open("rb") as f:
     parsed = tomli.load(f)
 package_info = parsed["tool"]["poetry"]
 project = package_info["description"]
 author = ", ".join(package_info["authors"])
 release = package_info["version"]
-copyright = f"{datetime.datetime.now().year} Q-CTRL. All rights reserved."  # pylint: disable=redefined-builtin
+copyright = f"{datetime.datetime.now().year} Q-CTRL. All rights reserved."  # noqa: A001
 
 # -- General configuration ---------------------------------------------------
 
@@ -111,9 +108,7 @@
             + "."
             + _class.__name__
             + "."
-            + attribute: _class.__name__
-            + "."
-            + attribute
+            + attribute: _class.__name__ + "." + attribute
             for attribute in dir(_class)
             if not attribute.startswith("_")
         }

docs/conf.py

@@ -29,15 +29,15 @@
    "outputs": [],
    "source": [
     "import numpy as np\n",
-    "import matplotlib.pyplot as plt\n",
+    "from qctrlvisualizer import plot_controls\n",
+    "\n",
     "from qctrlopencontrols import (\n",
     "    DrivenControl,\n",
     "    new_bb1_control,\n",
+    "    new_corpse_control,\n",
     "    new_primitive_control,\n",
     "    new_sk1_control,\n",
-    "    new_corpse_control,\n",
-    ")\n",
-    "from qctrlvisualizer import plot_controls"
+    ")"
    ]
   },
   {
@@ -290,7 +290,7 @@
    ],
    "source": [
     "## Reload the file and check its content to better understand the format\n",
-    "with open(filename, \"rt\") as handle:\n",
+    "with open(filename) as handle:\n",
     "    file_content = handle.read()\n",
     "print(file_content)"
    ]

examples/creating-a-driven-control.ipynb

@@ -29,17 +29,17 @@
    "outputs": [],
    "source": [
     "import numpy as np\n",
-    "import matplotlib.pyplot as plt\n",
+    "from qctrlvisualizer import plot_sequences\n",
+    "\n",
     "from qctrlopencontrols import (\n",
-    "    new_spin_echo_sequence,\n",
+    "    DynamicDecouplingSequence,\n",
     "    new_carr_purcell_sequence,\n",
-    "    new_walsh_sequence,\n",
+    "    new_quadratic_sequence,\n",
     "    new_ramsey_sequence,\n",
+    "    new_spin_echo_sequence,\n",
+    "    new_walsh_sequence,\n",
     "    new_x_concatenated_sequence,\n",
-    "    new_quadratic_sequence,\n",
-    "    DynamicDecouplingSequence,\n",
-    ")\n",
-    "from qctrlvisualizer import plot_sequences"
+    ")"
    ]
   },
   {
@@ -320,7 +320,7 @@
    ],
    "source": [
     "## Reload the file and check its content to better understand the format\n",
-    "with open(filename, \"rt\") as handle:\n",
+    "with open(filename) as handle:\n",
     "    file_content = handle.read()\n",
     "print(file_content)"
    ]