open-inwoner/pyproject.toml at develop · maykinmedia/open-inwoner · 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
[project]
name = "open-inwoner"
version = "2.0.0-dev"
requires-python = "== 3.12"

[tool.uv.pip]
# Note: setuptools is NOT excluded because it must be explicitly installed
# to ensure pkg_resources is available for legacy dependencies (django-axes,
# django-formtools). See requirements/base.in for setuptools<81 pin.
no-emit-package = [
  "pip",
]

[tool.ruff]
# 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",
    "env",

    # Django specific
    "static",
    "media",
    "env",

    # Project specific
    "src/open_inwoner/conf/local.py",
    "performance-tests",
    "bootstrap.py",
    "bin",
    "docs"
]

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

# Assume Python 3.12
target-version = "py312"

[tool.ruff.lint]
select = [
    # https://docs.astral.sh/ruff/rules/#error-e
    "E",
    # https://docs.astral.sh/ruff/rules/#pyflakes-f
    "F",
    # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
    "SIM",
    # https://docs.astral.sh/ruff/rules/#perflint-perf
    "PERF",
    # https://docs.astral.sh/ruff/rules/#refurb-furb
    "FURB",
    # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
    "B006",
    "B010",
    "B904",
    # https://docs.astral.sh/ruff/rules/#pep8-naming-n
    "N",
    # https://docs.astral.sh/ruff/rules/#isort-i
    "I",
    # https://docs.astral.sh/ruff/rules/#flake8-bandit-s
    "S",
    # https://docs.astral.sh/ruff/rules/#flake8-print-t20
    "T20",
    # https://docs.astral.sh/ruff/rules/#flake8-tidy-imports-tid
    "TID",
]
ignore = [
    # Whitespace before ':' (conflicts with Black)
    "E203",
    # Two spaces before inline comment
    "E261",
    # Line too long
    "E501",
    # Do not assign a lambda expression
    "E731",
    # Name may be undefined from '*' import
    "F405",
    # Local variable is assigned but never used
    "F841",
    # Ambiguous variable name
    "E741",
    # Use a single `with` statement with multiple contexts instead of nested `with` statements
    "SIM117",
    # Checks for nested if statements that can be collapsed into a single if statement.
    "SIM102",
    # Variables in function scope should be lower-case
    "N806",
    # Variables in class scope should not be mixed-case
    "N815",
    # Exception name should be named with Error suffix
    "N818",
    # Checks for uses of the Python requests or httpx module that omit the timeout parameter.
    "S113"
]

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

# Ad hoc exceptions
[tool.ruff.lint.pep8-naming]
ignore-names = [
    # N801
    "eHerkenning*",
    "eSuite*",
    "BRP_[0-9]_[0-9]",
    # N802
    "*setUp*",
    "tearDown*",
    "*assert*",
    "*TimelineLog*",
    "innNnpId",
]

[tool.ruff.lint.per-file-ignores]
# Ignore security rules in test files
"**/test_*.py" = ["S"]
"**/tests/**/*.py" = ["S"]

# Import sorting configuration (equivalent to isort)
[tool.ruff.lint.isort]
combine-as-imports = true
force-wrap-aliases = false
known-first-party = ["open_inwoner"]
lines-after-imports = -1
relative-imports-order = "furthest-to-closest"
sections = { django = ["django"] }
section-order = [
    "future",
    "standard-library",
    "django",
    "third-party",
    "first-party",
    "local-folder",
]

[tool.ruff.lint.flake8-tidy-imports]
# Disallow relative imports from parents, but allow from siblings
ban-relative-imports = "parents"

[tool.ruff.format]
line-ending = "lf"

[tool.ruff.lint.flake8-tidy-imports.banned-api]
"logging".msg = "Use `structlog.get_logger(__name__)` instead of the stdlib logging module."