Merge branch 'feature/v0.1.5' into develop

Author: KelSolaar

.flake8

@@ -1,13 +1,12 @@
 repos:
--   repo: https://github.com/asottile/pyupgrade
-    rev: v3.2.2
-    hooks:
-    -   id: pyupgrade
-        args: [--py39-plus]
 -   repo: https://github.com/ikamensh/flynt/
     rev: '0.77'
     hooks:
     -   id: flynt
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.239'
+    hooks:
+    - id: ruff
 -   repo: https://github.com/psf/black
     rev: 22.10.0
     hooks:
@@ -18,14 +17,3 @@ repos:
     hooks:
     - id: blackdoc
       language_version: python3.9
--   repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
-    hooks:
-    -   id: flake8
--   repo: https://github.com/pycqa/pydocstyle
-    rev: 6.1.1
-    hooks:
-    -   id: pydocstyle
-        args:
-        - --convention=numpy
-        - --add-ignore=D104,D200,D202,D205,D301,D400

.pre-commit-config.yaml

@@ -11,6 +11,7 @@
 
 from __future__ import annotations
 
+import contextlib
 import cv2
 import numpy as np
 import os
@@ -81,7 +82,5 @@
 del _version
 
 # TODO: Remove legacy printing support when deemed appropriate.
-try:
+with contextlib.suppress(TypeError):
     np.set_printoptions(legacy="1.13")
-except TypeError:
-    pass

colour_checker_detection/__init__.py

@@ -34,7 +34,6 @@
     NDArrayInt,
     Tuple,
     Type,
-    Union,
     cast,
 )
 from colour.models import cctf_encoding
@@ -566,7 +565,7 @@ class DataColourCheckersCoordinatesSegmentation(MixinDataclassIterable):
 
 def colour_checkers_coordinates_segmentation(
     image: ArrayLike, additional_data: bool = False, **kwargs: Any
-) -> Union[DataColourCheckersCoordinatesSegmentation, Tuple[NDArrayInt, ...]]:
+) -> DataColourCheckersCoordinatesSegmentation | Tuple[NDArrayInt, ...]:
     """
     Detect the colour checkers coordinates in given image :math:`image` using
     segmentation.
@@ -975,9 +974,8 @@ def detect_colour_checkers_segmentation(
     samples: int = 16,
     additional_data: bool = False,
     **kwargs: Any,
-) -> Union[
-    Tuple[DataDetectColourCheckersSegmentation, ...],
-    Tuple[NDArrayFloat, ...],
+) -> Tuple[DataDetectColourCheckersSegmentation, ...] | Tuple[
+    NDArrayFloat, ...
 ]:
     """
     Detect the colour checkers swatches in given image using segmentation.

colour_checker_detection/detection/segmentation.py

@@ -69,7 +69,7 @@
 master_doc = "index"
 
 project = package.__application_name__
-copyright = package.__copyright__.replace("Copyright (C)", "")
+copyright = package.__copyright__.replace("Copyright (C)", "")  # noqa: A001
 version = f"{package.__major_version__}.{package.__minor_version__}"
 release = package.__version__
 
@@ -180,7 +180,9 @@
 epub_exclude_files = ["search.html"]
 
 
-def autodoc_process_docstring(app, what, name, obj, options, lines):
+def autodoc_process_docstring(
+    app, what, name, obj, options, lines  # noqa: ARG001
+):
     """Process the docstrings to remove the *# noqa* *flake8* pragma."""
 
     for i, line in enumerate(lines):

docs/conf.py

@@ -59,19 +59,17 @@ black = { version = "*", optional = true }  # Development dependency.
 blackdoc = { version = "*", optional = true }  # Development dependency.
 coverage = { version = "*", optional = true }  # Development dependency.
 coveralls = { version = "*", optional = true }  # Development dependency.
-flake8 = { version = "*", optional = true }  # Development dependency.
 flynt = { version = "*", optional = true }  # Development dependency.
 invoke = { version = "*", optional = true }  # Development dependency.
 jupyter = { version = "*", optional = true }  # Development dependency.
 pre-commit = { version = "*", optional = true }  # Development dependency.
 pydata-sphinx-theme = { version = "*", optional = true }  # Development dependency.
-pydocstyle = { version = "*", optional = true }  # Development dependency.
 pyright = { version = "*", optional = true }  # Development dependency.
 pytest = { version = "*", optional = true }  # Development dependency.
 pytest-cov = { version = "*", optional = true }  # Development dependency.
 pytest-xdist = { version = "*", optional = true} #Development dependency
-pyupgrade = { version = "*", optional = true }  # Development dependency.
 restructuredtext-lint = { version = "*", optional = true }  # Development dependency.
