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

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,

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:

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.3.0.dist-info}/METADATA

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

{python_checks-0.1.2.dist-info → python_checks-0.3.0.dist-info}/RECORD

@@ -70,8 +70,8 @@ py_checks/config/_toml.py,sha256=NZaLKJhnBjo-ZImeLCNcJJBxuRE0LYlltgf0dAVYVaE,703
 py_checks/contracts/__init__.py,sha256=oPoF3D9kN9n-oLdh5Ug40Omp1_eJpocNlGMomUTP4xs,1142
 py_checks/contracts/_constants.py,sha256=nKfAs2IJdFdxCxazEG0t_AIeBt6QdAkhhNHNE9dK7lU,664
 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/contracts/_render.py,sha256=6aYauVYwp5O3bS1yVu075WHTS9mII_ZhiuS4m51CrMU,6675
+py_checks/contracts/_settings.py,sha256=CA-6fW_FfCmVn4gtJbpgoDi6F2DGCN9mETPE5V7SSew,1773
 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
@@ -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.3.0.dist-info/licenses/LICENSE,sha256=omcAXq_cAQNMI5X3fRdH7UC6W2Zc8AC-G9xIZ2U1xF0,1065
+python_checks-0.3.0.dist-info/WHEEL,sha256=R1d3uUTbmXM1FHXH_itQashbrqrOSVj-hvBCpmkIIGE,81
+python_checks-0.3.0.dist-info/entry_points.txt,sha256=59rS_KMwYdFnQ9HuhkBpKQNKySNAALyneIFO_-cVQvw,1679
+python_checks-0.3.0.dist-info/METADATA,sha256=TBw3Ne7yP38PJ5rYsLajTFcOaB479xHpl4C6nkyZ3RE,19707
+python_checks-0.3.0.dist-info/RECORD,,