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

python_checks-0.1.2/README.md → python_checks-0.3.0/PKG-INFO

@@ -1,3 +1,19 @@
+Metadata-Version: 2.4
+Name: python-checks
+Version: 0.3.0
+Summary: Проверки архитектурных соглашений проекта
+Author: Armontex
+Author-email: Armontex <windle1337@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: libcst>=1.9,<2
+Requires-Dist: pydantic>=2.13.5,<3
+Requires-Dist: pydantic-settings>=2.15.0,<3
+Requires-Dist: rich>=14.0.0,<16.0.0
+Requires-Dist: typer>=0.27.2,<0.28
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
 <div align="center">
 
 <img src="docs/logo.svg" width="112" alt="py-checks">
@@ -217,6 +233,10 @@ py-checks sync --check   # упасть, если файл отстал
 которого нет, в контракт не попадает — иначе import-linter упал бы на первом же
 несуществующем модуле. Гоняет граф по собранному файлу хук самого import-linter.
 
+Шапку собранного файла можно написать свою — `header` в `[contracts]`, вместе
+с `#`; как и у `.env.example`, нужна она проекту с комментариями на другом
+языке.
+
 ## Пример окружения
 
 Имя переменной знает поле настроек — оно объявляет его `validation_alias`, и
@@ -237,6 +257,10 @@ settings = ["myservice.config.settings:Settings"]
 докстринга класса и `description` поля, если оно у него есть, — так объяснение
 живёт рядом с полем, а не в файле, который его переживёт.
 
+Шапку файла можно написать свою — `header = "# Generated by py-checks."`,
+вместе с `#`. Нужна она проекту, который пишет комментарии на другом языке;
+пустая оставляет шапку библиотеки.
+
 Классы импортируются, а не читаются текстом: имя переменной — значение
 атрибута, собранное вызовом, и прочитать его исходником значит выполнить этот
 вызов самому.

python_checks-0.1.2/PKG-INFO → python_checks-0.3.0/README.md

@@ -1,19 +1,3 @@
-Metadata-Version: 2.4
-Name: python-checks
-Version: 0.1.2
-Summary: Проверки архитектурных соглашений проекта
-Author: Armontex
-Author-email: Armontex <windle1337@gmail.com>
-License-Expression: MIT
-License-File: LICENSE
-Requires-Dist: libcst>=1.9,<2
-Requires-Dist: pydantic>=2.13.5,<3
-Requires-Dist: pydantic-settings>=2.15.0,<3
-Requires-Dist: rich>=14.0.0,<16.0.0
-Requires-Dist: typer>=0.27.2,<0.28
-Requires-Python: >=3.14
-Description-Content-Type: text/markdown
-
 <div align="center">
 
 <img src="docs/logo.svg" width="112" alt="py-checks">
@@ -233,6 +217,10 @@ py-checks sync --check   # упасть, если файл отстал
 которого нет, в контракт не попадает — иначе import-linter упал бы на первом же
 несуществующем модуле. Гоняет граф по собранному файлу хук самого import-linter.
 
+Шапку собранного файла можно написать свою — `header` в `[contracts]`, вместе
+с `#`; как и у `.env.example`, нужна она проекту с комментариями на другом
+языке.
+
 ## Пример окружения
 
 Имя переменной знает поле настроек — оно объявляет его `validation_alias`, и
@@ -253,6 +241,10 @@ settings = ["myservice.config.settings:Settings"]
 докстринга класса и `description` поля, если оно у него есть, — так объяснение
 живёт рядом с полем, а не в файле, который его переживёт.
 
+Шапку файла можно написать свою — `header = "# Generated by py-checks."`,
+вместе с `#`. Нужна она проекту, который пишет комментарии на другом языке;
+пустая оставляет шапку библиотеки.
+
 Классы импортируются, а не читаются текстом: имя переменной — значение
 атрибута, собранное вызовом, и прочитать его исходником значит выполнить этот
 вызов самому.

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

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

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

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

{python_checks-0.1.2 → 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.1.2 → 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:

{python_checks-0.1.2 → python_checks-0.3.0}/src/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,
         ]
     )

{python_checks-0.1.2 → python_checks-0.3.0}/src/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: