python-checks 0.2.0__tar.gz → 0.3.0__tar.gz

{python_checks-0.2.0 → python_checks-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-checks
-Version: 0.2.0
+Version: 0.3.0
 Summary: Проверки архитектурных соглашений проекта
 Author: Armontex
 Author-email: Armontex <windle1337@gmail.com>
@@ -233,6 +233,10 @@ py-checks sync --check   # упасть, если файл отстал
 которого нет, в контракт не попадает — иначе import-linter упал бы на первом же
 несуществующем модуле. Гоняет граф по собранному файлу хук самого import-linter.
 
+Шапку собранного файла можно написать свою — `header` в `[contracts]`, вместе
+с `#`; как и у `.env.example`, нужна она проекту с комментариями на другом
+языке.
+
 ## Пример окружения
 
 Имя переменной знает поле настроек — оно объявляет его `validation_alias`, и

{python_checks-0.2.0 → python_checks-0.3.0}/README.md

@@ -217,6 +217,10 @@ py-checks sync --check   # упасть, если файл отстал
 которого нет, в контракт не попадает — иначе import-linter упал бы на первом же
 несуществующем модуле. Гоняет граф по собранному файлу хук самого import-linter.
 
+Шапку собранного файла можно написать свою — `header` в `[contracts]`, вместе
+с `#`; как и у `.env.example`, нужна она проекту с комментариями на другом
+языке.
+
 ## Пример окружения
 
 Имя переменной знает поле настроек — оно объявляет его `validation_alias`, и

{python_checks-0.2.0 → python_checks-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-checks"
-version = "0.2.0"
+version = "0.3.0"
 description = "Проверки архитектурных соглашений проекта"
 readme = "README.md"
 license = "MIT"

{python_checks-0.2.0 → python_checks-0.3.0}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "python-checks"
-version = "0.2.0"
+version = "0.3.0"
 description = "Проверки архитектурных соглашений проекта"
 readme = "README.md"
 license = "MIT"

{python_checks-0.2.0 → python_checks-0.3.0}/src/py_checks/contracts/_render.py

@@ -45,12 +45,15 @@ def render(
     )
     if not blocks:
         return None
+    head = contracts(config=config).header.strip() or HEADER.format(
+        # Секция зовётся по-разному в манифесте и в своём файле настроек:
+        # написать одно имя значит послать читателя не туда в половине
+        # проектов.
+        section=f"{prefix(source=config.origin)}{SECTION}"
+    )
     return "\n".join(
         [
-            # Секция зовётся по-разному в манифесте и в своём файле настроек:
-            # написать одно имя значит послать читателя не туда в половине
-            # проектов.
-            HEADER.format(section=f"{prefix(source=config.origin)}{SECTION}"),
+            f"{head.rstrip()}\n",
             _roots(
                 root=root,
                 package=name,

{python_checks-0.2.0 → python_checks-0.3.0}/src/py_checks/contracts/_settings.py

@@ -24,10 +24,14 @@ class Contracts(CheckSettings):
     собой, и это вся их работа. Перечислять их отдельно нужно затем, чтобы они
     попали в запреты остальных: слой, о котором таблица не знает, ничьим
     запретом не становится.
+
+    `header` — шапка собранного файла со своим текстом, вместе с `#`. Пустая
+    строка оставляет шапку библиотеки.
     """
 
     composition_root: tuple[str, ...] = ()
     layers: dict[str, tuple[str, ...]] = {}
+    header: str = ""
 
 
 def contracts(*, config: Config) -> Contracts: