Skip to content

Commit c162e4f

Browse files
olifreolifre
committedSep 7, 2024
ci: add ruff config
·
v1.0.2
1 parent 8886752 commit c162e4f

File tree

1 file changed

+169
-0
lines changed

1 file changed

+169
-0
lines changed
 

‎ruff.toml

+169
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
target-version = 'py312'
2+
line-length = 120
3+
extend-exclude = ['docs', 'htmlcov', '*.egg-info']
4+
5+
[lint]
6+
preview = true
7+
dummy-variable-rgx = '^(_{2,}|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$' # a single `_` is already used for i18n
8+
9+
select = [
10+
'E', # pycodestyle
11+
'F', # pyflakes
12+
'N', # pep8-naming
13+
'Q', # flake8-quotes
14+
'RUF', # ruff
15+
'UP', # pyupgrade
16+
'D', # pydocstyle
17+
'S', # flake8-bandit
18+
'C4', # flake8-comprehensions
19+
'INT', # flake8-gettext
20+
'LOG', # flake8-logging
21+
'G', # flake8-logging-format
22+
'B', # flake8-bugbear
23+
'A001', # flake8-builtins
24+
'COM', # flake8-commas
25+
'T10', # flake8-debugger
26+
'EXE', # flake8-executable
27+
'ISC', # flake8-implicit-str-concat
28+
'PIE', # flake8-pie
29+
'PT', # flake8-pytest-style
30+
'RSE', # flake8-raise
31+
'RET504', # flake8-return
32+
'SIM', # flake8-simplify
33+
'TID', # flake8-tidy-imports
34+
'PGH', # pygrep-hooks
35+
'PL', # pylint
36+
'TRY', # tryceratops
37+
'PERF', # perflint
38+
'FURB', # refurb
39+
# 'ERA', # eradicate -- too many FPs for now, see https://github.com/astral-sh/ruff/issues/6100
40+
]
41+
ignore = [
42+
# plugin-specific excludes:
43+
'D', # too noisy for now
44+
# anything below should match the indico core ruff.toml
45+
'E226', # allow omitting whitespace around arithmetic operators
46+
'E731', # allow assigning lambdas (it's useful for single-line functions defined inside other functions)
47+
'N818', # not all our exceptions are errors
48+
'RUF012', # ultra-noisy and dicts in classvars are very common
49+
'RUF015', # not always more readable, and we don't do it for huge lists
50+
'RUF022', # autofix messes up our formatting instead of just sorting
51+
'RUF027', # also triggers on i18n functions -> too noisy for now
52+
'UP038', # it looks kind of weird and it slower than a tuple
53+
'D205', # too many docstrings which have no summary line
54+
'D301', # https://github.com/astral-sh/ruff/issues/8696
55+
'D1', # we have way too many missing docstrings :(
56+
'D401', # too noisy (but maybe useful to go through at some point)
57+
'D412', # we do not use section, and in click docstrings those blank lines are useful
58+
'S101', # we use asserts outside tests, and do not run python with `-O` (also see B011)
59+
'S113', # enforcing timeouts would likely require config in some places - maybe later
60+
'S311', # false positives, it does not care about the context
61+
'S324', # all our md5/sha1 usages are for non-security purposes
62+
'S404', # useless, triggers on *all* subprocess imports
63+
'S403', # there's already a warning on using pickle, no need to have one for the import
64+
'S405', # we don't use lxml in unsafe ways
65+
'S603', # useless, triggers on *all* subprocess calls: https://github.com/astral-sh/ruff/issues/4045
66+
'S607', # we trust the PATH to be sane
67+
'B011', # we don't run python with `-O` (also see S101)
68+
'B904', # possibly useful but too noisy
69+
'COM812', # trailing commas on multiline lists are nice, but we have 2.5k violations
70+
'PIE807', # `lambda: []` is much clearer for `load_default` in schemas
71+
'PT004', # pretty weird + not a pytest convention: https://github.com/astral-sh/ruff/issues/8796
72+
'PT005', # ^ likewise
73+
'PT011', # very noisy
74+
'PT015', # nice for tests but not so nice elsewhere
75+
'PT018', # ^ likewise
76+
'SIM102', # sometimes nested ifs are more readable
77+
'SIM103', # sometimes this is more readable (especially when checking multiple conditions)
78+
'SIM105', # try-except-pass is faster and people are used to it
79+
'SIM108', # noisy ternary
80+
'SIM114', # sometimes separate ifs are more readable (especially if they just return a bool)
81+
'SIM117', # nested context managers may be more readable
82+
'PLC0415', # local imports are there for a reason
83+
'PLC2701', # some private imports are needed
84+
'PLR09', # too-many-<whatever> is just noisy
85+
'PLR0913', # very noisy
86+
'PLR2004', # extremely noisy and generally annoying
87+
'PLR6201', # sets are faster (by a factor of 10!) but it's noisy and we're in nanoseconds territory
88+
'PLR6301', # extremely noisy and generally annoying
89+
'PLW0108', # a lambda often makes it more clear what you actually want
90+
'PLW1510', # we often do not care about the status code of commands
91+
'PLW1514', # we expect UTF8 environments everywhere
92+
'PLW1641', # false positives with SA comparator classes
93+
'PLW2901', # noisy and reassigning to the loop var is usually intentional
94+
'TRY002', # super noisy, and those exceptions are pretty exceptional anyway
95+
'TRY003', # super noisy and also useless w/ werkzeugs http exceptions
96+
'TRY300', # kind of strange in many cases
97+
'TRY301', # sometimes doing that is actually useful
98+
'TRY400', # not all exceptions need exception logging
99+
'PERF203', # noisy, false positives, and not applicable for 3.11+
100+
'FURB113', # less readable
101+
'FURB140', # less readable and actually slower in 3.12+
102+
]
103+
104+
extend-safe-fixes = [
105+
'RUF005', # we typically don't deal with objects overriding `__add__` ir `__radd__`
106+
'C4', # they seem pretty safe
107+
'UP008', # ^ likewise
108+
'D200', # ^ likewise
109+
'D400', # ^ likewise
110+
'PT014', # duplicate test case parametrizations are never intentional
111+
'RSE102', # we do not use `raise func()` (with `func` returning the exception instance)
112+
'RET504', # looks pretty safe
113+
'SIM110', # ^ likewise
114+
'PERF102', # ^ likewise
115+
]
116+
117+
[format]
118+
quote-style = 'single'
119+
120+
[lint.flake8-builtins]
121+
builtins-ignorelist = ['id', 'format', 'input', 'type', 'credits']
122+
123+
[lint.flake8-pytest-style]
124+
fixture-parentheses = false
125+
mark-parentheses = false
126+
parametrize-names-type = 'tuple'
127+
parametrize-values-type = 'tuple'
128+
parametrize-values-row-type = 'tuple'
129+
130+
[lint.flake8-quotes]
131+
inline-quotes = 'single'
132+
multiline-quotes = 'single'
133+
docstring-quotes = 'double'
134+
avoid-escape = true
135+
136+
[lint.pep8-naming]
137+
ignore-names = [
138+
'_process_GET',
139+
'_process_POST',
140+
'_process_PATCH',
141+
'_process_PUT',
142+
'_process_DELETE',
143+
]
144+
classmethod-decorators = [
145+
'classmethod',
146+
'declared_attr',
147+
'strict_classproperty',
148+
'expression',
149+
'comparator',
150+
]
151+
152+
[lint.pydocstyle]
153+
convention = 'pep257'
154+
155+
[lint.pylint]
156+
allow-dunder-method-names = [
157+
'__table_args__',
158+
'__tablename__',
159+
'__clause_element__',
160+
]
161+
162+
[lint.ruff]
163+
parenthesize-tuple-in-subscript = true
164+
165+
[lint.per-file-ignores]
166+
# allow stuff that's useful in tests
167+
'*/*_test.py' = ['E221', 'E241', 'E272', 'N802', 'S105', 'S106', 'PLC1901']
168+
# allow long lines in migrations (only do that for raw SQL please)
169+
'*/migrations/*.py' = ['E501', 'D400']

0 commit comments

Comments
 (0)
Please sign in to comment.