Move towards usage of ruff

Author: fkantelberg

.gitignore

@@ -2,6 +2,7 @@
 *.log
 .coverage
 .pytest_cache
+.ruff_cache
 .tox/
 __pycache__/
 build/

.pre-commit-config.yaml

@@ -1,31 +1,14 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.13.0
     hooks:
-      - id: black
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 3.8.3
-    hooks:
-      - id: flake8
-        additional_dependencies: [flake8-bugbear]
-
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.8.0
-    hooks:
-      - id: isort
-        name: isort
-        args:
-          - --settings=.
-
-  - repo: https://github.com/pre-commit/mirrors-pylint
-    rev: v2.7.4
+  - repo: https://github.com/pylint-dev/pylint
+    rev: v3.3.8
     hooks:
       - id: pylint
         name: pylint
-        args:
-          - --rcfile=.pylintrc
-          - --exit-zero
         verbose: true
-        additional_dependencies: &pylint_deps
-          - pylint-odoo==6.2.0

.pylintrc

@@ -6,3 +6,58 @@ build-backend = "setuptools.build_meta"
 line-length = 88
 target-version = ['py36', 'py37', 'py38', 'py39', 'py310']
 include = '(\.pyi?$|src|tests)'
+
+[tool.ruff]
+target-version = "py310"
+fix = true
+
+[tool.ruff.lint]
+extend-select = [
+    "B",
+    "C90",
+    "E501",  # line too long (default 88)
+    "I",  # isort
+    "UP",  # pyupgrade
+]
+extend-safe-fixes = ["UP008"]
+exclude = ["setup/*"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 16
+
+[tool.pylint.main]
+ignored-modules = ["dateutil", "git_aggregator", "odoo", "pytest", "pytest_odoo", "yaml"]
+
+[tool.pylint.imports]
+ignored-modules = ["dateutil", "git_aggregator", "odoo", "pytest", "pytest_odoo", "yaml"]
+
+[tool.pylint."messages control"]
+disable = """
+  attribute-defined-outside-init,
+  bad-inline-option,
+  bad-mcs-classmethod-argument,
+  broad-except,
+  deprecated-pragma,
+  duplicate-code,
+  file-ignored,
+  invalid-name,
+  locally-disabled,
+  logging-fstring-interpolation,
+  missing-class-docstring,
+  missing-function-docstring,
+  missing-module-docstring,
+  protected-access,
+  raw-checker-failed,
+  redefined-outer-name,
+  suppressed-message,
+  too-few-public-methods,
+  too-many-arguments,
+  too-many-instance-attributes,
+  too-many-locals,
+  too-many-positional-arguments,
+  too-many-return-statements,
+  unused-argument,
+  use-implicit-booleaness-not-comparison,
+  use-symbolic-message-instead,
+  useless-suppression,
+"""

pyproject.toml

@@ -22,13 +22,9 @@ package_dir =
 packages = find:
 python_requires = >=3.6
 install_requires =
-  black
   coverage
-  debugpy
-  flake8
   git-aggregator
   ipython
-  isort>=4.3.10
   pylint_odoo
   python-dateutil
   pytest-cov
@@ -37,7 +33,15 @@ install_requires =
 
 [options.entry_points]
 console_scripts =
-    dob = doblib.__main__:main
+  dob = doblib.__main__:main
+
+[options.extras_require]
+no-ruff =
+  black
+  flake8
+  isort>=4.3.10
+ruff =
+  ruff
 
 [options.packages.find]
 where = src

setup.cfg

@@ -1 +1 @@
-VERSION = "0.19.8"
+VERSION = "0.20.0"

src/doblib/__init__.py

@@ -97,6 +97,8 @@ def load_arguments(args):
     return parser.parse_known_args(args)
 
 
+# ruff: noqa: C901
+# pylint: disable=R0912
 def main(args=None):
     args = args or sys.argv[1:]
 

src/doblib/__main__.py

@@ -35,6 +35,7 @@ def load_action_arguments(args, actions=None):
         default=False,
         help="Run the action as a dry-run and don't commit changes",
     )
