Using ruff instead of black and isort

Author: PierreRaybaut

.isort.cfg

@@ -14,15 +14,12 @@
     "files.trimTrailingWhitespace": true,
     "python.defaultInterpreterPath": "${env:CDL_PYTHONEXE}",
     "editor.formatOnSave": true,
-    "isort.args": [
-        "--profile",
-        "black"
-    ],
+    "python.analysis.autoFormatStrings": true,
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestPath": "pytest",
+    "python.testing.pytestArgs": [],
     "[python]": {
-        "editor.codeActionsOnSave": {
-            "source.organizeImports": "explicit"
-        },
-        "editor.defaultFormatter": "ms-python.black-formatter"
+        "editor.defaultFormatter": "charliermarsh.ruff"
     },
-    "python.analysis.autoFormatStrings": true,
 }

.vscode/settings.json

@@ -89,6 +89,34 @@
                 "clear": true
             }
         },
+        {
+            "label": "Run Ruff",
+            "type": "shell",
+            "command": "cmd",
+            "args": [
+                "/c",
+                "run_ruff.bat",
+            ],
+            "options": {
+                "cwd": "scripts",
+                "env": {
+                    "PYTHON": "${env:CDL_PYTHONEXE}",
+                    "UNATTENDED": "1"
+                }
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "dedicated",
+                "showReuseMessage": true,
+                "clear": true
+            }
+        },
         {
             "label": "Run Coverage",
             "type": "shell",

.vscode/tasks.json

@@ -12,8 +12,6 @@
 
 from __future__ import annotations
 
-import os.path as osp
-
 from guidata import configtools
 
 MOD_NAME = "cdlclient"

cdlclient/config.py

@@ -147,6 +147,3 @@ def add_images(self):
     @abc.abstractmethod
     def remove_all(self):
         """Remove all objects from DataLab"""
-
-    def remove_all(self):
-        """Remove all objects from DataLab"""

cdlclient/tests/remoteclient_base.py

@@ -47,7 +47,7 @@ Documentation = "https://cdlclient.readthedocs.io/en/latest/"
 cdlclient-tests = "cdlclient.tests:run"
 
 [project.optional-dependencies]
-dev = ["black", "isort", "pylint", "Coverage"]
+dev = ["ruff", "pylint", "Coverage"]
 doc = ["sphinx", "sphinx_intl", "pydata-sphinx-theme"]
 test = ["PyQt5", "QtPy", "plotpy"]
 
@@ -59,3 +59,27 @@ include = ["cdlclient*"]
 
 [tool.setuptools.dynamic]
 version = { attr = "cdlclient.__version__" }
+
+[tool.ruff]
+exclude = [".git", ".vscode", "build", "dist"]
+line-length = 88                               # Same as Black.
+indent-width = 4                               # Same as Black.
+target-version = "py38"                        # Assume Python 3.8
+
+[tool.ruff.lint]
+# all rules can be found here: https://beta.ruff.rs/docs/rules/
+select = ["E", "F", "W", "I"]
+ignore = [
+    "E203", # space before : (needed for how black formats slicing)
+]
+
+[tool.ruff.format]
+quote-style = "double"            # Like Black, use double quotes for strings.
+indent-style = "space"            # Like Black, indent with spaces, rather than tabs.
+skip-magic-trailing-comma = false # Like Black, respect magic trailing commas.
+line-ending = "auto"              # Like Black, automatically detect the appropriate line ending.
+
+[tool.ruff.lint.per-file-ignores]
+"doc/*" = ["E402"]
+"svg_icons.py" = ["E501"]
+"datalab_banner.py" = ["E501", "W292"]

pyproject.toml

@@ -1,18 +1,16 @@
 @echo off
 REM This script was derived from PythonQwt project
 REM ======================================================
-REM Run black and isort code analysis tool
+REM Run Ruff analysis
 REM ======================================================
 REM Licensed under the terms of the MIT License
 REM Copyright (c) 2020 Pierre Raybaut
 REM (see PythonQwt LICENSE file for more details)
 REM ======================================================
 setlocal
 call %~dp0utils GetScriptPath SCRIPTPATH
-call %FUNC% GetLibName LIBNAME
+call %FUNC% GetModName MODNAME
 call %FUNC% SetPythonPath
-set PYTHON=%CDL_PYTHONEXE%
 call %FUNC% UsePython
-python -m black .
-python -m isort --profile black .
+ruff check
 call %FUNC% EndOfScript