python-checks 0.3.1__py3-none-any.whl → 0.4.1__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 +219 -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 +24 -79
- 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.4.1.dist-info/METADATA +372 -0
- {python_checks-0.3.1.dist-info → python_checks-0.4.1.dist-info}/RECORD +35 -32
- python_checks-0.3.1.dist-info/METADATA +0 -347
- {python_checks-0.3.1.dist-info → python_checks-0.4.1.dist-info}/WHEEL +0 -0
- {python_checks-0.3.1.dist-info → python_checks-0.4.1.dist-info}/entry_points.txt +0 -0
- {python_checks-0.3.1.dist-info → python_checks-0.4.1.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
"""Раскладка проекта: один блок на директорию.
|
|
2
|
+
|
|
3
|
+
Четыре правила говорят об одной и той же вещи с четырёх сторон: что здесь
|
|
4
|
+
может лежать (`class-modules`), что живёт только здесь (`class-placement`),
|
|
5
|
+
что модуль обязан объявить (`required-class`) и какой формы тут операция
|
|
6
|
+
(`operation-shape`). Раньше у каждого была своя таблица, и один факт про
|
|
7
|
+
`use_cases` приходилось писать четыре раза в четырёх синтаксисах, склеивая их
|
|
8
|
+
глазами по строковому ключу.
|
|
9
|
+
|
|
10
|
+
Теперь блок один на директорию, а правила читают из него свои колонки:
|
|
11
|
+
|
|
12
|
+
```toml
|
|
13
|
+
[layout."application/use_cases"]
|
|
14
|
+
only = ["class"]
|
|
15
|
+
suffix = "UseCase"
|
|
16
|
+
required = true
|
|
17
|
+
operation = { method = "execute", max-arguments = 3 }
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Правила при этом друг о друге по-прежнему не знают — они просто читают одну
|
|
21
|
+
таблицу. Адрес в заголовке ищется подряд идущими кусками пути, поэтому
|
|
22
|
+
`application/use_cases` находится и в модульном сервисе, где путь начинается
|
|
23
|
+
с `modules/<имя>/`, а `*` подходит любому одному куску.
|
|
24
|
+
"""
|
|
25
|
+
|
|
26
|
+
from __future__ import annotations
|
|
27
|
+
|
|
28
|
+
from dataclasses import dataclass
|
|
29
|
+
from enum import StrEnum
|
|
30
|
+
from typing import TYPE_CHECKING, Final, Self
|
|
31
|
+
|
|
32
|
+
from pydantic import Field, model_validator
|
|
33
|
+
|
|
34
|
+
from py_checks.checks._kind import Kind
|
|
35
|
+
from py_checks.config import CheckSettings
|
|
36
|
+
|
|
37
|
+
if TYPE_CHECKING:
|
|
38
|
+
from collections.abc import Iterable
|
|
39
|
+
|
|
40
|
+
from py_checks.checks._kind import Declaration
|
|
41
|
+
from py_checks.checks._location import Place
|
|
42
|
+
|
|
43
|
+
SECTION: Final = "layout"
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
class Orm(StrEnum):
|
|
47
|
+
"""Чем директория приходится ORM-модели.
|
|
48
|
+
|
|
49
|
+
Дом модели и место, где её собирают, — два конца одного соглашения, и
|
|
50
|
+
писать их в отдельной таблице значило бы назвать те же две директории
|
|
51
|
+
второй раз: раскладка уже знает их по имени.
|
|
52
|
+
"""
|
|
53
|
+
|
|
54
|
+
# Здесь модели объявляют: где-то ещё это таблица, которую никто не ждёт по
|
|
55
|
+
# этому адресу, а autogenerate alembic видит только их пакет.
|
|
56
|
+
DECLARED = "declared"
|
|
57
|
+
|
|
58
|
+
# Здесь модели собирают: собрать модель — значит записать строку.
|
|
59
|
+
BUILT = "built"
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
class Operation(CheckSettings):
|
|
63
|
+
"""Форма операции, которую держат в этой директории.
|
|
64
|
+
|
|
65
|
+
`method` — единственная публичная дверь: сценарий просят об одном деле, и
|
|
66
|
+
второй публичный метод означает вторую операцию, поделившую с первой
|
|
67
|
+
конструктор. Пусто — значит число дверей не ограничено: у сервиса модуля
|
|
68
|
+
их столько, сколько переходов у его сущности.
|
|
69
|
+
|
|
70
|
+
`forbids` — имена типов, которых операция не держит: `UnitOfWork` ловится
|
|
71
|
+
и как `IPlacementUnitOfWork`, и как `UnitOfWorkFactory`, потому что
|
|
72
|
+
запрещено держать транзакцию, а не писать её имя одним конкретным образом.
|
|
73
|
+
|
|
74
|
+
`max_arguments` — сколько аргументов занимает вход. Дверь несёт то, что
|
|
75
|
+
пришло снаружи, и вход длиннее нескольких полей — вещь с именем: команда,
|
|
76
|
+
запрос, DTO.
|
|
77
|
+
"""
|
|
78
|
+
|
|
79
|
+
method: str | None = None
|
|
80
|
+
forbids: tuple[str, ...] = ()
|
|
81
|
+
max_arguments: int | None = Field(
|
|
82
|
+
default=None,
|
|
83
|
+
gt=0,
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
class Directory(CheckSettings):
|
|
88
|
+
"""Что проект держит в этой директории.
|
|
89
|
+
|
|
90
|
+
`only` — виды, которым здесь место, и ничего другого рядом не садится.
|
|
91
|
+
`home` — виды, которым место ТОЛЬКО здесь: порт, объявленный в другом
|
|
92
|
+
конце дерева, — это порт, которого читатель не найдёт.
|
|
93
|
+
`suffix` — как зовут класс, ради которого директория существует; он же
|
|
94
|
+
живёт только здесь.
|
|
95
|
+
`required` — модуль обязан объявить такой класс, первым и один.
|
|
96
|
+
`operation` — форма операции, если здесь держат операции.
|
|
97
|
+
`orm` — чем директория приходится ORM-модели: домом или местом сборки.
|
|
98
|
+
`base` — базовый класс, по которому модель узнают в доме моделей.
|
|
99
|
+
"""
|
|
100
|
+
|
|
101
|
+
only: tuple[Kind, ...] = ()
|
|
102
|
+
home: tuple[Kind, ...] = ()
|
|
103
|
+
suffix: str | None = None
|
|
104
|
+
required: bool = False
|
|
105
|
+
operation: Operation | None = None
|
|
106
|
+
orm: Orm | None = None
|
|
107
|
+
base: str | None = None
|
|
108
|
+
|
|
109
|
+
@model_validator(mode="after")
|
|
110
|
+
def _named(self) -> Self:
|
|
111
|
+
"""Обязанность и форма опираются на имя: без суффикса их не проверить."""
|
|
112
|
+
if self.suffix is not None:
|
|
113
|
+
return self
|
|
114
|
+
if self.required:
|
|
115
|
+
message = "`required` без `suffix`: непонятно, какой класс обязан быть"
|
|
116
|
+
raise ValueError(message)
|
|
117
|
+
if self.operation is not None:
|
|
118
|
+
message = "`operation` без `suffix`: непонятно, какой класс здесь операция"
|
|
119
|
+
raise ValueError(message)
|
|
120
|
+
return self
|
|
121
|
+
|
|
122
|
+
@model_validator(mode="after")
|
|
123
|
+
def _declares(self) -> Self:
|
|
124
|
+
"""`base` — про дом моделей: в месте сборки узнавать по базе нечего."""
|
|
125
|
+
if self.base is not None and self.orm is not Orm.DECLARED:
|
|
126
|
+
message = '`base` без `orm = "declared"`: базу называет дом моделей'
|
|
127
|
+
raise ValueError(message)
|
|
128
|
+
return self
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
class Layout(CheckSettings):
|
|
132
|
+
"""Секция `[layout]`: адрес директории — и блок про неё.
|
|
133
|
+
|
|
134
|
+
Ключи приходят из проекта, поэтому модель принимает любые: имена
|
|
135
|
+
директорий — это данные, а не поля. Проверяется содержимое блока.
|
|
136
|
+
"""
|
|
137
|
+
|
|
138
|
+
model_config = CheckSettings.model_config | {"extra": "allow"}
|
|
139
|
+
|
|
140
|
+
# Типизированный `extra` pydantic: ключ — адрес, значение — блок.
|
|
141
|
+
__pydantic_extra__: dict[str, Directory] # type: ignore[assignment]
|
|
142
|
+
|
|
143
|
+
@property
|
|
144
|
+
def directories(self) -> dict[str, Directory]:
|
|
145
|
+
return self.__pydantic_extra__
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
def addressed(
|
|
149
|
+
*,
|
|
150
|
+
layout: dict[str, Directory],
|
|
151
|
+
orm: Orm,
|
|
152
|
+
) -> tuple[str, ...]:
|
|
153
|
+
"""Адреса, объявившие себя этим концом соглашения про ORM-модель."""
|
|
154
|
+
return tuple(address for address, directory in layout.items() if directory.orm is orm)
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
def innermost(
|
|
158
|
+
*,
|
|
159
|
+
where: Place,
|
|
160
|
+
among: Iterable[tuple[str, Directory]],
|
|
161
|
+
) -> tuple[str, Directory] | None:
|
|
162
|
+
"""Блок самой внутренней из совпавших директорий.
|
|
163
|
+
|
|
164
|
+
Побеждает самая глубокая: `modules/betslip/application/services` важнее,
|
|
165
|
+
чем `application`. При равной глубине — более длинный адрес: путь говорит о
|
|
166
|
+
месте больше, чем одно имя.
|
|
167
|
+
"""
|
|
168
|
+
matched = [
|
|
169
|
+
(depth, len(address), address, directory)
|
|
170
|
+
for address, directory in among
|
|
171
|
+
if (depth := where.within(directory=address)) is not None
|
|
172
|
+
]
|
|
173
|
+
if not matched:
|
|
174
|
+
return None
|
|
175
|
+
deepest = max(matched, key=lambda found: found[:2])
|
|
176
|
+
return deepest[2], deepest[3]
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
@dataclass(frozen=True, slots=True)
|
|
180
|
+
class Claim:
|
|
181
|
+
"""Чей это дом и почему объявление в него просится."""
|
|
182
|
+
|
|
183
|
+
address: str
|
|
184
|
+
said: str
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
def claimants(
|
|
188
|
+
*,
|
|
189
|
+
declared: Declaration,
|
|
190
|
+
layout: dict[str, Directory],
|
|
191
|
+
) -> list[Claim]:
|
|
192
|
+
"""Адреса, объявившие это объявление своим: по имени или по виду."""
|
|
193
|
+
found: list[Claim] = []
|
|
194
|
+
for address, directory in layout.items():
|
|
195
|
+
said = _claim(
|
|
196
|
+
declared=declared,
|
|
197
|
+
directory=directory,
|
|
198
|
+
)
|
|
199
|
+
if said is not None:
|
|
200
|
+
found.append(
|
|
201
|
+
Claim(
|
|
202
|
+
address=address,
|
|
203
|
+
said=said,
|
|
204
|
+
)
|
|
205
|
+
)
|
|
206
|
+
return found
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
def _claim(
|
|
210
|
+
*,
|
|
211
|
+
declared: Declaration,
|
|
212
|
+
directory: Directory,
|
|
213
|
+
) -> str | None:
|
|
214
|
+
"""Почему этот адрес считает объявление своим; `None` — не считает."""
|
|
215
|
+
if directory.suffix is not None and declared.name.endswith(directory.suffix):
|
|
216
|
+
return f"кончается на {directory.suffix}"
|
|
217
|
+
if declared.kind is not None and declared.kind in directory.home:
|
|
218
|
+
return f"— {declared.kind.said}"
|
|
219
|
+
return None
|
py_checks/checks/_location.py
CHANGED
|
@@ -12,6 +12,7 @@ from dataclasses import dataclass
|
|
|
12
12
|
from typing import TYPE_CHECKING, Final
|
|
13
13
|
|
|
14
14
|
from py_checks.config import CheckSettings
|
|
15
|
+
from py_checks.core import depth
|
|
15
16
|
|
|
16
17
|
if TYPE_CHECKING:
|
|
17
18
|
from collections.abc import Iterable
|
|
@@ -23,9 +24,6 @@ INIT: Final = "__init__"
|
|
|
23
24
|
|
|
24
25
|
SEPARATOR: Final = "/"
|
|
25
26
|
|
|
26
|
-
# Один любой кусок пути: `modules/*/domain` — домен любого модуля.
|
|
27
|
-
ANY: Final = "*"
|
|
28
|
-
|
|
29
27
|
# Пакет и хотя бы один шаг внутри него: файл, лежащий прямо в корне исходников,
|
|
30
28
|
# ни в каком пакете не находится, и говорить о его месте нечего.
|
|
31
29
|
INSIDE: Final = 2
|
|
@@ -65,9 +63,9 @@ class Place:
|
|
|
65
63
|
то же место.
|
|
66
64
|
"""
|
|
67
65
|
return (
|
|
68
|
-
|
|
66
|
+
depth(
|
|
69
67
|
parts=self.parts,
|
|
70
|
-
|
|
68
|
+
path=path,
|
|
71
69
|
)
|
|
72
70
|
is not None
|
|
73
71
|
)
|
|
@@ -80,9 +78,9 @@ class Place:
|
|
|
80
78
|
можно только по тому, где они кончаются, — глубже тот, кто кончается
|
|
81
79
|
позже.
|
|
82
80
|
"""
|
|
83
|
-
return
|
|
81
|
+
return depth(
|
|
84
82
|
parts=self.parts[:-1],
|
|
85
|
-
|
|
83
|
+
path=directory,
|
|
86
84
|
)
|
|
87
85
|
|
|
88
86
|
|
|
@@ -139,34 +137,3 @@ def _relative(
|
|
|
139
137
|
except ValueError:
|
|
140
138
|
return None
|
|
141
139
|
return inside.with_suffix("").parts
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
def _run(
|
|
145
|
-
*,
|
|
146
|
-
parts: tuple[str, ...],
|
|
147
|
-
wanted: str,
|
|
148
|
-
) -> int | None:
|
|
149
|
-
"""Конец последнего вхождения подряд идущих кусков пути.
|
|
150
|
-
|
|
151
|
-
`*` подходит любому одному куску: `modules/*/domain` — это домен любого
|
|
152
|
-
модуля, и перечислять модули по именам не нужно.
|
|
153
|
-
"""
|
|
154
|
-
needle = tuple(wanted.split(SEPARATOR))
|
|
155
|
-
span = len(needle)
|
|
156
|
-
ends = [
|
|
157
|
-
start + span
|
|
158
|
-
for start in range(len(parts) - span + 1)
|
|
159
|
-
if _same(
|
|
160
|
-
found=parts[start : start + span],
|
|
161
|
-
needle=needle,
|
|
162
|
-
)
|
|
163
|
-
]
|
|
164
|
-
return max(ends) if ends else None
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
def _same(
|
|
168
|
-
*,
|
|
169
|
-
found: tuple[str, ...],
|
|
170
|
-
needle: tuple[str, ...],
|
|
171
|
-
) -> bool:
|
|
172
|
-
return all(wanted in (ANY, part) for part, wanted in zip(found, needle, strict=True))
|
|
@@ -21,7 +21,7 @@ CODE: Final = "confined-functions"
|
|
|
21
21
|
|
|
22
22
|
class ConfinedFunctionsSettings(CheckSettings):
|
|
23
23
|
calls: dict[str, tuple[str, ...]] = {} # noqa: RUF012 — pydantic копирует значение сам
|
|
24
|
-
|
|
24
|
+
declared_in: str | None = None
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
class ConfinedFunctions:
|
|
@@ -36,10 +36,10 @@ class ConfinedFunctions:
|
|
|
36
36
|
Место — кусок пути, а не файл: край — это место в замысле, и файл, который
|
|
37
37
|
разделили надвое, краем быть не перестал.
|
|
38
38
|
|
|
39
|
-
`
|
|
39
|
+
`declared-in` — модуль, где функция объявлена: там она написана, а не позвана, и
|
|
40
40
|
правило его не трогает.
|
|
41
41
|
|
|
42
|
-
Настройки: `calls`, `
|
|
42
|
+
Настройки: `calls`, `declared-in`.
|
|
43
43
|
"""
|
|
44
44
|
|
|
45
45
|
code: ClassVar[str] = CODE
|
|
@@ -62,7 +62,7 @@ class ConfinedFunctions:
|
|
|
62
62
|
where = place(file=file)
|
|
63
63
|
if where is None or not limits.calls:
|
|
64
64
|
return
|
|
65
|
-
if limits.
|
|
65
|
+
if limits.declared_in is not None and where.holds(path=limits.declared_in):
|
|
66
66
|
return
|
|
67
67
|
for node in ast.walk(file.tree):
|
|
68
68
|
if not isinstance(node, ast.Call):
|
|
@@ -13,7 +13,7 @@ from py_checks.checks.database._confined_calls import (
|
|
|
13
13
|
ConfinedCallsSettings,
|
|
14
14
|
)
|
|
15
15
|
from py_checks.checks.database._marker import MARKER
|
|
16
|
-
from py_checks.checks.database._model_boundary import ModelBoundary
|
|
16
|
+
from py_checks.checks.database._model_boundary import ModelBoundary
|
|
17
17
|
from py_checks.checks.database._model_columns import ModelColumns, ModelColumnsSettings
|
|
18
18
|
from py_checks.checks.database._raw_sql import RawSql, RawSqlSettings
|
|
19
19
|
from py_checks.checks.database._schema_drift import SchemaDrift, SchemaDriftSettings
|
|
@@ -27,7 +27,6 @@ __all__ = [
|
|
|
27
27
|
"ConfinedCalls",
|
|
28
28
|
"ConfinedCallsSettings",
|
|
29
29
|
"ModelBoundary",
|
|
30
|
-
"ModelBoundarySettings",
|
|
31
30
|
"ModelColumns",
|
|
32
31
|
"ModelColumnsSettings",
|
|
33
32
|
"RawSql",
|
|
@@ -5,15 +5,17 @@ from __future__ import annotations
|
|
|
5
5
|
import ast
|
|
6
6
|
from typing import TYPE_CHECKING, ClassVar, Final
|
|
7
7
|
|
|
8
|
+
from pydantic import Field
|
|
9
|
+
|
|
8
10
|
from py_checks.checks._location import ZonedSettings, zoned
|
|
9
11
|
from py_checks.checks._names import name
|
|
10
12
|
from py_checks.checks.database._marker import MARKER
|
|
13
|
+
from py_checks.config import CheckSettings
|
|
11
14
|
from py_checks.core import Scope, Violation, settings_as
|
|
12
15
|
|
|
13
16
|
if TYPE_CHECKING:
|
|
14
17
|
from collections.abc import Iterator
|
|
15
18
|
|
|
16
|
-
from py_checks.config import CheckSettings
|
|
17
19
|
from py_checks.core import ParsedFile
|
|
18
20
|
|
|
19
21
|
CODE: Final = "bound-checks"
|
|
@@ -21,13 +23,24 @@ CODE: Final = "bound-checks"
|
|
|
21
23
|
MAPPED: Final = "Mapped"
|
|
22
24
|
|
|
23
25
|
|
|
24
|
-
class
|
|
25
|
-
|
|
26
|
+
class Helper(CheckSettings):
|
|
27
|
+
"""Как зовут хелпер проекта и два его аргумента.
|
|
28
|
+
|
|
29
|
+
Три голых слова в секции не говорили, что они об одном: `call` —
|
|
30
|
+
функция, `column` и `primitive` — её аргументы, и прочитать это можно было
|
|
31
|
+
только из документации. Блок говорит это формой.
|
|
32
|
+
"""
|
|
33
|
+
|
|
26
34
|
call: str = "bound_check"
|
|
27
35
|
column: str = "column"
|
|
28
36
|
primitive: str = "primitive"
|
|
29
37
|
|
|
30
38
|
|
|
39
|
+
class BoundChecksSettings(ZonedSettings):
|
|
40
|
+
primitives: tuple[str, ...] = ()
|
|
41
|
+
helper: Helper = Field(default_factory=Helper)
|
|
42
|
+
|
|
43
|
+
|
|
31
44
|
class BoundChecks:
|
|
32
45
|
"""Падает, если ограниченная колонка не повторила своё ограничение как CHECK.
|
|
33
46
|
|
|
@@ -48,7 +61,7 @@ class BoundChecks:
|
|
|
48
61
|
этого сервиса деньги — `PositiveDecimal`, а доля — `MarginFraction`. Без
|
|
49
62
|
списка правило молчит.
|
|
50
63
|
|
|
51
|
-
Настройки: `zones`, `primitives`, `
|
|
64
|
+
Настройки: `zones`, `primitives`, `helper`.
|
|
52
65
|
"""
|
|
53
66
|
|
|
54
67
|
code: ClassVar[str] = CODE
|
|
@@ -126,14 +139,15 @@ class BoundChecks:
|
|
|
126
139
|
said: str | None,
|
|
127
140
|
limits: BoundChecksSettings,
|
|
128
141
|
) -> str:
|
|
142
|
+
helper = limits.helper
|
|
129
143
|
if said is None:
|
|
130
144
|
return (
|
|
131
145
|
f"{field} объявлено как {bounded}, но CHECK не несёт; добавь "
|
|
132
|
-
f"{
|
|
146
|
+
f"{helper.call}({helper.column}={field}, {helper.primitive}={bounded}) "
|
|
133
147
|
f"в __table_args__"
|
|
134
148
|
)
|
|
135
149
|
return (
|
|
136
|
-
f"{field} объявлено как {bounded}, а его {
|
|
150
|
+
f"{field} объявлено как {bounded}, а его {helper.call} называет {said}; "
|
|
137
151
|
f"аннотация и CHECK читают одну границу"
|
|
138
152
|
)
|
|
139
153
|
|
|
@@ -147,15 +161,15 @@ class BoundChecks:
|
|
|
147
161
|
"""Колонка — тип, по каждому вызову в теле класса."""
|
|
148
162
|
found: dict[str, str] = {}
|
|
149
163
|
for child in ast.walk(node):
|
|
150
|
-
if not isinstance(child, ast.Call) or name(node=child.func) != limits.call:
|
|
164
|
+
if not isinstance(child, ast.Call) or name(node=child.func) != limits.helper.call:
|
|
151
165
|
continue
|
|
152
166
|
column = cls._argument(
|
|
153
167
|
node=child,
|
|
154
|
-
named=limits.column,
|
|
168
|
+
named=limits.helper.column,
|
|
155
169
|
)
|
|
156
170
|
primitive = cls._argument(
|
|
157
171
|
node=child,
|
|
158
|
-
named=limits.primitive,
|
|
172
|
+
named=limits.helper.primitive,
|
|
159
173
|
)
|
|
160
174
|
if column is not None and primitive is not None:
|
|
161
175
|
found[column] = primitive
|
|
@@ -25,15 +25,18 @@ class Confined(ZonedSettings):
|
|
|
25
25
|
`owner` — имя модуля без расширения. Правило его не касается: там вызов и
|
|
26
26
|
должен стоять, потому и владелец.
|
|
27
27
|
|
|
28
|
-
`
|
|
28
|
+
`skip` — куски зоны, где правило молчит. Имя метода — всё, что видно по
|
|
29
29
|
одному файлу, и край брокера тому пример: `commit()` у консьюмера
|
|
30
30
|
подтверждает смещение, а не транзакцию базы.
|
|
31
|
+
|
|
32
|
+
`because` — причина в отказе: она объясняет, кто владеет этим вызовом, и
|
|
33
|
+
печатается тому, кто его написал не там.
|
|
31
34
|
"""
|
|
32
35
|
|
|
33
36
|
methods: tuple[str, ...]
|
|
34
|
-
|
|
37
|
+
skip: tuple[str, ...] = ()
|
|
35
38
|
owner: str | None = None
|
|
36
|
-
|
|
39
|
+
because: str = "этим владеет другой модуль"
|
|
37
40
|
|
|
38
41
|
|
|
39
42
|
class ConfinedCallsSettings(CheckSettings):
|
|
@@ -98,7 +101,7 @@ class ConfinedCalls:
|
|
|
98
101
|
node=node,
|
|
99
102
|
path=file.path,
|
|
100
103
|
code=CODE,
|
|
101
|
-
message=f"{ast.unparse(node.func)}: {rule.
|
|
104
|
+
message=f"{ast.unparse(node.func)}: {rule.because}",
|
|
102
105
|
)
|
|
103
106
|
|
|
104
107
|
@staticmethod
|
|
@@ -110,6 +113,6 @@ class ConfinedCalls:
|
|
|
110
113
|
) -> bool:
|
|
111
114
|
if rule.owner is not None and file.path.stem == rule.owner:
|
|
112
115
|
return False
|
|
113
|
-
if where.anywhere(zones=rule.
|
|
116
|
+
if where.anywhere(zones=rule.skip):
|
|
114
117
|
return False
|
|
115
118
|
return where.anywhere(zones=rule.zones)
|
|
@@ -3,18 +3,21 @@
|
|
|
3
3
|
from __future__ import annotations
|
|
4
4
|
|
|
5
5
|
import ast
|
|
6
|
+
from dataclasses import dataclass
|
|
6
7
|
from typing import TYPE_CHECKING, ClassVar, Final
|
|
7
8
|
|
|
9
|
+
from py_checks.checks._layout import SECTION, Layout, Orm, addressed
|
|
8
10
|
from py_checks.checks._location import place
|
|
9
11
|
from py_checks.checks._names import name, walked
|
|
10
12
|
from py_checks.checks.database._marker import MARKER
|
|
11
|
-
from py_checks.config import CheckSettings
|
|
12
13
|
from py_checks.core import Scope, Violation, settings_as
|
|
13
14
|
|
|
14
15
|
if TYPE_CHECKING:
|
|
15
16
|
from collections.abc import Iterator
|
|
16
17
|
|
|
18
|
+
from py_checks.checks._layout import Directory
|
|
17
19
|
from py_checks.checks._location import Place
|
|
20
|
+
from py_checks.config import CheckSettings
|
|
18
21
|
from py_checks.core import ParsedFile
|
|
19
22
|
|
|
20
23
|
CODE: Final = "model-boundary"
|
|
@@ -23,11 +26,17 @@ PRIVATE: Final = "_"
|
|
|
23
26
|
DOT: Final = "."
|
|
24
27
|
SEPARATOR: Final = "/"
|
|
25
28
|
|
|
29
|
+
# Как зовут базовый класс моделей, если дом не сказал иначе.
|
|
30
|
+
BASE: Final = "Base"
|
|
26
31
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
32
|
+
|
|
33
|
+
@dataclass(frozen=True, slots=True)
|
|
34
|
+
class Boundary:
|
|
35
|
+
"""Два конца соглашения про модель, прочитанные из раскладки."""
|
|
36
|
+
|
|
37
|
+
declared: tuple[str, ...]
|
|
38
|
+
built: tuple[str, ...]
|
|
39
|
+
base: str
|
|
31
40
|
|
|
32
41
|
|
|
33
42
|
class ModelBoundary:
|
|
@@ -55,11 +64,14 @@ class ModelBoundary:
|
|
|
55
64
|
по базе `Base`, использование — по импорту из пакета моделей. Имя ни при
|
|
56
65
|
чём: `SettingsModel` в настройках и `DeviceModel` в домене — не таблицы.
|
|
57
66
|
|
|
58
|
-
Настройки: `
|
|
67
|
+
Настройки: `orm` в общей таблице `[layout]` — `"declared"` у дома моделей
|
|
68
|
+
и `"built"` там, где их собирают; `base` рядом с домом, если базовый класс
|
|
69
|
+
зовут не `Base`.
|
|
59
70
|
"""
|
|
60
71
|
|
|
61
72
|
code: ClassVar[str] = CODE
|
|
62
|
-
Settings: ClassVar[type[CheckSettings]] =
|
|
73
|
+
Settings: ClassVar[type[CheckSettings]] = Layout
|
|
74
|
+
section: ClassVar[str] = SECTION
|
|
63
75
|
scope: ClassVar[Scope] = Scope.FILE
|
|
64
76
|
marker: ClassVar[str] = MARKER
|
|
65
77
|
|
|
@@ -70,10 +82,12 @@ class ModelBoundary:
|
|
|
70
82
|
file: ParsedFile,
|
|
71
83
|
settings: CheckSettings,
|
|
72
84
|
) -> Iterator[Violation]:
|
|
73
|
-
limits =
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
85
|
+
limits = cls._boundary(
|
|
86
|
+
layout=settings_as(
|
|
87
|
+
settings=settings,
|
|
88
|
+
model=Layout,
|
|
89
|
+
code=CODE,
|
|
90
|
+
).directories
|
|
77
91
|
)
|
|
78
92
|
where = place(file=file)
|
|
79
93
|
if where is None or not limits.declared:
|
|
@@ -103,13 +117,33 @@ class ModelBoundary:
|
|
|
103
117
|
]
|
|
104
118
|
yield from sorted(found, key=lambda violation: (violation.line, violation.column))
|
|
105
119
|
|
|
120
|
+
@staticmethod
|
|
121
|
+
def _boundary(*, layout: dict[str, Directory]) -> Boundary:
|
|
122
|
+
"""Дом моделей, место сборки и имя базы — всё из блоков раскладки."""
|
|
123
|
+
declared = addressed(
|
|
124
|
+
layout=layout,
|
|
125
|
+
orm=Orm.DECLARED,
|
|
126
|
+
)
|
|
127
|
+
named = next(
|
|
128
|
+
(layout[address].base for address in declared if layout[address].base is not None),
|
|
129
|
+
None,
|
|
130
|
+
)
|
|
131
|
+
return Boundary(
|
|
132
|
+
declared=declared,
|
|
133
|
+
built=addressed(
|
|
134
|
+
layout=layout,
|
|
135
|
+
orm=Orm.BUILT,
|
|
136
|
+
),
|
|
137
|
+
base=named or BASE,
|
|
138
|
+
)
|
|
139
|
+
|
|
106
140
|
@classmethod
|
|
107
141
|
def _declared(
|
|
108
142
|
cls,
|
|
109
143
|
*,
|
|
110
144
|
file: ParsedFile,
|
|
111
145
|
where: Place,
|
|
112
|
-
limits:
|
|
146
|
+
limits: Boundary,
|
|
113
147
|
) -> Iterator[Violation]:
|
|
114
148
|
"""Модель, объявленная не в доме моделей."""
|
|
115
149
|
if where.anywhere(
|
|
@@ -137,7 +171,7 @@ class ModelBoundary:
|
|
|
137
171
|
*,
|
|
138
172
|
file: ParsedFile,
|
|
139
173
|
where: Place,
|
|
140
|
-
limits:
|
|
174
|
+
limits: Boundary,
|
|
141
175
|
models: frozenset[str],
|
|
142
176
|
) -> Iterator[Violation]:
|
|
143
177
|
"""Модель, собранная там, где нечем записать строку."""
|
|
@@ -166,7 +200,7 @@ class ModelBoundary:
|
|
|
166
200
|
*,
|
|
167
201
|
file: ParsedFile,
|
|
168
202
|
where: Place,
|
|
169
|
-
limits:
|
|
203
|
+
limits: Boundary,
|
|
170
204
|
models: frozenset[str],
|
|
171
205
|
) -> Iterator[Violation]:
|
|
172
206
|
"""Модель, отданная наружу публичным методом репозитория."""
|
|
@@ -201,7 +235,7 @@ class ModelBoundary:
|
|
|
201
235
|
cls,
|
|
202
236
|
*,
|
|
203
237
|
file: ParsedFile,
|
|
204
|
-
limits:
|
|
238
|
+
limits: Boundary,
|
|
205
239
|
) -> frozenset[str]:
|
|
206
240
|
"""Имена, пришедшие импортом из пакета моделей."""
|
|
207
241
|
names: set[str] = set()
|