+    # ruff: noqa: E501
     parser.add_argument_group(
         "Actions",
         "Database actions are defined under the `actions` section in the configuration "
@@ -366,6 +367,7 @@ def _action_delete(self, env, model, domain, item, *, dry_run=False):
 
     def _action_update(self, env, model, domain, item, *, dry_run=False):
         """Runs the update action"""
+        # pylint: disable=R0912
         values = item.get("values", {})
         if not values or model not in env:
             return

src/doblib/action.py

@@ -13,7 +13,7 @@
 from git_aggregator.repo import Repo
 from git_aggregator.utils import ThreadNameKeeper
 
-from . import base, env, utils
+from . import env, utils
 
 
 def aggregate_repo(repo, args, sem, err_queue, mode=None):
@@ -145,6 +145,8 @@ def _aggregator(self, args, mode=None):
                 traceback.print_exception(exc_type, exc_obj, exc_trace)
             return 1
 
+        return 0
+
     def init(self, args=None):
         """Initialize the environment using the git-aggregator"""
         args, _ = load_init_arguments(args or [])

src/doblib/aggregate.py

@@ -7,12 +7,11 @@
 import sys
 from fnmatch import fnmatch
 
-import isort
 import pytest
 
 from . import base, env, utils
 
-CI = ("black", "eslint", "flake8", "isort", "prettier", "pylint")
+CI = ("black", "eslint", "flake8", "isort", "prettier", "pylint", "ruff", "ruff-format")
 
 
 def load_ci_arguments(args):
@@ -31,6 +30,13 @@ class CIEnvironment(env.Environment):
 
     def _ci_black(self, options, args, paths, ignores):
         """Run black"""
+        try:
+            # pylint: disable=C0415,W0611
+            import black
+        except ImportError:
+            utils.error("black is not installed")
+            return 1
+
         cmd = [sys.executable, "-m", "black"]
 
         # Replace pattern matching with regex
@@ -75,6 +81,13 @@ def _ci_eslint(self, options, args, paths, ignores):
 
     def _ci_flake8(self, options, left, paths, ignores):
         """Run flake8 tests"""
+        try:
+            # pylint: disable=C0415,E0401,W0611
+            import flake8
+        except ImportError:
+            utils.error("flake8 is not installed")
+            return 1
+
         cmd = [sys.executable, "-m", "flake8"]
         if ignores:
             cmd.append("--extend-exclude=" + ",".join(ignores))
@@ -88,6 +101,12 @@ def _ci_flake8(self, options, left, paths, ignores):
 
     def _ci_isort(self, options, args, paths, ignores):
         """Run isort"""
+        try:
+            # pylint: disable=C0415,E0401,W0611
+            import isort
+        except ImportError:
+            utils.error("isort is not installed")
+            return 1
 
         cmd = [sys.executable, "-m", "isort"]
         if not options.fix:
@@ -151,6 +170,13 @@ def _ci_prettier(self, options, args, paths, ignores):
 
     def _ci_pylint(self, options, args, paths, ignores):
         """Run pylint tests for Odoo"""
+        try:
+            # pylint: disable=C0415,E0401,W0611
+            import pylint
+        except ImportError:
+            utils.error("pylint is not installed")
+            return 1
+
         files = set()
 
         extensions = self.get(
@@ -182,6 +208,50 @@ def _ci_pylint(self, options, args, paths, ignores):
 
         return utils.call(*cmd, *args, *files, pipe=False)
 
+    def _ci_ruff(self, options, args, paths, ignores):
+        try:
+            # pylint: disable=C0415,E0401,W0611
+            import ruff
+        except ImportError:
+            utils.error("ruff is not installed")
+            return 1
+
+        cmd = [
+            sys.executable,
+            "-m",
+            "ruff",
+            "check",
+            "--fix" if options.fix else "--no-fix",
+            "--force-exclude",
+        ]
+        for pattern in ignores:
+            cmd += ["--exclude", pattern]
+
+        return utils.call(*cmd, *args, *paths, pipe=False)
+
+    def _ci_ruff_format(self, options, args, paths, ignores):
+        try:
+            # pylint: disable=C0415,E0401,W0611
+            import ruff
+        except ImportError:
+            utils.error("ruff is not installed")
+            return 1
+
+        cmd = [
+            sys.executable,
+            "-m",
+            "ruff",
+            "format",
+            "--force-exclude",
+        ]
+        if not options.fix:
+            cmd.append("--check")
+
+        for pattern in ignores:
+            cmd += ["--exclude", pattern]
+
+        return utils.call(*cmd, *args, *paths, pipe=False)
+
     def _ci_paths(self):
         return self.get("odoo", "addons_path", default=[]) + self.get(
             base.SECTION, "ci_path", default=[]
@@ -193,15 +263,17 @@ def ci(self, ci, args=None):
 
         # Always include this script in the tests
         ignores = self.get(base.SECTION, "blacklist", default=[])
-        func = getattr(self, f"_ci_{ci}", None)
+        func = getattr(self, f"_ci_{ci.replace('-', '_')}", None)
         if ci in CI and callable(func):
+            # pylint: disable=E1102
             return func(args, left, self._ci_paths(), ignores)
 
         utils.error(f"Unknown CI {ci}")
         return 1
 
     def _install_patches_for_pytest(self):
         """Apply patches for pytest"""
+        # pylint: disable=C0415
         from odoo.tests.common import BaseCase
 
         if hasattr(BaseCase, "run"):
@@ -227,7 +299,8 @@ def test(self, args=None):
         if not self._init_odoo():
             return False
 
-        # pylint: disable=C0415,E0401
+        # pylint: disable=C0415,E0401,W0611
+        # ruff: noqa: F401
         import odoo
         from odoo.cli.server import report_configuration
         from odoo.tools import config