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

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.2.dist-info → python_checks-0.2.0.dist-info}/METADATA

@@ -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.dist-info → python_checks-0.2.0.dist-info}/RECORD

@@ -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.2.dist-info/licenses/LICENSE,sha256=omcAXq_cAQNMI5X3fRdH7UC6W2Zc8AC-G9xIZ2U1xF0,1065
-python_checks-0.1.2.dist-info/WHEEL,sha256=R1d3uUTbmXM1FHXH_itQashbrqrOSVj-hvBCpmkIIGE,81
-python_checks-0.1.2.dist-info/entry_points.txt,sha256=59rS_KMwYdFnQ9HuhkBpKQNKySNAALyneIFO_-cVQvw,1679
-python_checks-0.1.2.dist-info/METADATA,sha256=GOYNIwzxkk81aAAmmzD3yuZJVyDPfp4mbVwnBUZpQrU,19149
-python_checks-0.1.2.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,,