python-checks 0.3.2__py3-none-any.whl → 0.4.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- py_checks/checks/_layout.py +239 -0
- py_checks/checks/_location.py +5 -38
- py_checks/checks/calls/_confined_functions.py +4 -4
- py_checks/checks/database/__init__.py +1 -2
- py_checks/checks/database/_bound_checks.py +23 -9
- py_checks/checks/database/_confined_calls.py +8 -5
- py_checks/checks/database/_model_boundary.py +49 -15
- py_checks/checks/database/_model_columns.py +10 -10
- py_checks/checks/database/_raw_sql.py +6 -6
- py_checks/checks/database/_statement_keys.py +3 -3
- py_checks/checks/effects/_determinism.py +6 -6
- py_checks/checks/imports/_confined.py +15 -7
- py_checks/checks/placement/__init__.py +16 -19
- py_checks/checks/placement/_class_modules.py +20 -45
- py_checks/checks/placement/_class_placement.py +28 -78
- py_checks/checks/placement/_operation_shape.py +51 -58
- py_checks/checks/placement/_required_class.py +13 -28
- py_checks/checks/signatures/_nesting.py +11 -3
- py_checks/checks/types/_confined_types.py +16 -4
- py_checks/cli/commands/__init__.py +2 -0
- py_checks/cli/commands/_doctor.py +293 -0
- py_checks/cli/commands/_explain.py +40 -4
- py_checks/config/__init__.py +2 -1
- py_checks/config/_base.py +8 -0
- py_checks/config/_config.py +34 -0
- py_checks/config/_loader.py +5 -1
- py_checks/core/__init__.py +6 -1
- py_checks/core/_paths.py +49 -0
- py_checks/core/_protocols.py +11 -0
- py_checks/core/_runner.py +3 -2
- {python_checks-0.3.2.dist-info → python_checks-0.4.2.dist-info}/METADATA +5 -3
- {python_checks-0.3.2.dist-info → python_checks-0.4.2.dist-info}/RECORD +35 -32
- {python_checks-0.3.2.dist-info → python_checks-0.4.2.dist-info}/WHEEL +0 -0
- {python_checks-0.3.2.dist-info → python_checks-0.4.2.dist-info}/entry_points.txt +0 -0
- {python_checks-0.3.2.dist-info → python_checks-0.4.2.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,293 @@
|
|
|
1
|
+
"""Команда `doctor`: что не так с самими настройками."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from collections.abc import Sized
|
|
6
|
+
from dataclasses import dataclass
|
|
7
|
+
from difflib import get_close_matches
|
|
8
|
+
from pathlib import Path
|
|
9
|
+
from typing import TYPE_CHECKING, Final
|
|
10
|
+
|
|
11
|
+
import typer
|
|
12
|
+
from rich.console import Console
|
|
13
|
+
|
|
14
|
+
from py_checks.config import ConfigError, find_root, load, prefix
|
|
15
|
+
from py_checks.contracts import SECTION as CONTRACTS
|
|
16
|
+
from py_checks.core import EXIT_OK, EXIT_VIOLATION, available, depth, section_of
|
|
17
|
+
from py_checks.environment import SECTION as ENV_EXAMPLE
|
|
18
|
+
|
|
19
|
+
if TYPE_CHECKING:
|
|
20
|
+
from collections.abc import Iterator
|
|
21
|
+
|
|
22
|
+
from py_checks.config import CheckSettings, Config, TomlValue
|
|
23
|
+
from py_checks.core import Check
|
|
24
|
+
|
|
25
|
+
# Секции, которые принадлежат не правилу, а сборщику файлов.
|
|
26
|
+
BUILDERS: Final[frozenset[str]] = frozenset({CONTRACTS, ENV_EXAMPLE})
|
|
27
|
+
|
|
28
|
+
# Ключ, называющий места: он есть у всех правил, которые работают не везде, и
|
|
29
|
+
# пустой список в нём означает, что правило молчит по всему дереву.
|
|
30
|
+
ZONES: Final = "zones"
|
|
31
|
+
|
|
32
|
+
# Сколько похожих имён предлагать в ответ на опечатку и насколько похожих:
|
|
33
|
+
# умолчание difflib (0.6) молчит там, где человек видит опечатку глазами.
|
|
34
|
+
CLOSE: Final = 2
|
|
35
|
+
ALIKE: Final = 0.5
|
|
36
|
+
|
|
37
|
+
SUFFIX: Final = ".py"
|
|
38
|
+
|
|
39
|
+
# Поле и причина: остальное в жалобе pydantic — служебное.
|
|
40
|
+
REASON: Final = 2
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
@dataclass(frozen=True, slots=True)
|
|
44
|
+
class Complaint:
|
|
45
|
+
"""Что не так и с чем именно."""
|
|
46
|
+
|
|
47
|
+
said: str
|
|
48
|
+
about: str
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
def doctor() -> None:
|
|
52
|
+
"""Проверить сами настройки: опечатки, мёртвые адреса, молчащие правила."""
|
|
53
|
+
config = load(root=find_root(start=Path.cwd()))
|
|
54
|
+
found = [
|
|
55
|
+
*_unknown(config=config),
|
|
56
|
+
*_ignored(config=config),
|
|
57
|
+
*_silent(config=config),
|
|
58
|
+
*_nowhere(config=config),
|
|
59
|
+
]
|
|
60
|
+
# Длинное имя не переносится посреди слова: читателю его копировать.
|
|
61
|
+
console = Console(soft_wrap=True)
|
|
62
|
+
console.print(f"{config.origin or 'настройки по умолчанию'}\n", markup=False)
|
|
63
|
+
for said, group in _grouped(found=found).items():
|
|
64
|
+
console.print(f" {said}", markup=False)
|
|
65
|
+
for complaint in group:
|
|
66
|
+
console.print(f" {complaint.about}", markup=False)
|
|
67
|
+
console.print()
|
|
68
|
+
console.print(_count(found=found), markup=False)
|
|
69
|
+
raise typer.Exit(code=EXIT_VIOLATION if found else EXIT_OK)
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
def _grouped(*, found: list[Complaint]) -> dict[str, list[Complaint]]:
|
|
73
|
+
"""Замечания по заголовкам, в порядке первого появления."""
|
|
74
|
+
groups: dict[str, list[Complaint]] = {}
|
|
75
|
+
for complaint in found:
|
|
76
|
+
groups.setdefault(complaint.said, []).append(complaint)
|
|
77
|
+
return groups
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
def _count(*, found: list[Complaint]) -> str:
|
|
81
|
+
return f"замечаний — {len(found)}" if found else "ok: настройки согласованы"
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
def _sections() -> set[str]:
|
|
85
|
+
"""Имена секций, которые кто-нибудь читает: у пяти правил оно общее."""
|
|
86
|
+
return {section_of(check=check) for check in available().listed.values()}
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
def _unknown(*, config: Config) -> Iterator[Complaint]:
|
|
90
|
+
"""Секция, которой не соответствует ни правило, ни сборщик."""
|
|
91
|
+
known = _sections()
|
|
92
|
+
named = prefix(source=config.origin)
|
|
93
|
+
for section in sorted(config.checks):
|
|
94
|
+
if section in known or section in BUILDERS:
|
|
95
|
+
continue
|
|
96
|
+
close = get_close_matches(
|
|
97
|
+
section,
|
|
98
|
+
[*known, *BUILDERS],
|
|
99
|
+
n=CLOSE,
|
|
100
|
+
cutoff=ALIKE,
|
|
101
|
+
)
|
|
102
|
+
said = f"; ближайшие: {', '.join(close)}" if close else ""
|
|
103
|
+
yield Complaint(
|
|
104
|
+
said="опечатка в имени секции",
|
|
105
|
+
about=f"[{named}{section}] — такой секции нет{said}",
|
|
106
|
+
)
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
def _ignored(*, config: Config) -> Iterator[Complaint]:
|
|
110
|
+
"""`ignore`, называющий правило, которого нет."""
|
|
111
|
+
codes = set(available().listed)
|
|
112
|
+
for code in config.ignore:
|
|
113
|
+
if code in codes:
|
|
114
|
+
continue
|
|
115
|
+
close = get_close_matches(
|
|
116
|
+
code,
|
|
117
|
+
sorted(codes),
|
|
118
|
+
n=CLOSE,
|
|
119
|
+
cutoff=ALIKE,
|
|
120
|
+
)
|
|
121
|
+
said = f"; ближайшие: {', '.join(close)}" if close else ""
|
|
122
|
+
yield Complaint(
|
|
123
|
+
said="ignore называет несуществующее",
|
|
124
|
+
about=f"{code!r} — такого правила нет{said}",
|
|
125
|
+
)
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
def _silent(*, config: Config) -> Iterator[Complaint]:
|
|
129
|
+
"""Правило, у которого секция есть, а сказать ей нечего.
|
|
130
|
+
|
|
131
|
+
Ноль нарушений в таком случае выглядит как соблюдённое соглашение, а
|
|
132
|
+
означает правило, которое ничего не проверяло. Пустая секция сама по себе
|
|
133
|
+
не беда: у половины правил умолчания рабочие, и `[raw-sql]` без единой
|
|
134
|
+
строки запрещает ровно то, ради чего написано.
|
|
135
|
+
"""
|
|
136
|
+
named = prefix(source=config.origin)
|
|
137
|
+
for code, check in sorted(available().listed.items()):
|
|
138
|
+
section = section_of(check=check)
|
|
139
|
+
if not config.enabled(code=code) or section not in config.checks:
|
|
140
|
+
continue
|
|
141
|
+
found = _mute(
|
|
142
|
+
config=config,
|
|
143
|
+
code=code,
|
|
144
|
+
check=check,
|
|
145
|
+
named=named,
|
|
146
|
+
)
|
|
147
|
+
if found is not None:
|
|
148
|
+
yield found
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
def _mute(
|
|
152
|
+
*,
|
|
153
|
+
config: Config,
|
|
154
|
+
code: str,
|
|
155
|
+
check: Check,
|
|
156
|
+
named: str,
|
|
157
|
+
) -> Complaint | None:
|
|
158
|
+
"""Чем именно эта секция ничего не говорит; `None` — говорит."""
|
|
159
|
+
section = section_of(check=check)
|
|
160
|
+
said = "правило включено, но молчит"
|
|
161
|
+
try:
|
|
162
|
+
settings = config.settings_for(
|
|
163
|
+
code=section,
|
|
164
|
+
model=check.Settings,
|
|
165
|
+
)
|
|
166
|
+
except ConfigError as error:
|
|
167
|
+
return Complaint(
|
|
168
|
+
said="секция не читается",
|
|
169
|
+
about=f"[{named}{section}] — {_first(said=str(error))}",
|
|
170
|
+
)
|
|
171
|
+
zones = getattr(settings, ZONES, None)
|
|
172
|
+
if zones is not None and not zones:
|
|
173
|
+
return Complaint(
|
|
174
|
+
said=said,
|
|
175
|
+
about=f"[{named}{code}] — зон не названо: судить негде",
|
|
176
|
+
)
|
|
177
|
+
if config.checks[section] or not _bare(model=check.Settings):
|
|
178
|
+
return None
|
|
179
|
+
return Complaint(
|
|
180
|
+
said=said,
|
|
181
|
+
about=f"[{named}{section}] — секция пуста, а умолчаний у правила нет",
|
|
182
|
+
)
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
def _first(*, said: str) -> str:
|
|
186
|
+
"""Суть чужой жалобы: поле и причина, без счётчика ошибок и ссылки.
|
|
187
|
+
|
|
188
|
+
pydantic пишет заголовок, потом поле, потом причину с типом и входным
|
|
189
|
+
значением. Читателю нужны второе и третье, и то короткой строкой.
|
|
190
|
+
"""
|
|
191
|
+
lines = [one.strip() for one in said.splitlines()[1:] if one.strip()]
|
|
192
|
+
return ": ".join(one.split(" [type=")[0] for one in lines[:REASON])
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
def _bare(*, model: type[CheckSettings]) -> bool:
|
|
196
|
+
"""Правда ли, что без таблицы у правила нет ничего.
|
|
197
|
+
|
|
198
|
+
У `module-length` умолчание — предел в строках, и пустая секция значит
|
|
199
|
+
«работай как написано в библиотеке». У `model-columns` умолчания пусты:
|
|
200
|
+
там пустая секция значит «ничего не проверяй».
|
|
201
|
+
"""
|
|
202
|
+
return all(
|
|
203
|
+
_nothing(value=field.get_default(call_default_factory=True))
|
|
204
|
+
for field in model.model_fields.values()
|
|
205
|
+
)
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
def _nothing(*, value: object) -> bool:
|
|
209
|
+
return value is None or value == "" or (isinstance(value, Sized) and not len(value))
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
def _nowhere(*, config: Config) -> Iterator[Complaint]:
|
|
213
|
+
"""Адрес, которому на диске ничего не соответствует.
|
|
214
|
+
|
|
215
|
+
Директорию переименовали, блок раскладки остался — и правило смотрит туда,
|
|
216
|
+
где давно ничего нет, продолжая молчать по этому поводу.
|
|
217
|
+
"""
|
|
218
|
+
places = _places(src=config.src)
|
|
219
|
+
if not places:
|
|
220
|
+
return
|
|
221
|
+
named = prefix(source=config.origin)
|
|
222
|
+
for section, address in sorted(_addressed(config=config)):
|
|
223
|
+
if any(
|
|
224
|
+
depth(
|
|
225
|
+
parts=parts,
|
|
226
|
+
path=address,
|
|
227
|
+
)
|
|
228
|
+
is not None
|
|
229
|
+
for parts in places
|
|
230
|
+
):
|
|
231
|
+
continue
|
|
232
|
+
yield Complaint(
|
|
233
|
+
said="адрес, которого нет на диске",
|
|
234
|
+
about=f"[{named}{section}] — {address!r} не нашлось в {config.src}",
|
|
235
|
+
)
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
def _addressed(*, config: Config) -> Iterator[tuple[str, str]]:
|
|
239
|
+
"""Адреса, написанные в настройках: блоки общей таблицы и списки зон.
|
|
240
|
+
|
|
241
|
+
Только эти два: остальные ключи — имена пакетов, типов, конструкций, и
|
|
242
|
+
отличить их от пути, не зная правила, нельзя. Зона внутри массива таблиц
|
|
243
|
+
(`[[confined-calls.rules]]`) — та же зона, поэтому шаг внутрь.
|
|
244
|
+
"""
|
|
245
|
+
shared = _shared()
|
|
246
|
+
for section, table in config.checks.items():
|
|
247
|
+
if section in BUILDERS:
|
|
248
|
+
continue
|
|
249
|
+
if section in shared:
|
|
250
|
+
yield from ((section, key) for key, value in table.items() if isinstance(value, dict))
|
|
251
|
+
for value in [table, *(one for one in table.values() if isinstance(one, list))]:
|
|
252
|
+
yield from ((section, one) for one in _zones(value=value))
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
def _zones(*, value: TomlValue) -> Iterator[str]:
|
|
256
|
+
"""Зоны таблицы — или зоны каждой таблицы в массиве."""
|
|
257
|
+
tables = value if isinstance(value, list) else [value]
|
|
258
|
+
for table in tables:
|
|
259
|
+
if not isinstance(table, dict):
|
|
260
|
+
continue
|
|
261
|
+
named = table.get(ZONES)
|
|
262
|
+
if isinstance(named, list):
|
|
263
|
+
yield from (one for one in named if isinstance(one, str))
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
def _shared() -> set[str]:
|
|
267
|
+
"""Секции, которые правило читает не под своим кодом: общая таблица."""
|
|
268
|
+
return {
|
|
269
|
+
section_of(check=check)
|
|
270
|
+
for check in available().listed.values()
|
|
271
|
+
if section_of(check=check) != check.code
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
def _places(*, src: Path) -> list[tuple[str, ...]]:
|
|
276
|
+
"""Куски пути каждой директории и каждого модуля под корнем исходников.
|
|
277
|
+
|
|
278
|
+
Модули считаются наравне с директориями: `exceptions` — это и папка, и
|
|
279
|
+
`exceptions.py`, и для словаря отказов это одно и то же место.
|
|
280
|
+
"""
|
|
281
|
+
if not src.is_dir():
|
|
282
|
+
return []
|
|
283
|
+
found = [
|
|
284
|
+
path.relative_to(src).with_suffix("").parts
|
|
285
|
+
for path in src.rglob("*")
|
|
286
|
+
if path.is_dir() or path.suffix == SUFFIX
|
|
287
|
+
]
|
|
288
|
+
# Первый кусок — корневой пакет, адреса же пишутся от него внутрь.
|
|
289
|
+
return [parts[1:] for parts in found if len(parts) > 1]
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
def register(*, app: typer.Typer) -> None:
|
|
293
|
+
app.command("doctor")(doctor)
|
|
@@ -2,13 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
import typing
|
|
6
|
+
from typing import Annotated, Final
|
|
6
7
|
|
|
7
8
|
import typer
|
|
9
|
+
from pydantic import BaseModel
|
|
8
10
|
from rich.console import Console
|
|
9
11
|
|
|
10
12
|
from py_checks.cli.commands._summary import docstring
|
|
11
|
-
from py_checks.core import get
|
|
13
|
+
from py_checks.core import get, section_of
|
|
14
|
+
|
|
15
|
+
EXTRA: Final = "__pydantic_extra__"
|
|
12
16
|
|
|
13
17
|
|
|
14
18
|
def explain( # check-ok: keyword-only-arguments: подпись команды разбирает typer
|
|
@@ -18,10 +22,42 @@ def explain( # check-ok: keyword-only-arguments: подпись команды
|
|
|
18
22
|
check = get(code=code)
|
|
19
23
|
console = Console()
|
|
20
24
|
console.print(docstring(check=check), markup=False)
|
|
21
|
-
|
|
22
|
-
|
|
25
|
+
section = section_of(check=check)
|
|
26
|
+
shared = " (общая)" if section != check.code else ""
|
|
27
|
+
console.print(f"\nнастройки, секция [{section}]{shared}:", markup=False)
|
|
28
|
+
fields = _fields(model=check.Settings)
|
|
29
|
+
for name, field in fields.items():
|
|
23
30
|
key = field.alias or name
|
|
24
31
|
console.print(f" {key} = {field.get_default(call_default_factory=True)!r}", markup=False)
|
|
32
|
+
if not fields:
|
|
33
|
+
console.print(f" <ключ проекта> = {_shape(model=check.Settings)}", markup=False)
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
def _fields(*, model: type[BaseModel]) -> dict[str, typing.Any]: # noqa: ANN401
|
|
37
|
+
"""Поля модели, а у таблицы с ключами проекта — поля одного её блока.
|
|
38
|
+
|
|
39
|
+
Секция, ключи которой приносит проект (адреса директорий, имена пакетов),
|
|
40
|
+
своих полей не имеет: объявлять там нечего, кроме того, из чего состоит
|
|
41
|
+
блок. Печатать пустой список значит сказать «настроек нет», а они есть.
|
|
42
|
+
"""
|
|
43
|
+
if model.model_fields:
|
|
44
|
+
return dict(model.model_fields)
|
|
45
|
+
inner = _value(model=model)
|
|
46
|
+
if isinstance(inner, type) and issubclass(inner, BaseModel):
|
|
47
|
+
return dict(inner.model_fields)
|
|
48
|
+
return {}
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
def _shape(*, model: type[BaseModel]) -> str:
|
|
52
|
+
"""Чем бывает значение под ключом проекта, когда это не блок, а список."""
|
|
53
|
+
inner = _value(model=model)
|
|
54
|
+
return inner.__name__ if isinstance(inner, type) else str(inner)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
def _value(*, model: type[BaseModel]) -> typing.Any: # noqa: ANN401
|
|
58
|
+
"""Тип значения в таблице, ключи которой приносит проект."""
|
|
59
|
+
values = typing.get_args(typing.get_type_hints(model).get(EXTRA))
|
|
60
|
+
return values[1] if len(values) == 2 else None # noqa: PLR2004 — ключ и значение
|
|
25
61
|
|
|
26
62
|
|
|
27
63
|
def register(*, app: typer.Typer) -> None:
|
py_checks/config/__init__.py
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
настройки падает сразу и с понятным текстом.
|
|
9
9
|
"""
|
|
10
10
|
|
|
11
|
-
from py_checks.config._base import CheckSettings
|
|
11
|
+
from py_checks.config._base import OPEN, CheckSettings
|
|
12
12
|
from py_checks.config._config import Config, prefix
|
|
13
13
|
from py_checks.config._constants import DEFAULT_EXCLUDE, PYPROJECT, SECTION, STANDALONE
|
|
14
14
|
from py_checks.config._errors import ConfigError
|
|
@@ -17,6 +17,7 @@ from py_checks.config._toml import TomlTable, TomlValue
|
|
|
17
17
|
|
|
18
18
|
__all__ = [
|
|
19
19
|
"DEFAULT_EXCLUDE",
|
|
20
|
+
"OPEN",
|
|
20
21
|
"PYPROJECT",
|
|
21
22
|
"SECTION",
|
|
22
23
|
"STANDALONE",
|
py_checks/config/_base.py
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
from __future__ import annotations
|
|
4
4
|
|
|
5
|
+
from typing import Final
|
|
6
|
+
|
|
5
7
|
from pydantic import BaseModel, ConfigDict
|
|
6
8
|
|
|
7
9
|
|
|
@@ -24,3 +26,9 @@ class CheckSettings(BaseModel):
|
|
|
24
26
|
extra="forbid",
|
|
25
27
|
frozen=True,
|
|
26
28
|
)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
# Таблица, ключи которой приносит проект: имя директории, пакета, конструкции.
|
|
32
|
+
# Такое имя — данные, а не поле модели, поэтому `extra` открыт, но значение под
|
|
33
|
+
# ним проверяется: модель объявляет `__pydantic_extra__` своим типом.
|
|
34
|
+
OPEN: Final[ConfigDict] = CheckSettings.model_config | {"extra": "allow"}
|
py_checks/config/_config.py
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
from __future__ import annotations
|
|
4
4
|
|
|
5
5
|
from pathlib import Path
|
|
6
|
+
from typing import TYPE_CHECKING, Final
|
|
6
7
|
|
|
7
8
|
from pydantic import Field, ValidationError
|
|
8
9
|
|
|
@@ -11,6 +12,39 @@ from py_checks.config._constants import DEFAULT_EXCLUDE, PYPROJECT, SECTION
|
|
|
11
12
|
from py_checks.config._errors import ConfigError
|
|
12
13
|
from py_checks.config._toml import TomlTable
|
|
13
14
|
|
|
15
|
+
if TYPE_CHECKING:
|
|
16
|
+
from collections.abc import Mapping
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
# Секции, которые больше не читаются: четыре правила про раскладку говорили об
|
|
20
|
+
# одной и той же директории с четырёх сторон, и один факт приходилось писать
|
|
21
|
+
# четыре раза. Молчать о них нельзя — незнакомая секция выглядит как
|
|
22
|
+
# работающая настройка, а на деле правило судит по пустой таблице.
|
|
23
|
+
RETIRED: Final[dict[str, str]] = {
|
|
24
|
+
"class-modules": "`only`",
|
|
25
|
+
"class-placement": "`home` и `suffix`",
|
|
26
|
+
"required-class": "`required` рядом с `suffix`",
|
|
27
|
+
"operation-shape": "`operation`",
|
|
28
|
+
"model-boundary": "`orm` и `base`",
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def retired(
|
|
33
|
+
*,
|
|
34
|
+
checks: Mapping[str, object],
|
|
35
|
+
source: Path | None,
|
|
36
|
+
) -> None:
|
|
37
|
+
"""Падает, если в настройках остались секции, которые слились в `[layout]`."""
|
|
38
|
+
found = [name for name in RETIRED if name in checks]
|
|
39
|
+
if not found:
|
|
40
|
+
return
|
|
41
|
+
named = prefix(source=source)
|
|
42
|
+
listed = ", ".join(f"[{named}{name}] -> {RETIRED[name]}" for name in sorted(found))
|
|
43
|
+
raise ConfigError(
|
|
44
|
+
f"эти секции слились в общую таблицу [{named}layout], блок на директорию: "
|
|
45
|
+
f"{listed}. Одна директория — один блок, а не четыре строки в четырёх таблицах"
|
|
46
|
+
)
|
|
47
|
+
|
|
14
48
|
|
|
15
49
|
def prefix(*, source: Path | None) -> str:
|
|
16
50
|
"""Как называется секция проверки в том файле, откуда пришли настройки.
|
py_checks/config/_loader.py
CHANGED
|
@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING, Final
|
|
|
7
7
|
|
|
8
8
|
from pydantic import ValidationError
|
|
9
9
|
|
|
10
|
-
from py_checks.config._config import Config, prefix
|
|
10
|
+
from py_checks.config._config import Config, prefix, retired
|
|
11
11
|
from py_checks.config._constants import PYPROJECT, SECTION, STANDALONE
|
|
12
12
|
from py_checks.config._errors import ConfigError
|
|
13
13
|
|
|
@@ -97,6 +97,10 @@ def _build(
|
|
|
97
97
|
source: Path,
|
|
98
98
|
) -> Config:
|
|
99
99
|
own, checks = _split(section=section)
|
|
100
|
+
retired(
|
|
101
|
+
checks=checks,
|
|
102
|
+
source=source,
|
|
103
|
+
)
|
|
100
104
|
named = prefix(source=source)
|
|
101
105
|
# В своём файле секции нет — называть в сообщении нечего, кроме файла.
|
|
102
106
|
where = f" [{named.rstrip('.')}]" if named else ""
|
py_checks/core/__init__.py
CHANGED
|
@@ -12,7 +12,8 @@ from py_checks.core._errors import ParseError, UnknownCheckError
|
|
|
12
12
|
from py_checks.core._fixer import fix
|
|
13
13
|
from py_checks.core._format import reformat
|
|
14
14
|
from py_checks.core._markers import MARKER, Marker, complaints, markers, surviving
|
|
15
|
-
from py_checks.core.
|
|
15
|
+
from py_checks.core._paths import ANY, SEPARATOR, depth
|
|
16
|
+
from py_checks.core._protocols import Check, FileCheck, ProjectCheck, Scope, section_of
|
|
16
17
|
from py_checks.core._registry import Checks, available, get
|
|
17
18
|
from py_checks.core._report import report
|
|
18
19
|
from py_checks.core._runner import SYNTAX, examine, inspect, survey
|
|
@@ -38,10 +39,13 @@ __all__ = [
|
|
|
38
39
|
"SettingsMismatchError",
|
|
39
40
|
"UnknownCheckError",
|
|
40
41
|
"Violation",
|
|
42
|
+
"ANY",
|
|
43
|
+
"SEPARATOR",
|
|
41
44
|
"apply",
|
|
42
45
|
"available",
|
|
43
46
|
"column",
|
|
44
47
|
"complaints",
|
|
48
|
+
"depth",
|
|
45
49
|
"examine",
|
|
46
50
|
"fix",
|
|
47
51
|
"get",
|
|
@@ -50,6 +54,7 @@ __all__ = [
|
|
|
50
54
|
"python_files",
|
|
51
55
|
"reformat",
|
|
52
56
|
"report",
|
|
57
|
+
"section_of",
|
|
53
58
|
"settings_as",
|
|
54
59
|
"survey",
|
|
55
60
|
"surviving",
|
py_checks/core/_paths.py
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"""Совпадение адреса с путём.
|
|
2
|
+
|
|
3
|
+
Адрес в настройках — не префикс и не имя директории, а подряд идущие куски
|
|
4
|
+
пути: `application/use_cases` находится и внутри `modules/<имя>/`. Правила
|
|
5
|
+
спрашивают этим, лежит ли файл в названном месте; команда `doctor` — тем же
|
|
6
|
+
самым, существует ли вообще директория, о которой говорит настройка. Вопрос
|
|
7
|
+
один, значит и ответчик один: два похожих сравнения разъехались бы, и `doctor`
|
|
8
|
+
успокаивал бы насчёт адреса, мимо которого правило проходит.
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
from __future__ import annotations
|
|
12
|
+
|
|
13
|
+
from typing import Final
|
|
14
|
+
|
|
15
|
+
SEPARATOR: Final = "/"
|
|
16
|
+
|
|
17
|
+
# Один любой кусок пути: `modules/*/domain` — домен любого модуля.
|
|
18
|
+
ANY: Final = "*"
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def depth(
|
|
22
|
+
*,
|
|
23
|
+
parts: tuple[str, ...],
|
|
24
|
+
path: str,
|
|
25
|
+
) -> int | None:
|
|
26
|
+
"""Конец последнего вхождения подряд идущих кусков пути, или `None`.
|
|
27
|
+
|
|
28
|
+
Конец, а не начало: сравнивать вложенность двух адресов разной длины можно
|
|
29
|
+
только по тому, где они кончаются, — глубже тот, кто кончается позже.
|
|
30
|
+
"""
|
|
31
|
+
needle = tuple(path.split(SEPARATOR))
|
|
32
|
+
span = len(needle)
|
|
33
|
+
ends = [
|
|
34
|
+
start + span
|
|
35
|
+
for start in range(len(parts) - span + 1)
|
|
36
|
+
if _same(
|
|
37
|
+
found=parts[start : start + span],
|
|
38
|
+
needle=needle,
|
|
39
|
+
)
|
|
40
|
+
]
|
|
41
|
+
return max(ends) if ends else None
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
def _same(
|
|
45
|
+
*,
|
|
46
|
+
found: tuple[str, ...],
|
|
47
|
+
needle: tuple[str, ...],
|
|
48
|
+
) -> bool:
|
|
49
|
+
return all(wanted in (ANY, part) for part, wanted in zip(found, needle, strict=True))
|
py_checks/core/_protocols.py
CHANGED
|
@@ -86,3 +86,14 @@ class ProjectCheck(Protocol):
|
|
|
86
86
|
# Правило — это одно из двух: судящее файл или судящее проект. Там, где важно
|
|
87
87
|
# лишь то, что у него есть код и описание (список, объяснение), годится любое.
|
|
88
88
|
type Check = FileCheck | ProjectCheck
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
def section_of(*, check: Check) -> str:
|
|
92
|
+
"""Секция настроек правила: его код, если правило не сказало иначе.
|
|
93
|
+
|
|
94
|
+
Иначе говорят правила про раскладку: четыре из них читают одну таблицу
|
|
95
|
+
`[layout]`, потому что описывают одну и ту же директорию с четырёх сторон,
|
|
96
|
+
и четыре таблицы об одном разъезжались бы между собой. Друг о друге они
|
|
97
|
+
при этом не знают — знают только, из какой секции читать.
|
|
98
|
+
"""
|
|
99
|
+
return getattr(check, "section", check.code)
|
py_checks/core/_runner.py
CHANGED
|
@@ -8,6 +8,7 @@ from typing import TYPE_CHECKING, Final
|
|
|
8
8
|
from py_checks.core import _registry
|
|
9
9
|
from py_checks.core._errors import ParseError
|
|
10
10
|
from py_checks.core._markers import complaints, surviving
|
|
11
|
+
from py_checks.core._protocols import section_of
|
|
11
12
|
from py_checks.core._source import ParsedFile
|
|
12
13
|
from py_checks.core._violation import Violation
|
|
13
14
|
|
|
@@ -64,7 +65,7 @@ def inspect(
|
|
|
64
65
|
"""
|
|
65
66
|
settings = {
|
|
66
67
|
check.code: config.settings_for(
|
|
67
|
-
code=check
|
|
68
|
+
code=section_of(check=check),
|
|
68
69
|
model=check.Settings,
|
|
69
70
|
)
|
|
70
71
|
for check in checks
|
|
@@ -104,7 +105,7 @@ def examine(
|
|
|
104
105
|
for violation in check.run(
|
|
105
106
|
root=root,
|
|
106
107
|
settings=config.settings_for(
|
|
107
|
-
code=check
|
|
108
|
+
code=section_of(check=check),
|
|
108
109
|
model=check.Settings,
|
|
109
110
|
),
|
|
110
111
|
)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: python-checks
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.4.2
|
|
4
4
|
Summary: Проверки архитектурных соглашений проекта
|
|
5
5
|
Author: Armontex
|
|
6
6
|
Author-email: Armontex <windle1337@gmail.com>
|
|
@@ -106,11 +106,11 @@ max-lines = 300
|
|
|
106
106
|
# Rules that depend on place only work in the zones you name.
|
|
107
107
|
[model-columns]
|
|
108
108
|
zones = ["infra/database/models"]
|
|
109
|
-
|
|
109
|
+
instead = { Float = "a Float column drifts; state is exact, use Numeric" }
|
|
110
110
|
|
|
111
111
|
[determinism]
|
|
112
112
|
zones = ["modules/*/domain", "modules/*/application"]
|
|
113
|
-
|
|
113
|
+
instead = { "datetime.now" = "take the clock as a port", "uuid4" = "hand the id out at the edge" }
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
and run:
|
|
@@ -120,6 +120,7 @@ py-checks run # check `src`
|
|
|
120
120
|
py-checks run --fix # and repair what repairs itself
|
|
121
121
|
py-checks list # which rules exist and which are on
|
|
122
122
|
py-checks explain determinism # what a rule asks for and what it can be told
|
|
123
|
+
py-checks doctor # and whether the config itself holds together
|
|
123
124
|
```
|
|
124
125
|
|
|
125
126
|
The settings can also live in a `[tool.py-checks]` section of
|
|
@@ -347,6 +348,7 @@ obeys `ignore`, and is lifted by a mark.
|
|
|
347
348
|
| `py-checks list` | every rule: code, state, one line of description |
|
|
348
349
|
| `py-checks explain <code>` | what a rule asks for and what it can be told |
|
|
349
350
|
| `py-checks sync [--check]` | build the import contracts and `.env.example` |
|
|
351
|
+
| `py-checks doctor` | check the config itself: typos, dead addresses, rules that say nothing |
|
|
350
352
|
|
|
351
353
|
## Development
|
|
352
354
|
|