+ruff = { version = "*", optional = true }  # Development dependency.
 sphinx = { version = ">= 4, < 5", optional = true }  # Development dependency.
 sphinxcontrib-bibtex = { version = "*", optional = true }  # Development dependency.
 toml = { version = "*", optional = true }  # Development dependency.
@@ -83,19 +81,17 @@ black = "*"
 blackdoc = "*"
 coverage = "!= 6.3"
 coveralls = "*"
-flake8 = "*"
 flynt = "*"
 invoke = "*"
 jupyter = "*"
 pre-commit = "*"
 pydata-sphinx-theme = "*"
-pydocstyle = "*"
 pyright = "*"
 pytest = "*"
 pytest-cov = "*"
 pytest-xdist = "*"
-pyupgrade = "*"
 restructuredtext-lint = "*"
+ruff = "*"
 sphinx = ">= 4, < 5"
 sphinxcontrib-bibtex = "*"
 toml = "*"
@@ -108,19 +104,17 @@ development = [
     "blackdoc",
     "coverage",
     "coveralls",
-    "flake8",
     "flynt",
     "invoke",
     "jupyter",
     "pre-commit",
     "pydata-sphinx-theme",
-    "pydocstyle",
     "pyright",
     "pytest",
     "pytest-cov",
     "pytest-xdist",
-    "pyupgrade",
     "restructuredtext-lint",
+    "ruff",
     "sphinx",
     "sphinxcontrib-bibtex",
     "toml",
@@ -142,10 +136,6 @@ exclude = '''
 [tool.flynt]
 line_length=999
 
-[tool.pydocstyle]
-convention = "numpy"
-add-ignore = "D104,D200,D202,D205,D301,D400"
-
 [tool.pyright]
 reportMissingImports = false
 reportMissingModuleSource = false
@@ -158,6 +148,95 @@ reportUnusedExpression = false
 [tool.pytest.ini_options]
 addopts = "-n auto --dist=loadscope --durations=5"
 
+[tool.ruff]
+target-version = "py39"
+line-length = 88
+select = [
+    "A",      # flake8-builtins
+    "ARG",    # flake8-unused-arguments
+    # "ANN",  # flake8-annotations
+    "B",      # flake8-bugbear
+    # "BLE",  # flake8-blind-except
+    "C4",   # flake8-comprehensions
+    # "C90",  # mccabe
+    # "COM",  # flake8-commas
+    "DTZ",    # flake8-datetimez
+    "D",      # pydocstyle
+    "E",      # pydocstyle
+    # "ERA",  # eradicate
+    # "EM",   # flake8-errmsg
+    "EXE",    # flake8-executable
+    "F",      # flake8
+    # "FBT",  # flake8-boolean-trap
+    "G",      # flake8-logging-format
+    "I",      # isort
+    "ICN",    # flake8-import-conventions
+    "INP",    # flake8-no-pep420
+    "ISC",    # flake8-implicit-str-concat
+    "N",      # pep8-naming
+    # "PD",   # pandas-vet
+    "PIE",    # flake8-pie
+    "PGH",    # pygrep-hooks
+    "PL",     # pylint
+    # "PT",   # flake8-pytest-style
+    # "PTH",  # flake8-use-pathlib          [Enable]
+    "Q",      # flake8-quotes
+    "RET",    # flake8-return
+    "RUF",    # Ruff
+    "S",      # flake8-bandit
+    "SIM",    # flake8-simplify
+    "T10",    # flake8-debugger
+    "T20",    # flake8-print
+    # "TCH",  # flake8-type-checking
+    "TID",    # flake8-tidy-imports
+    "TRY",    # tryceratops
+    "UP",     # pyupgrade
+    "W",      # pydocstyle
+    "YTT"     # flake8-2020
+]
+ignore = [
+    "B008",
+    "B905",
+    "D104",
+    "D200",
+    "D202",
+    "D205",
+    "D301",
+    "D400",
+    "I001",
+    "N801",
+    "N802",
+    "N803",
+    "N806",
+    "N813",
+    "N815",
+    "N816",
+    "PIE804",
+    "PLE0605",
+    "PLR0913",
+    "PLR2004",
+    "RET504",
+    "RET505",
+    "RET506",
+    "RET507",
+    "RET508",
+    "TRY003",
+    "TRY300",
+]
+typing-modules = ["colour.hints"]
+fixable = ["B", "C", "E", "F", "PIE", "RUF", "SIM", "UP", "W"]
+
+[tool.ruff.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.per-file-ignores]
+"colour-checker-detection/examples/*" = ["INP", "T201", "T203"]
+"docs/*" = ["INP"]
+"setup.py" = ["INP"]
+"tasks.py" = ["INP"]
+"utilities/*" = ["EXE001", "INP"]
+"utilities/unicode_to_ascii.py" = ["RUF001"]
+
 [build-system]
 requires = [ "poetry_core>=1.0.0" ]
 build-backend = "poetry.core.masonry.api"