forked from realpython/reader
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathruff.toml
More file actions
63 lines (51 loc) · 1.87 KB
/
ruff.toml
File metadata and controls
63 lines (51 loc) · 1.87 KB
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
# Exclude a variety of commonly ignored directories.
exclude = [
"*/tests/*", #Test files. Style not important. Speed/correctness matters more
"config.sample.py", #Excludes sample config files
]
#Critical for Github Actions where we pass a list of files
force-exclude = true
line-length = 120
indent-width = 4
# Assume Python 3.10
target-version = "py310"
fix = true
[lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
# McCabe complexity (`C901`) by default.
select = ["ALL"]
ignore = [
"D100",
"D400",
"D415",
"D401", #Docstring imperative mood
"S311", #Insecure random functions. eg random.choice
"W", # New line warnings
"FBT", #Boolean trap linter
"EM", #error message linter
"TRY003", # no long messages in exception class
"E501", # Line length issue. Handled by vscode itself
"COM812", #Skip trailing comma check. Fights with vscode editor
"G004", # f string for logger
"RET502", #No implcit return None
"UP007", #Allow optional type annotation
"PGH", #When to ignore type annotations
]
# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
[format]
# # Like Black, indent with spaces, rather than tabs.
indent-style = "tab"
# Like Black, use double quotes for strings.
quote-style = "double"
# # Like Black, automatically detect the appropriate line ending.
line-ending = "auto"
# # Enable auto-formatting of code examples in docstrings. Markdown,
# # reStructuredText code/literal blocks and doctests are all supported.
# #
# # This is currently disabled by default, but it is planned for this
# # to be opt-out in the future.
docstring-code-format = true