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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-checks
-Version: 0.1.2
+Version: 0.2.0
 Summary: Проверки архитектурных соглашений проекта
 Author: Armontex
 Author-email: Armontex <windle1337@gmail.com>
@@ -253,6 +253,10 @@ settings = ["myservice.config.settings:Settings"]
 докстринга класса и `description` поля, если оно у него есть, — так объяснение
 живёт рядом с полем, а не в файле, который его переживёт.
 
+Шапку файла можно написать свою — `header = "# Generated by py-checks."`,
+вместе с `#`. Нужна она проекту, который пишет комментарии на другом языке;
+пустая оставляет шапку библиотеки.
+
 Классы импортируются, а не читаются текстом: имя переменной — значение
 атрибута, собранное вызовом, и прочитать его исходником значит выполнить этот
 вызов самому.

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

@@ -237,6 +237,10 @@ settings = ["myservice.config.settings:Settings"]
 докстринга класса и `description` поля, если оно у него есть, — так объяснение
 живёт рядом с полем, а не в файле, который его переживёт.
 
+Шапку файла можно написать свою — `header = "# Generated by py-checks."`,
+вместе с `#`. Нужна она проекту, который пишет комментарии на другом языке;
+пустая оставляет шапку библиотеки.
+
 Классы импортируются, а не читаются текстом: имя переменной — значение
 атрибута, собранное вызовом, и прочитать его исходником значит выполнить этот
 вызов самому.

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

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

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

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

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