pybids/ruff.toml at main · bids-standard/pybids · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
line-length = 99
extend-exclude = [
  "_version.py",  # Auto-generated
  "tests/data",   # Submodules
  "bids-examples",
  ".cursor",
  ".vscode",
  ".venv",
  "paper",
  "scripts/",
  "tools/",
  "*tests/*",
  "*.ipynb",
  "src/bids/external/",
]

[format]
quote-style = "single"
line-ending = "lf"
docstring-code-format = true

[lint]
extend-select = [
  "F",    # pyflakes
  "E",    # pycodestyle errors
  "W",    # pycodestyle warnings
  "I",    # isort
  "D",    # pydocstyle
  "UP",   # pyupgrade
  "YTT",  # flake8-2020
  "S",    # bandit
  "BLE",  # blind-except
  "B",    # bugbear
  "A",    # builtins
  "C4",   # comprehensions
  "DTZ",  # datetimez
  "T10",  # debugger
  # "EM",   # errmsg
  "EXE",  # executable
  "ISC",  # implicit-str-concat
  "ICN",  # import-conventions
  "PT",   # pytest-style
  "Q",    # quotes
]
ignore = [
  "D105",  # undocumented-magic-method
  "D107",  # undocumented __init__
  "D203",  # blank line before class docstring
  "D213",  # multi-line-summary-first-line
  "PT022",  # useless-yield-fixture; yield keeps fixtures/sessions alive
  "Q000",  # double quotes
  "Q003",  # avoidable-escaped-quote
  # --- Fix one group at a time; remove from ignore when done ---
  # 1. Docstrings (D*)
  "D205",  # blank line between summary and description
  "D400",  # ends with period
  "D401",  # imperative mood
  "D415",  # ends with period/question/exclamation
]

[lint.extend-per-file-ignores]
"setup.py" = ["D"]
"src/bids/external/__init__.py" = ["D104"]
"src/bids/modeling/report/__init__.py" = ["D104"]
"*/test_*.py" = [
  "S101",  # assert
  "D",
]