Merge pull request #168 from scipp/switch-to-ruff

Switch to ruff for formatting and static analysis (for real)

Author: jl-wynen

template/.pre-commit-config.yaml

@@ -13,34 +13,21 @@ repos:
       - id: trailing-whitespace
         args: [ --markdown-linebreak-ext=md ]
         exclude: '\.svg'
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        name: isort (python)
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.11.0
-    hooks:
-      - id: black
   - repo: https://github.com/kynan/nbstripout
     rev: 0.6.0
     hooks:
       - id: nbstripout
         types: [ "jupyter" ]
         args: [ "--drop-empty-cells",
                 "--extra-keys 'metadata.language_info.version cell.metadata.jp-MarkdownHeadingCollapsed cell.metadata.pycharm'" ]
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        types: ["python"]
-        additional_dependencies: ["flake8-bugbear==23.9.16"]
-  - repo: https://github.com/pycqa/bandit
-    rev: 1.7.5
-    hooks:
-      - id: bandit
-        additional_dependencies: ["bandit[toml]"]
-        args: ["-c", "pyproject.toml"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.1
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+        types_or: [ python, pyi, jupyter ]
+      - id: ruff-format
+        types_or: [ python, pyi ]
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.6
     hooks:

template/docs/conf.py.jinja

@@ -8,9 +8,9 @@ from importlib.metadata import version as get_version
 sys.path.insert(0, os.path.abspath('.'))
 
 # General information about the project.
-project = u'{{prettyname}}'
-copyright = u'{{year}} Scipp contributors'
-author = u'Scipp contributors'
+project = '{{prettyname}}'
+copyright = '{{year}} Scipp contributors'
+author = 'Scipp contributors'
 
 html_show_sourcelink = True
 
@@ -32,6 +32,7 @@ extensions = [
 {% if orgname == 'scipp'  %}
 try:
     import sciline.sphinxext.domain_types  # noqa: F401
+
     extensions.append('sciline.sphinxext.domain_types')
 except ModuleNotFoundError:
     pass

template/docs/developer/coding-conventions.md

@@ -2,7 +2,7 @@
 
 ## Code formatting
 
-There are no explicit code formatting conventions since we use `black` to enforce a format.
+There are no explicit code formatting conventions since we use `ruff` to enforce a format.
 
 ## Docstring format
 

template/pyproject.toml.jinja

@@ -55,17 +55,41 @@ filterwarnings = [
   "error",
 ]
 
-[tool.bandit]
-# Excluding tests because bandit doesn't like `assert`.
-exclude_dirs = ["docs/conf.py", "tests"]
+[tool.ruff]
+line-length = 88
+extend-include = ["*.ipynb"]
+extend-exclude = [
+    ".*", "__pycache__", "build", "dist", "install",
+]
+
+[tool.ruff.lint]
+# See https://docs.astral.sh/ruff/rules/
+select = ["B", "C4", "DTZ", "E", "F", "G", "I", "PERF", "PGH", "PT", "PYI", "RUF", "S", "T20", "W"]
+ignore = [
+    # Conflict with ruff format, see
+    # https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    "COM812", "COM819", "D206", "D300", "E111", "E114", "E117", "ISC001", "ISC002", "Q000", "Q001", "Q002", "Q003", "W191",
+]
+fixable = ["I001", "B010"]
+isort.known-first-party = ["{{projectname}}"]
+pydocstyle.convention = "numpy"
 
-[tool.black]
-skip-string-normalization = true
+[tool.ruff.lint.per-file-ignores]
+# those files have an increased risk of relying on import order
+"__init__.py" = ["I"]
+"tests/*" = [
+    "S101",  # asserts are fine in tests
+    "B018",  # 'useless expressions' are ok because some tests just check for exceptions
+]
+"*.ipynb" = [
+    "E501",  # longer lines are sometimes more readable
+    "I",  # we don't collect imports at the top
+    "S101",  # asserts are used for demonstration and are safe in notebooks
+    "T201",  # printing is ok for demonstration purposes
+]
 
-[tool.isort]
-skip_gitignore = true
-profile = "black"
-known_first_party = ["{{projectname}}"]
+[tool.ruff.format]
+quote-style = "preserve"
 
 [tool.mypy]
 strict = true

template/setup.cfg.jinja

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) {{year}} {{orgname|capitalize}} contributors (https://github.com/{{orgname}})
+# ruff: noqa: E402, F401
 
-# flake8: noqa
 import importlib.metadata
 
 try:

template/src/{% if namespace_package %}{{namespace_package}}{% endif %}/{{ projectname.removeprefix(namespace_package) }}/__init__.py.jinja

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) {{year}} {{orgname|capitalize}} contributors (https://github.com/{{orgname}})
+# ruff: noqa: E402, F401
 
-# flake8: noqa
 import importlib.metadata
 
 try: