python-checks 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

py_checks/core/__init__.py

@@ -11,7 +11,7 @@ from py_checks.core._edit import Edit, apply, column
 from py_checks.core._errors import ParseError, UnknownCheckError
 from py_checks.core._fixer import fix
 from py_checks.core._format import reformat
-from py_checks.core._markers import MARKER, Marker, complaints, read, surviving
+from py_checks.core._markers import MARKER, Marker, complaints, markers, surviving
 from py_checks.core._protocols import Check, FileCheck, ProjectCheck, Scope
 from py_checks.core._registry import Checks, available, get
 from py_checks.core._report import report
@@ -21,19 +21,19 @@ from py_checks.core._source import ParsedFile
 from py_checks.core._violation import Violation
 
 __all__ = [
-    "EXIT_OK",
-    "EXIT_VIOLATION",
-    "GROUP",
-    "MARKER",
-    "SYNTAX",
     "Check",
     "Checks",
+    "EXIT_OK",
+    "EXIT_VIOLATION",
     "Edit",
     "FileCheck",
-    "ProjectCheck",
+    "GROUP",
+    "MARKER",
     "Marker",
     "ParseError",
     "ParsedFile",
+    "ProjectCheck",
+    "SYNTAX",
     "Scope",
     "SettingsMismatchError",
     "UnknownCheckError",
@@ -42,15 +42,15 @@ __all__ = [
     "available",
     "column",
     "complaints",
-    "fix",
     "examine",
+    "fix",
     "get",
     "inspect",
+    "markers",
     "python_files",
-    "read",
     "reformat",
-    "surviving",
-    "settings_as",
     "report",
+    "settings_as",
     "survey",
+    "surviving",
 ]

py_checks/core/_markers.py

@@ -49,33 +49,73 @@ class Marker:
     column: int
 
 
-def read(
+def markers(
     *,
     line: str,
     aliases: Mapping[str, frozenset[str]],
-) -> Marker | None:
-    """Маркер из строки, если он там есть.
+) -> tuple[Marker, ...]:
+    """Маркеры строки: их может быть несколько.
+
+    Подпись в столбик собирает пометки в одну строку — `# signature-ok: так
+    зовёт библиотека  # type-ok: сырой ввод`, — и снимать они должны обе.
 
     Разбор нарочно не падает на кривой записи: маркер без кода или без причины
     читается и попадает в `complaints`, иначе о нём никто бы не узнал.
     """
-    if MARKER in line:
-        codes, _, reason = line.split(MARKER, maxsplit=1)[1].partition(":")
-        if not _named(text=codes):
-            return None
-        return Marker(
-            codes=frozenset(_codes(text=codes)),
-            reason=reason.strip(),
-            column=line.index(MARKER) + 1,
+    found = sorted(
+        _starts(
+            line=line,
+            aliases=aliases,
         )
-    for text, codes in aliases.items():
-        if text in line:
-            return Marker(
-                codes=codes,
-                reason=line.split(text, maxsplit=1)[1].removeprefix(":").strip(),
-                column=line.index(text) + 1,
+    )
+    bounds = [*(start for start, _ in found), len(line)]
+    return tuple(
+        marker
+        for number, (start, word) in enumerate(found)
+        if (
+            marker := _marker(
+                text=line[start : bounds[number + 1]],
+                word=word,
+                aliases=aliases,
+                column=start + 1,
             )
-    return None
+        )
+    )
+
+
+def _starts(
+    *,
+    line: str,
+    aliases: Mapping[str, frozenset[str]],
+) -> Iterator[tuple[int, str]]:
+    for word in (MARKER, *aliases):
+        start = line.find(word)
+        if start != -1:
+            yield start, word
+
+
+def _marker(
+    *,
+    text: str,
+    word: str,
+    aliases: Mapping[str, frozenset[str]],
+    column: int,
+) -> Marker | None:
+    tail = text.removeprefix(word)
+    if word != MARKER:
+        return Marker(
+            codes=aliases[word],
+            reason=tail.removeprefix(":").strip(),
+            column=column,
+        )
+    codes, _, reason = tail.partition(":")
+    if not _named(text=codes):
+        return None
+    return Marker(
+        codes=frozenset(_codes(text=codes)),
+        reason=reason.strip(),
+        column=column,
+    )
 
 
 def surviving(
@@ -109,18 +149,16 @@ def complaints(
     нарушение.
     """
     for number, line in enumerate(file.lines, start=1):
-        marker = read(
+        for marker in markers(
             line=line,
             aliases=aliases,
-        )
-        if marker is None:
-            continue
-        yield from _wrong(
-            marker=marker,
-            path=file.path,
-            line=number,
-            known=known,
-        )
+        ):
+            yield from _wrong(
+                marker=marker,
+                path=file.path,
+                line=number,
+                known=known,
+            )
 
 
 def _named(*, text: str) -> bool:
@@ -146,17 +184,17 @@ def _covered(
     file: ParsedFile,
     aliases: Mapping[str, frozenset[str]],
 ) -> bool:
-    for line in _span(
-        violation=violation,
-        file=file,
-    ):
-        marker = read(
+    return any(
+        violation.code in marker.codes
+        for line in _span(
+            violation=violation,
+            file=file,
+        )
+        for marker in markers(
             line=line,
             aliases=aliases,
         )
-        if marker is not None and violation.code in marker.codes:
-            return True
-    return False
+    )
 
 
 def _span(

py_checks/environment/_render.py

@@ -56,9 +56,12 @@ def render(
             seen=set(),
         )
     ]
+    head = declared.header.strip() or HEADER.format(
+        section=f"{prefix(source=config.origin)}{SECTION}"
+    )
     return root / declared.path, "\n".join(
         [
-            HEADER.format(section=f"{prefix(source=config.origin)}{SECTION}"),
+            f"{head.rstrip()}\n",
             *blocks,
         ]
     )

py_checks/environment/_settings.py

@@ -22,10 +22,15 @@ class Example(CheckSettings):
     «ничего не собирать»: проект без настроек из окружения — обычное дело.
 
     `path` — куда писать; по умолчанию `.env.example` в корне.
+
+    `header` — шапка файла со своим текстом, вместе с `#`. Пустая строка
+    оставляет шапку библиотеки: проекту, который пишет комментарии на другом
+    языке, своя нужна, остальным — нет.
     """
 
     settings: tuple[str, ...] = ()
     path: str = FILE
+    header: str = ""
 
 
 def example(*, config: Config) -> Example:

{python_checks-0.1.1.dist-info → python_checks-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-checks
-Version: 0.1.1
+Version: 0.2.0
 Summary: Проверки архитектурных соглашений проекта
 Author: Armontex
 Author-email: Armontex <windle1337@gmail.com>
@@ -181,6 +181,13 @@ text("SELECT 1")  # db-ok: raw-sql: проба живости, формы ORM н
 правило. У каждой группы есть своё короткое слово (`# db-ok`, `# type-ok`,
 `# signature-ok`, …): человек помнит группу, а не двадцать семь кодов.
 
+Пометок в строке может стоять несколько — подпись в столбик собирает их на
+последней строке:
+
+```python
+    ) -> object:  # signature-ok: так зовёт pydantic  # type-ok: сырой ввод
+```
+
 Пометка без кода, с опечаткой в коде или без причины — сама нарушение. Молча
 неработающая пометка выглядит как отключённая проверка, а на деле проверка
 работает и просто её не видит.
@@ -246,6 +253,10 @@ settings = ["myservice.config.settings:Settings"]
 докстринга класса и `description` поля, если оно у него есть, — так объяснение
 живёт рядом с полем, а не в файле, который его переживёт.
 
+Шапку файла можно написать свою — `header = "# Generated by py-checks."`,
+вместе с `#`. Нужна она проекту, который пишет комментарии на другом языке;
+пустая оставляет шапку библиотеки.
+
 Классы импортируются, а не читаются текстом: имя переменной — значение
 атрибута, собранное вызовом, и прочитать его исходником значит выполнить этот
 вызов самому.

{python_checks-0.1.1.dist-info → python_checks-0.2.0.dist-info}/RECORD

@@ -72,14 +72,14 @@ py_checks/contracts/_constants.py,sha256=nKfAs2IJdFdxCxazEG0t_AIeBt6QdAkhhNHNE9d
 py_checks/contracts/_layout.py,sha256=wlZSk0ioVGHtWcnHTwwSGOV35XDi6to0XuOhqqp6Mx0,1829
 py_checks/contracts/_render.py,sha256=vMrQuzheihJS-D367tW3KNQvf8jhOZWWptLFLGvO4hE,6598
 py_checks/contracts/_settings.py,sha256=ItaYTDCZGHEnTaCgPkNwuE0FFlvzM4JABfBpE61dzVI,1556
-py_checks/core/__init__.py,sha256=s0VbZarK_R-_ayKzFfKLhFyagN16Huqlu602yVqmmB0,1684
+py_checks/core/__init__.py,sha256=9XspaoOu-6X7hBLVjyXuXNTyghji_ttC_tQqc82JgsA,1690
 py_checks/core/_constants.py,sha256=G0h499Qoyuqg_PSgfl9El3ObESdoyFbX8BkAt2jvkpE,820
 py_checks/core/_discovery.py,sha256=e2JEGepp3TZpn-v_U7U28wGCvbcyO2jQJ3VawnYMlcQ,1673
 py_checks/core/_edit.py,sha256=A0AL6zrWaZK8kb40Ix750jBSO6BZrgVEEaoYSjLnGok,3266
 py_checks/core/_errors.py,sha256=SsMCn3vVrtfyD56mJ6T_gpeot8H7Ke08YJu-P3AmQ18,794
 py_checks/core/_fixer.py,sha256=tPC_OEa6wx5TwDlRo-CHu6itjpIqR55wZWrGk1Ccb3M,1783
 py_checks/core/_format.py,sha256=bo8CFVUiDsky4TtJRyYs5r9Zx8SlUpP93MFLMEEHDhE,1236
-py_checks/core/_markers.py,sha256=Ig3k9n1ou5BDm1G_ZNoUWIQqQslrgseLF1PwIjpEeWo,7611
+py_checks/core/_markers.py,sha256=0mNJdQdrrU9A53kGvJ2OjrbJhMi1ok8yRVIQQG4l7kg,8497
 py_checks/core/_protocols.py,sha256=DosXZvaQ8HkudgS0EXb2qVe7V74TVc7U7lib3_nu56M,3861
 py_checks/core/_registry.py,sha256=x1ltnTSJ0GOsK8xbaUQhK7SgKUur1MVrEFZUHCZxRdg,3109
 py_checks/core/_report.py,sha256=6vj8g8jImS1Pl8KmdrdXkTfInC9HVQ6u85BgIpPGq00,1459
@@ -89,13 +89,13 @@ py_checks/core/_source.py,sha256=Y-L5l6ItK08szJu7m2XCrz7O0HrZR6nI7LwR0tyXFtg,343
 py_checks/core/_violation.py,sha256=o8_SQxjCcwRoIJWskpoMh3A44zwAYmdGDVsleiBXfzI,2702
 py_checks/environment/__init__.py,sha256=Mq-ItbrQHuo8Y1UhdxhI7dcBv9XbAVisHruaBnF3ZME,891
 py_checks/environment/_constants.py,sha256=yZm4Aqyx8FJTsSBM0J7g6HKdEntSr2L5_q0rXm4LmhE,205
-py_checks/environment/_render.py,sha256=7iW35KTeAhbXpeS14-A96r0dPg92OiI8RDl1agW_L9g,8728
-py_checks/environment/_settings.py,sha256=1kWDHkEnZuHPCMdyagVaQAiaJUHshauixQkKBHB6KX8,1426
+py_checks/environment/_render.py,sha256=QK_uqdgRvsuyKesBcTu8E3WKQVFH1fBBiPE9YjJwwS4,8801
+py_checks/environment/_settings.py,sha256=Pr0xE05tt7iagffzK11NncTN22QeoZKtxA2zuCCEmf0,1773
 py_checks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py_checks/sync/__init__.py,sha256=Kg08BC7arCTqdFk2tO3qm95_jG-X0vxK-GMvVYJEkXc,1041
 py_checks/sync/_sync.py,sha256=KqA65H4zeP6y17LwlRR8svpCuhUdFCY3KIwG3YtuvAk,2254
-python_checks-0.1.1.dist-info/licenses/LICENSE,sha256=omcAXq_cAQNMI5X3fRdH7UC6W2Zc8AC-G9xIZ2U1xF0,1065
-python_checks-0.1.1.dist-info/WHEEL,sha256=R1d3uUTbmXM1FHXH_itQashbrqrOSVj-hvBCpmkIIGE,81
-python_checks-0.1.1.dist-info/entry_points.txt,sha256=59rS_KMwYdFnQ9HuhkBpKQNKySNAALyneIFO_-cVQvw,1679
-python_checks-0.1.1.dist-info/METADATA,sha256=ecPuXkHjy6WaZ1HBfIQ2HOYtjAM7PcCYqpIp1Ga_IhE,18869
-python_checks-0.1.1.dist-info/RECORD,,
+python_checks-0.2.0.dist-info/licenses/LICENSE,sha256=omcAXq_cAQNMI5X3fRdH7UC6W2Zc8AC-G9xIZ2U1xF0,1065
+python_checks-0.2.0.dist-info/WHEEL,sha256=R1d3uUTbmXM1FHXH_itQashbrqrOSVj-hvBCpmkIIGE,81
+python_checks-0.2.0.dist-info/entry_points.txt,sha256=59rS_KMwYdFnQ9HuhkBpKQNKySNAALyneIFO_-cVQvw,1679
+python_checks-0.2.0.dist-info/METADATA,sha256=BkUvC0fGjPHRTS1wn_38b4Zi4xn3ma0LDfDu-8F5i7c,19452
+python_checks-0.2.0.dist-info/RECORD,,