compose-generator 0.1.0__tar.gz → 0.3.0__tar.gz

{compose_generator-0.1.0 → compose_generator-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compose-generator
-Version: 0.1.0
+Version: 0.3.0
 Summary: Проект представляет собой генератор docker-compose.yml файла на основе настроек приложения
 Author: pasha_danilevich
 Author-email: danilevitch.pasha@yandex.ru
@@ -37,12 +37,6 @@ Description-Content-Type: text/markdown
 
 ## Особенности реализации
 
-### Шаблон Docker Compose
-Создает сервисы:
-- **api** - веб-сервер с пробросом портов
-- **bg** - фоновый сервис
-- Оба используют общую сеть `common-net`
-
 ### Автоматизация конфигурации
 - Извлекает все переменные из объектов `BaseSettings`
 - Сохраняет структуру и префиксы конфигурации

{compose_generator-0.1.0 → compose_generator-0.3.0}/README.md

@@ -21,12 +21,6 @@
 
 ## Особенности реализации
 
-### Шаблон Docker Compose
-Создает сервисы:
-- **api** - веб-сервер с пробросом портов
-- **bg** - фоновый сервис
-- Оба используют общую сеть `common-net`
-
 ### Автоматизация конфигурации
 - Извлекает все переменные из объектов `BaseSettings`
 - Сохраняет структуру и префиксы конфигурации

compose_generator-0.3.0/compose_generator/__init__.py

@@ -0,0 +1,228 @@
+from typing import Optional, Any
+
+from pydantic_settings import BaseSettings
+
+ENV_KEY = '[ENV]'
+VERSION_KEY = '[VERSION]'
+
+
+class ConfigurationComponent:
+    """Конфигурационный объект, составляющий настройки приложения."""
+
+    def __init__(
+        self,
+        item: BaseSettings,
+        ignore: Optional[list[str]] = None,
+    ) -> None:
+        self.item = item
+        self.ignore = ignore or []
+
+        self.env_prefix = item.model_config.get("env_prefix", "")
+
+        self.schema: dict[str, Any] = item.__class__.model_json_schema()
+        self.properties: dict[str, Any] = self.schema.get("properties", {})
+        self.required: set[str] = set(self.schema.get("required", []))
+
+        self.attrs = list(self.properties.keys())
+
+    @property
+    def title(self) -> str:
+        return f"# {self.item.__class__.__name__}"
+
+    @property
+    def max_attr_length(self) -> int:
+        return max(
+            (
+                len(self.env_prefix + attr)
+                for attr in self.attrs
+                if self.env_prefix + attr not in self.ignore
+            ),
+            default=0,
+        )
+    
+    def compose_parsed(self, max_length: int = 0) -> str:
+        """
+        Генерирует переменные для docker-compose.yml.
+        Обязательные поля получают проверку на пустое значение.
+        Имена переменных выравниваются по общей максимальной длине.
+        """
+        result = [self.title]
+        
+        for attr in self.attrs:
+            full_attr = self.env_prefix + attr
+            
+            if full_attr in self.ignore:
+                continue
+            
+            name = f"{full_attr}:".ljust(max_length + 1)
+            
+            if attr in self.required:
+                value = f"${{{full_attr}:?{full_attr} is required}}"
+            else:
+                value = f"${{{full_attr}}}"
+            
+            result.append(f"{name} {value}")
+        
+        return "\n".join(result)
+
+    def get_type_string(self, attr: str) -> str:
+        """Возвращает тип атрибута из JSON Schema."""
+        property_schema = self.properties.get(attr, {})
+
+        if "type" in property_schema:
+            return property_schema["type"]
+
+        any_of = property_schema.get("anyOf")
+
+        if any_of:
+            types = [
+                item["type"]
+                for item in any_of
+                if "type" in item
+            ]
+            return "|".join(types)
+
+        return "unknown"
+
+    def env_parsed(self) -> str:
+        """Генерирует переменные для .env.example."""
+        result = [self.title]
+
+        for attr in self.attrs:
+            full_attr = self.env_prefix + attr
+
+            if full_attr in self.ignore:
+                continue
+
+            line = f"{full_attr}={self.get_type_string(attr)}"
+            result.append(line)
+
+        return "\n".join(result)
+
+
+class DockerCompose:
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+        template: str,
+        version: Optional[str] = None,
+        ignore: Optional[list[str]] = None,
+    ) -> None:
+        self.settings = settings
+        self.template = template
+        self.version = version
+        self.ignore = ignore
+    
+    def insert_to_template(self, content: str, key: str) -> None:
+        # TODO: делать Trilling Whitespace
+        # Разбиваем вставляемую строку на отдельные строки
+        
+        def define_indentation() -> str:
+            lines = self.template.split('\n')
+            for line in lines:
+                if key in line:
+                    return line.split(key)[0]
+            return ''
+        
+        # Форматируем каждую строку с правильным отступом
+        formatted = '\n'.join(
+            [define_indentation() + line for line in content.split('\n')]
+        )
+        
+        # Заменяем {ENV} в шаблоне
+        self.template = self.template.replace(key, formatted.strip())
+    
+    def replace_version(self, version: Optional[str] = None) -> None:
+        if version is not None:
+            self.template = self.template.replace(VERSION_KEY, version)
+    
+    @property
+    def max_attr_length(self) -> int:
+        return max(
+            (
+                ConfigurationComponent(c, self.ignore).max_attr_length
+                for c in self.settings
+            ),
+            default=0,
+        )
+    
+    def __call__(self, filename: str) -> None:
+        max_length = self.max_attr_length
+        
+        parsed_components: list[str] = [
+            ConfigurationComponent(c, self.ignore).compose_parsed(max_length)
+            for c in self.settings
+        ]
+        
+        self.insert_to_template(
+            content='\n\n'.join(parsed_components),
+            key=ENV_KEY,
+        )
+        
+        self.replace_version(self.version)
+        
+        with open(filename, 'w') as f:
+            f.write(self.template)
+
+
+class ExampleEnv:
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+        ignore: Optional[list[str]] = None,
+    ) -> None:
+        self.settings = settings
+        self.ignore = ignore
+    
+    def __call__(self, filename: str) -> None:
+        parsed_components: list[str] = [
+            ConfigurationComponent(c, self.ignore).env_parsed() for c in self.settings
+        ]
+        text = '\n\n'.join(parsed_components)
+        with open(filename, 'w') as f:
+            f.write(text)
+
+
+class Generate:
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+    ) -> None:
+        self.settings = settings
+    
+    def docker_compose(
+        self,
+        template: str,
+        version: Optional[str] = None,
+        ignore: Optional[list[str]] = None,
+        filename: str = 'docker-compose.yml'
+    ) -> None:
+        DockerCompose(
+            settings=self.settings,
+            template=template,
+            version=version,
+            ignore=ignore,
+        )(filename)
+    
+    def example_env(self,
+                    ignore: Optional[list[str]] = None,
+                    filename: str = '.env.example'
+                    ) -> None:
+        ExampleEnv(
+            settings=self.settings,
+            ignore=ignore,
+        )(filename)
+
+
+class Generator:
+    """Генератор docker-compose.yml"""
+    
+    def __init__(
+        self,
+        settings: list[BaseSettings],
+    ) -> None:
+        self.settings = settings
+    
+    @property
+    def generate(self) -> Generate:
+        return Generate(settings=self.settings)

