-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathruff.toml
165 lines (156 loc) · 7.34 KB
/
ruff.toml
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
exclude = [
".git",
".venv",
"dist",
"*cache",
"**/__pycache__",
"src/folder_to_be_excluded",
]
src = [
"farn",
"importSystemStructure",
"ospCaseBuilder",
]
line-length = 120
target-version = "py310"
[lint]
# Settings for Ruff linter (invoked with `uv run ruff check`).
# Start by including _all_ Ruff lint rules, then ignore selected rules as needed
# https://docs.astral.sh/ruff/rules/
select = [
"ALL",
]
ignore = [
# Ruff lint rules temporarily ignored, but which should be reactivated and resolved in the future.
"E501", # Line length too long
"D100", # Missing docstring in public module
"D104", # Missing docstring in public package
"D105", # Missing docstring in magic method
"D107", # Missing docstring in __init__
"D202", # No blank lines allowed after function docstring
"D203", # 1 blank line required before class docstring
"D205", # 1 blank line required between summary line and description
"D212", # Multi-line docstring summary should start at the first line
"D213", # Multi-line docstring summary should start at the second line
"N999", # Invalid module name
# Ruff lint rules considered as too strict and hence ignored
"FIX002", # Line contains TODO, consider resolving the issue
"TD003", # Missing issue link on the line following a TODO
"S101", # Use of assert detected
"RET504", # Unnecessary assignment to `result` before `return` statement
"EM101", # Exception must not use a string literal, assign to variable first
"EM102", # Exception must not use an f-string literal, assign to variable first
"TRY003", # Avoid specifying long messages outside the exception class
"PLR1711", # Useless `return` statement at end of function
"G00", # Logging statement uses string formatting ('G00' covers all rules flagging string formatting in logging, e.g. G001, G002, etc.)
"S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
"PLW0603", # Using the global statement to update {name} is discouraged
"PYI041", # Use `float` instead of `int | float`
# Ruff lint rules recommended to keep enabled,
# but which are typical candidates you might have a need to ignore,
# especially in the beginning or when refactoring an existing codebase,
# to avoid too many Ruff errors at once.
# -> Listed here for easy access and reference.
# (uncomment to ignore)
# "N803", # Argument name should be lowercase (NOTE: ignore to allow capital arguments (e.g X) in scientific code)
# "N806", # Variable in function should be lowercase (NOTE: ignore to allow capital variables (e.g X) in scientific code)
# "TC002", # Move third-party import into a type-checking block
# "TC003", # Move standard library import into a type-checking block
# Ruff lint rules known to be in conflict with Ruff formatter.
# https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
"W191", # Tab-indentation (in conflict with Ruff formatter)
"E111", # Indentation with invalid multiple (in conflict with Ruff formatter)
"E114", # Indentation with invalid multiple comment (in conflict with Ruff formatter)
"E117", # Over-indented (in conflict with Ruff formatter)
"D206", # Indent with spaces (in conflict with Ruff formatter)
"D300", # Triple single quotes (in conflict with Ruff formatter)
"Q000", # Bad quotes in inline string (in conflict with Ruff formatter)
"Q001", # Bad quotes in multi-line string (in conflict with Ruff formatter)
"Q002", # Bad quotes in DocString (in conflict with Ruff formatter)
"Q003", # Avoidable escaped quote (in conflict with Ruff formatter)
"COM812", # Missing trailing comma (in conflict with Ruff formatter)
"COM819", # Prohibited trailing comma (in conflict with Ruff formatter)
"ISC001", # Single-line implicit string concatenation (in conflict with Ruff formatter)
"ISC002", # Multi-line implicit string concatenation (in conflict with Ruff formatter)
]
# File patterns to be excluded from Ruff lint
# (only needed for file patterns not already listed in the common `exclude` setting
# at top of this file, i.e. list here _additional_ excludes specific to Ruff lint.)
exclude = [
]
allowed-confusables = [
"×", # used as dim multiplication sign in comments, such as `19×16×15×16×8×6×3 = 10,506,240 possible combinations of parameters`.
]
[lint.pep8-naming]
ignore-names = [
"test_*",
]
[lint.pylint]
max-args = 7
[lint.flake8-pytest-style]
raises-require-match-for = [
"BaseException",
"Exception",
"OSError",
"IOError",
"EnvironmentError",
"socket.error",
]
[lint.per-file-ignores]
# `__init__.py` specific ignores
"__init__.py" = [
"F401", # {name} imported but unused (NOTE: ignored as imports in `__init__.py` files are almost never used inside the module, but are intended for namespaces)
"I001", # Import block is un-sorted or un-formatted
"PLC0414", # Import alias does not rename original package
]
# `tests` specific ignores
"tests/**/*" = [
"D", # Missing docstrings
"ERA001", # Found commented-out code
"PT006", # Wrong type passed to first argument of `@pytest.mark.parametrize` (NOTE: ignored to allow parameters args as "args_1,arg_2,arg_3,..."
"S101", # Use of assert detected
"PLR2004", # Magic value used in comparison
"ANN201", # Missing return type annotation for public function
"ANN202", # Missing return type annotation for private function
"ARG001", # Unused function argument: {name}
"ARG002", # Unused method argument: {name}
"INP001", # File is part of an implicit namespace package. Add an `__init__.py`. (NOTE: tests are not intended to be a module, __init__.py hence not required.)
"SLF001", # Private member accessed
"TRY004", # Prefer `TypeError` exception for invalid type
]
# `stubs` specific ignores
"stubs/**/*" = [
"D", # Missing docstrings
"ERA001", # Found commented-out code
"SLF001", # Private member accessed
"F405", # {name} may be undefined, or defined from star imports: {module}
"F403", # from {name} import * used; unable to detect undefined names
"ANN", # Missing type annotation
"N", # Naming violations
"A001", # Variable {name} is shadowing a Python builtin
"A002", # Argument {name} is shadowing a Python builtin
"FBT001", # Boolean-typed positional argument in function definition
"PYI042", # Type alias {name} should be CamelCase
"PYI002", # complex if statement in stub
"PLR0913", # Too many arguments in function definition
]
# Jupyter notebook specific ignores
"**/*.ipynb" = [
"D103", # Missing docstring in public function
"T201", # `print` found
"PGH003", # Use specific rule codes when ignoring type issues
"TCH002", # Move third-party import into a type-checking block
]
# `demos` specific ignores
"demos/**/*" = [
"D", # Missing docstrings
"S101", # Use of assert detected
"PLR2004", # Magic value used in comparison
"INP001", # File is part of an implicit namespace package. Add an `__init__.py`. (NOTE: tutorials are not intended to be a module, __init__.py hence not required.)
"T201", # `print` found
"E402", # Module level import not at top of cell
]
[lint.pydocstyle]
convention = "numpy"
[format]
docstring-code-format = true