style: migrate to ruff

Author: SauravMaheshkar

.devcontainer/Containerfile

@@ -24,7 +24,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
 COPY .devcontainer/requirements.txt .
 RUN python3 -m venv /opt/venv
 ENV PATH="/opt/venv/bin:$PATH"
-RUN pip3 install --no-cache-dir --upgrade pip setuptools wheel isort
+RUN pip3 install --no-cache-dir --upgrade pip setuptools wheel
 RUN pip3 install --no-cache-dir -r requirements.txt
 
 RUN find /opt/venv/lib/ -follow -type f -name '*.a' -delete \

.devcontainer/devcontainer.json

@@ -26,6 +26,7 @@
                 "bungcip.better-toml",
                 "github.copilot",
                 "ms-azuretools.vscode-docker",
+                "charliermarsh.ruff",
                 "ms-python.python",
                 "ms-python.vscode-pylance",
                 "ms-vscode-remote.remote-containers",
@@ -37,10 +38,7 @@
             ],
             "settings": {
                 "python.analysis.typeCheckingMode": "basic",
-                "python.languageServer": "Jedi",
                 "python.linting.enabled": true,
-                "python.linting.pylintEnabled": true,
-                "python.formatting.provider": "black",
                 "python.testing.pytestArgs": [
                     "tests"
                 ],
@@ -52,7 +50,8 @@
                 "editor.formatOnSave": true,
                 "editor.inlineSuggest.enabled": true,
                 "editor.codeActionsOnSave": {
-                    "source.organizeImports": true
+                    "source.organizeImports": true,
+                    "source.fixAll": true
                 },
                 "workbench.editorAssociations": {
                     "*.ipynb": "jupyter-notebook"

.devcontainer/requirements.txt

@@ -2,6 +2,6 @@ black
 mypy>=0.900
 numpy>=1.22.0
 pre-commit>=2.18.0
-pylint>=2.5.0
 pytest>=6.0.0
+ruff
 scipy>=1.10.0

.dockerignore

@@ -6,6 +6,7 @@
 *.pyc
 .pytest_cache/
 .mypy_cache/
+.ruff_cache/
 
 data/
 models/

.github/workflows/python.yml

@@ -40,9 +40,9 @@ jobs:
         run: |
           python -m pip install --upgrade pip wheel setuptools
           python -m pip install -r .devcontainer/requirements.txt
-      - name: Lint with pylint
+      - name: Ruff
         run: |
-          pylint src
+          ruff check src
       - name: Test with PyTest
         run: |
           pytest -v .

.gitignore

@@ -4,6 +4,7 @@
 *.pyc
 .pytest_cache/
 .mypy_cache/
+.ruff_cache/
 
 venv/
 data/

.pre-commit-config.yaml

@@ -18,8 +18,7 @@ repos:
     rev: v1.3.0
     hooks:
       - id: mypy
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.269
     hooks:
-      - id: isort
-        args: ["--profile", "black"]
+      - id: ruff

Makefile

@@ -10,6 +10,7 @@ clean:
 	find . -type f -name "__pycache__" -delete
 	rm -rf .mypy_cache/
 	rm -rf .pytest_cache/
+	rm -rf .ruff_cache/
 
 ## Testing
 test:
@@ -18,6 +19,5 @@ test:
 ## Basic linting
 lint:
 	black src
-	isort src --profile=black
+	ruff check src
 	mypy src
-	pylint src

pyproject.toml

@@ -1,23 +1,12 @@
-[tool.isort]
-profile = "black"
-
-[tool.black]
+[tool.ruff]
+select = ["E", "F"]
 line-length = 88
 
-[tool.pylint.messages_control]
-disable = [
-    "no-member",
-    "too-many-arguments",
-    "too-few-public-methods",
-    "no-else-return",
-    "duplicate-code",
-    "too-many-branches",
-    "redefined-builtin",
-    "dangerous-default-value",
-]
+[tool.ruff.isort]
+lines-after-imports = 2
 
-[tool.pylint.format]
-max-line-length = 88
+[tool.black]
+line-length = 88
 
 [[tool.mypy.overrides]]
 ignore_missing_imports = true