valimp/ruff.toml at main · maread99/valimp · 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
# File as ruff default values except where noted via commented out default value.

# Exclude a variety of commonly ignored directories.
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",
]

# extend-exclude = []  # Default value
extend-exclude = ["*.ipynb", "src/valimp/_version.py"]

# Same as Black.
line-length = 88
indent-width = 4

# Assume Python 3.9
target-version = "py39"

[lint]
# 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]+?))$"

# 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 = ["E4", "E7", "E9", "F"]  # Default value
select = ["ALL"]
# ignore = []  # Default value
ignore = [
    "ANN",  # flake8-annotations. TODO: fix / tighten up ignore.
    "PT022",  # pytest-useless-yield-fixture. TODO: Review / Fix.
    "PLE0604",  # invalid-all-object. TODO: Review / Fix.
    "ERA001",  # commented-out-code.
    # Global wilful ignores...
    "COM812",  # missing-trailing-comma.  As recommended by ruff as conflicts with formatter.
    "TD002",  # missing-todo-author
    "TD003",  # missing-todo-issue
    "FIX002",  # line-contains-todo.  Ignore here to pass CI tests.
    "D105",  # undocumented-magic-method
    "PLR0913",  # too-many-arguments
    "PLR2044",  # empty-comment. Happy to have an empty line as a comment, can serve as a eseful separator.
    # Package-specific wilful ignores...
    "PLR0915",  # too-many-statements.
]

[lint.per-file-ignores]
"tests/**/*.py" = [
    "S101",  # assert
    "N802",  # invalid-function-name
    "N803",  # invalid-argument-name
    "N806",  # non-lowercase-variable-in-function
    "SLF001",  # private-member-access
    "PLR0912",  # too-many-branches
    "C901",  # complex-structure. Mccabe.
    "D103",  # undocumented-public-function
    "D401",  # non-imperative mood. Imperative mood not natural for fixtures.
    "C408",  # unnecessary-collection-call.  Prefer dict() when defining kwargs in tests.
    "FBT001",  # boolean-type-hint-position-argument.
    "FBT002",  # boolean-default-value-position-argument.
]

[lint.pydocstyle]
convention = "numpy"

[lint.flake8-annotations]
mypy-init-return = true

[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 = "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 = false

# 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"