Replace flake8, isort, pylint and black by ruff (#2149)

Closes #1670

CONTRIBUTING.md

@@ -311,7 +311,7 @@ make pytest
 make e2e-tests
 ```
 
-#### Linting tests (`isort`, `black`, `pylint`, `flake8` and `mypy`)
+#### Linting tests (`ruff` linter and formatter, and `mypy`)
 
 ```bash
 make lint

Makefile

@@ -27,18 +27,15 @@ e2e-tests:
 lint: format-fix lint-check
 
 format-fix:
-	isort package/kedro_viz package/tests package/features
-	black package/kedro_viz package/tests package/features
+	ruff check --fix
+	ruff format
 
 format-check:
-	isort --check package/kedro_viz package/tests package/features
-	black --check package/kedro_viz package/tests package/features
+	ruff check
+	ruff format --check
 
 lint-check:
-	pylint --rcfile=package/.pylintrc -j 0 package/kedro_viz
-	pylint --rcfile=package/.pylintrc -j 0 --disable=protected-access,missing-docstring,redefined-outer-name,invalid-name,too-few-public-methods,no-member,unused-argument,duplicate-code,abstract-class-instantiated package/tests
-	pylint --rcfile=package/.pylintrc -j 0 --disable=missing-docstring,no-name-in-module,unused-argument package/features
-	flake8 --config=package/.flake8 package
+	ruff check
 	mypy --config-file=package/mypy.ini package/kedro_viz package/features
 	mypy --disable-error-code abstract --config-file=package/mypy.ini package/tests
 

RELEASE.md

@@ -18,6 +18,7 @@ Please follow the established format:
 - Fix unserializable parameters value (#2122)
 - Display full dataset type with library prefix in metadata panel (#2136)
 - Enable SQLite WAL mode for Azure ML to fix database locking issues (#2131)
+- Replace `flake8`, `isort`, `pylint` and `black` by `ruff` (#2149)
 
 
 # Release 10.0.0

demo-project/.pre-commit-config.yaml

@@ -14,31 +14,11 @@ repos:
           - id: check-json # Checks json files for parseable syntax.
           - id: check-case-conflict # Check for files that would conflict in case-insensitive filesystems
           - id: check-merge-conflict # Check for files that contain merge conflict strings.
-          - id: debug-statements # Check for debugger imports and py37+ `breakpoint()` calls in python source.
           - id: requirements-txt-fixer # Sorts entries in requirements.txt
-          - id: flake8
-            args:
-            - "--max-line-length=100"
-            - "--max-complexity=18"
-            - "--max-complexity=18"
-            - "--select=B,C,E,F,W,T4,B9"
-            - "--ignore=E203,E266,E501,W503"
 
-    - repo: local
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.7.0
       hooks:
-          - id: isort
-            name: "Sort imports"
-            language: system
-            types: [file, python]
-            entry: isort
-          - id: black
-            name: "Black"
-            language: system
-            types: [file, python]
-            entry: black
-          - id: kedro lint
-            name: "Kedro lint"
-            language: python_venv
-            types: [file, python]
-            entry: kedro lint
-            stages: [commit]
+        - id: ruff
+          args: [--fix]
+        - id: ruff-format

demo-project/docs/source/conf.py

@@ -22,6 +22,7 @@
 
 from kedro.framework.cli.utils import find_stylesheets
 from recommonmark.transform import AutoStructify
+
 from demo_project import __version__ as release
 
 # -- Project information -----------------------------------------------------

demo-project/pyproject.toml

@@ -3,14 +3,6 @@ package_name = "demo_project"
 project_name = "modular-spaceflights"
 kedro_init_version = "0.19.0"
 
-[tool.isort]
-multi_line_output = 3
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-line_length = 88
-known_third_party = "kedro"
-
 [tool.pytest.ini_options]
 addopts = """
 --cov-report term-missing \

demo-project/ruff.toml

@@ -0,0 +1,5 @@
+extend = "../ruff.toml"
+
+[lint.isort]
+known-first-party = ["demo_project"]
+known-third-party = ["kedro"]

demo-project/src/demo_project/__init__.py

@@ -1,4 +1,3 @@
-"""demo-project
-"""
+"""demo-project"""
 
 __version__ = "0.1"

demo-project/src/demo_project/__main__.py

@@ -1,6 +1,7 @@
 """demo-project file for ensuring the package is executable
 as `demo-project` and `python -m demo_project`
 """
+
 from pathlib import Path
 
 from kedro.framework.project import configure_project

demo-project/src/demo_project/hooks.py

@@ -1,4 +1,5 @@
 """Project hooks."""
+
 import logging
 import time
 from typing import Any

demo-project/src/demo_project/pipeline_registry.py

@@ -1,4 +1,5 @@
 """Project pipelines."""
+
 from typing import Dict
 
 from kedro.pipeline import Pipeline
@@ -8,6 +9,7 @@
 from demo_project.pipelines import modelling as mod
 from demo_project.pipelines import reporting as rep
 
+
 def register_pipelines() -> Dict[str, Pipeline]:
     """Register the project's pipelines.
 
@@ -24,7 +26,7 @@ def register_pipelines() -> Dict[str, Pipeline]:
     )
 
     reporting_pipeline = rep.create_pipeline()
-    
+
     return {
         "__default__": (
             ingestion_pipeline

demo-project/src/demo_project/pipelines/data_ingestion/pipeline.py

@@ -27,21 +27,21 @@ def create_pipeline(**kwargs) -> Pipeline:
                 func=apply_types_to_companies,
                 inputs="companies",
                 outputs="int_typed_companies",
-                name='apply_types_to_companies',
-                tags='companies'
+                name="apply_types_to_companies",
+                tags="companies",
             ),
             node(
                 func=apply_types_to_shuttles,
                 inputs="shuttles",
                 outputs="int_typed_shuttles@pandas1",
-                name='apply_types_to_shuttles',
-                tags='shuttles'
+                name="apply_types_to_shuttles",
+                tags="shuttles",
             ),
             node(
                 func=apply_types_to_reviews,
                 inputs=["reviews", "params:typing.reviews.columns_as_floats"],
                 outputs="int_typed_reviews",
-                name='apply_types_to_reviews'
+                name="apply_types_to_reviews",
             ),
             node(
                 func=aggregate_company_data,

demo-project/src/demo_project/pipelines/feature_engineering/pipeline.py

@@ -3,7 +3,6 @@
 generated using Kedro 0.18.1
 """
 
-
 from kedro.pipeline import Pipeline, node
 from kedro.pipeline.modular_pipeline import pipeline
 

demo-project/src/demo_project/pipelines/modelling/nodes.py

@@ -85,15 +85,11 @@ def evaluate_model(
     """
     y_pred = regressor.predict(X_test)
     score = r2_score(y_test, y_pred)
-    a2_score = random.randint(0,100)*0.1
-    b2_score = random.randint(0,100)*0.1
+    a2_score = random.randint(0, 100) * 0.1
+    b2_score = random.randint(0, 100) * 0.1
     logger = logging.getLogger(__name__)
     logger.info(
         f"Model has a coefficient R^2 of {score:.3f} on test data using a "
         f"regressor of type '{type(regressor)}'"
     )
-    return {
-        "r2_score": score,
-        "a2_score":a2_score,
-        "b2_score":b2_score
-        }
+    return {"r2_score": score, "a2_score": a2_score, "b2_score": b2_score}

demo-project/src/demo_project/pipelines/modelling/pipeline.py

@@ -22,13 +22,13 @@ def new_train_eval_template() -> Pipeline:
                 func=train_model,
                 inputs=["X_train", "y_train", "params:dummy_model_options"],
                 outputs=["regressor", "experiment_params"],
-                tags="train"
+                tags="train",
             ),
             node(
                 func=evaluate_model,
                 inputs=["regressor", "X_test", "y_test"],
                 outputs="r2_score",
-                tags="evaluate"
+                tags="evaluate",
             ),
         ]
     )
@@ -83,7 +83,7 @@ def create_pipeline(model_types: List[str]) -> Pipeline:
         pipeline(
             pipe=new_train_eval_template(),
             parameters={"dummy_model_options": f"model_options.{model_type}"},
-            inputs={k: k for k in test_train_refs},  
+            inputs={k: k for k in test_train_refs},
             namespace=model_type,
         )
         for model_type in model_types

demo-project/src/demo_project/pipelines/reporting/image_utils.py

@@ -22,7 +22,6 @@ def __init__(self, _df: pd.DataFrame, x: int = 500, y: int = 200):
         self._populate(_df)
 
     def _draw_grid(self):
-
         width, height = self.image.size
         row_step = (height - self.border * 2) / (self.rows)
         col_step = (width - self.border * 2) / (self.cols)

demo-project/src/demo_project/pipelines/reporting/nodes.py

@@ -2,14 +2,17 @@
 This is a boilerplate pipeline 'reporting'
 generated using Kedro 0.18.1
 """
+
+from typing import Dict
+
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
 import PIL
 import plotly.express as px
 import seaborn as sn
 from plotly import graph_objects as go
-from typing import Dict
+
 from .image_utils import DrawTable
 
 

demo-project/src/demo_project/pipelines/reporting/pipeline.py

@@ -8,10 +8,10 @@
 from demo_project.pipelines.reporting.nodes import (
     create_feature_importance_plot,
     create_matplotlib_chart,
+    get_top_shuttles_data,
     make_cancel_policy_bar_chart,
     make_price_analysis_image,
     make_price_histogram,
-    get_top_shuttles_data,
 )
 
 

demo-project/src/demo_project/requirements.in

@@ -1,7 +1,4 @@
-black~=22.0
-flake8>=3.7.9, <4.0
 ipython~=7.0
-isort~=5.0
 jupyter~=1.0
 jupyter_client>=5.1, <7.0
 jupyterlab~=3.0
@@ -16,4 +13,5 @@ wheel>=0.35, <0.37
 pillow~=9.0
 matplotlib==3.5.0
 pre-commit~=1.17
+ruff==0.7.0
 seaborn>=0.13.0

demo-project/src/tests/test_run.py

@@ -7,6 +7,7 @@
 
 To run the tests, run ``kedro test``.
 """
+
 from pathlib import Path
 
 import pytest