{compose_generator-0.1.0 → compose_generator-0.3.0}/compose_generator/example.py

@@ -1,28 +1,6 @@
 # Example
 from compose_generator import Generator
 
-TEMPLATE = """version: "3.9"
-
-networks:
-  common-net:
-    external: true
-
-x-serv-common-env: &serv-common-env
-  [ENV]
-
-services:
-  api:
-    image: /project/user/super-project/api:[VERSION]
-    networks:
-      - common-net
-    ports:
-      - ${APP_SERVER_PORT}:${APP_SERVER_PORT}
-    environment:
-      <<: *serv-common-env
-    restart:
-      unless-stopped
-"""
-
 from pathlib import Path
 
 from pydantic import Field
@@ -42,7 +20,7 @@ class BaseConnection(FromEnvFile):
     HOST: str
     PORT: int
     NAME: str
-
+    
     def get_connection_config(self) -> dict:
         return {
             "engine": "tortoise.backends.asyncpg",
@@ -91,11 +69,36 @@ class Settings(BaseSettings):
     swagger: Swagger = Field(default_factory=Swagger)
 
 
+TEMPLATE = """version: "3.9"
+
+networks:
+  common-net:
+    external: true
+
+x-serv-common-env: &serv-common-env
+  [ENV]
+
+services:
+  api:
+    image: /project/user/super-project/api:[VERSION]
+    networks:
+      - common-net
+    ports:
+      - ${APP_SERVER_PORT}:${APP_SERVER_PORT}
+    environment:
+      <<: *serv-common-env
+    restart:
+      unless-stopped
+"""
+
 if __name__ == "__main__":
     stt = Settings()
     generator = Generator(
-        settings=stt,
+        settings=list(stt.__dict__.values()),
+    )
+    generator.generate.docker_compose(
         template=TEMPLATE,
         version=stt.app.VERSION,
+        ignore=['APP_VERSION'],
     )
-    generator.generate()
+    generator.generate.example_env()

{compose_generator-0.1.0 → compose_generator-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "compose-generator"
-version = "0.1.0"
+version = "0.3.0"
 description = "Проект представляет собой генератор docker-compose.yml файла на основе настроек приложения"
 authors = [
     {name = "pasha_danilevich",email = "danilevitch.pasha@yandex.ru"}

compose_generator-0.1.0/compose_generator/__init__.py

@@ -1,81 +0,0 @@
-from pydantic_settings import BaseSettings
-
-
-class ConfigurationComponent:
-    """Конфигурационные объекты, составляющие настройки всего приложения"""
-
-    def __init__(self, item: BaseSettings) -> None:
-        self.item = item
-
-        self.env_prefix = item.model_config.get("env_prefix", "")
-        self.title = self.item.__class__.__name__
-        self.attrs = list(item.model_dump().keys())
-
-    def parsed(self) -> str:
-        """
-        Парсит объект в строку для записи в docker-compose.yml
-
-        Пример:
-          # RabbitMQ
-          RABBITMQ_HOST: ${RABBITMQ_HOST}
-          RABBITMQ_USER: ${RABBITMQ_USER}
-          RABBITMQ_PASS: ${RABBITMQ_PASS}
-        """
-        title = f'# {self.title}' if self.title else " "
-        result = [title]
-
-        for attr in self.attrs:
-            full_attr = self.env_prefix + attr
-            line = f"{full_attr}: " + f"${{{full_attr}}}"
-            result.append(line)
-
-        return "\n".join(result)
-
-
-class Generator:
-    """Генератор docker-compose.yml"""
-
-    ENV_KEY = '[ENV]'
-    VERSION_KEY = '[VERSION]'
-    FILE_NAME = 'docker-compose.yml'
-
-    def __init__(self, settings: BaseSettings, template: str, version: str) -> None:
-        self.settings = settings
-        self.template = template
-        self.version = version
-
-    def insert_to_template(self, content: str, key: str) -> None:
-        # Разбиваем вставляемую строку на отдельные строки
-
-        def define_indentation() -> str:
-            lines = self.template.split('\n')
-            for line in lines:
-                if key in line:
-                    return line.split(key)[0]
-            return ''
-
-        # Форматируем каждую строку с правильным отступом
-        formatted = '\n'.join(
-            [define_indentation() + line for line in content.split('\n')]
-        )
-
-        # Заменяем {ENV} в шаблоне
-        self.template = self.template.replace(key, formatted.strip())
-
-    def replace_version(self, version: str) -> None:
-        self.template = self.template.replace(self.VERSION_KEY, version)
-
-    def generate(self) -> None:
-        components = list(self.settings.__dict__.values())
-        parsed_components: list[str] = [
-            ConfigurationComponent(c).parsed() for c in components
-        ]
-
-        self.insert_to_template(
-            content='\n\n'.join(parsed_components), key=self.ENV_KEY
-        )
-        self.replace_version(self.version)
-
-        with open(self.FILE_NAME, 'w') as f:
-            f.write(self.template)
-