scinexus/ruff.toml at main · cogent3/scinexus · 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
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
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".vscode",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "site-packages",
    "venv",
    "working",
]
extend-exclude = ["rtd_get_docs.py"]

line-length = 88
indent-width = 4

target-version = "py311"

[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"]
# ICN001 not adhering to numpy as np convention due to
# name collision, where np is used as num params
# N801 CamelCase is not always appropriate
# PLR0913 number of arguments sometimes needs to be > 5
# FBT001 and FBT002, positional boolean arguments are allowed!
# PT011, I disagree about checking error messages as well
# as exception types as it doubles the "cost" of fixing typos
ignore = [
    "COM812",
    "EXE002",
    "FA100",
    "E501",
    "D",
    "N801",
    "ICN001",
    "PLR0913",
    "FBT001",
    "FBT002",
    "PT011",
    "S311",    # Allow use of random
    "S608",    # sql injection unlikely
    "PLR2004", # Magic number usage where appropriate
    "PLC0415", # Allow delayed imports
]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"


[lint.per-file-ignores]
"tests/**/*.py" = [
    "S101",   # asserts allowed in tests...
    "INP001", # __init__.py files are not required...
    "ANN",
    "N802",
    "N803",
    "S301",   # we allow pickling / unpickling in tests
    "SLF001", # Allow accessing private attrs
]
"noxfile.py" = [
    "S101",   # asserts allowed in tests...
    "INP001", # __init__.py files are not required...
    "ANN",
    "N802",
    "N803",
]
"src/scinexus/composable.py" = [
    "ANN401", # Allow use of Any
]
"src/scinexus/deserialise.py" = [
    "ANN401", # Allow use of Any
]
"src/scinexus/data_store.py" = [
    "ANN401", # Allow use of Any
    "SLF001", # Allow accessing private attrs
]
"src/scinexus/io_util.py" = [
    "ANN401", # Allow use of Any
]
"src/scinexus/misc.py" = [
    "ANN401", # Allow use of Any
]
"src/scinexus/io.py" = [
    "ANN401", # Allow use of Any for generic serialisation apps
]
"src/scinexus/arallel.py" = [
    "ANN401", # Allow use of Any for generic serialisation apps
]
"src/scinexus/progress.py" = [
    "ANN401", # Allow use of Any for generic serialisation apps
    "SLF001", # Allow accessing private attrs
]
"src/scinexus/typing.py" = [
    "ANN401", # Allow use of Any
]

[format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "lf"
docstring-code-format = true

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"