format-docstring/muff.toml at main · jsh9/format-docstring · 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# Docs: https://docs.astral.sh/ruff/configuration

exclude = ["tests/test_data"]
line-length = 79
target-version = "py310"

[format]
docstring-code-format = true
preview = true
quote-style = "single"

[lint]
# Explanations: https://docs.astral.sh/ruff/rules
extend-select = [
  "A", # flake8-builtins
  "ANN", # flake8-annotations
  "ARG", # flake8-unused-arguments
  "ASYNC", # flake8-async
  "B", # flake8-bugbear
  "BLE", # flake8-blind-except
  "C4", # flake8-comprehensions
  "C4", # flake8-comprehensions
  "C901", # mccabe
  "D", # pydocstyle
  "DTZ", # flake8-datetimez
  "E", # pycodestyle: error
  "ERA", # flake8-eradicate
  "EXE", # flake8-executable
  "F", # Pyflakes
  "FA", # flake8-future-annotations
  "FBT", # flake8-boolean-trap
  "FLY", # flake8-flynt
  "FURB", # refurb
  "G", # flake8-logging-format
  "I", # isort
  "ICN", # flake8-import-conventions
  "INP", # flake8-no-pep420
  "ISC", # flake8-implicit-str-concat
  "ISC", # flake8-implicit-str-concat
  "LOG", # flake8-logging
  "N", # pep8-naming
  "NPY", # numpy-specific rules
  "PD", # pandas-vet
  "PERF", # Perflint
  "PGH", # pygrep-hooks
  "PIE", # flake8-pie
  "PL", # Pylint
  "PT", # flake8-pytest-style
  "PTH", # flake8-use-pathlib
  "PYI", # flake8-pyi
  "Q", # flake8-quotes
  "RET", # flake8-return
  "RUF", # Ruff-specific rules
  "S", # flake8-bandit
  "SIM", # flake8-simplify
  "SLF", # flake8-self
  "SLOT", # flake8-slots
  "T10", # flake8-debugger
  "T10", # flake8-debugger
  "TC", # flake8-type-checking
  "TD", # flake8-todos
  "TID", # flake8-tidy-imports
  "TRY", # tryceratops
  "UP", # pyupgrade
  "W", # pycodestyle: warning
]
ignore = [
  "ANN401",
  "D100",
  "D104",
  "D105",
  "D107",
  "D200",
  "D205",
  "D400",
  "PLC1901", # compare with empty string
  "S101",
  "S110",
  "TD002",
  "TRY003", # we can allow on-the-fly exception messages
]
preview = true

[lint.flake8-import-conventions.banned-aliases]
typing = ["ty", "typ"]

[lint.flake8-quotes]
docstring-quotes = "double"
inline-quotes = "single"

[lint.flake8-tidy-imports]
ban-relative-imports = "all"

[lint.mccabe]
max-complexity = 14

[lint.per-file-ignores]
"tests/*" = [
  "D101", # no need for docstrings in tests
  "D102",
  "D103",
  "PLC2701", # importing private functions is allowed in tests
  "PLR2004", # using magic numbers is allowed in tests
]

[lint.pydocstyle]
convention = "numpy"

[lint.pylint]
max-args = 1000
max-bool-expr = 10
max-branches = 100
max-locals = 1000
max-nested-blocks = 10
max-returns = 30
max-statements = 50