docs(APP): Докстринги для оставшихся файлов

#15

Author: intervisionlord

main.py

@@ -8,18 +8,22 @@
 from handlers.handler_logging import logger
 from handlers.handler_server import server_app
 
-if __name__ == "__main__":
+
+def main() -> None:
+    """
+    Основная функция запуска приложения
+    """
     logger.info(f"🚀 Сервер запускается (v.{settings.VERSION})")
     logger.info(f"📍 Хост: {settings.HOST}, Порт: {settings.PORT}")
     logger.info(f"🌐 WEBHOOK_HOST: {settings.WEBHOOK_HOST or 'не установлен'}")
 
     ssl_keyfile = settings.SSL_KEY_PATH
     ssl_certfile = settings.SSL_CERT_PATH
-    SSL_ENABLED = False
+    ssl_enabled = False
 
     if settings.SSL_ENABLED:
         if os.path.exists(ssl_keyfile) and os.path.exists(ssl_certfile):
-            SSL_ENABLED = True
+            ssl_enabled = True
             logger.success("🔐 SSL сертификаты найдены, запуск с HTTPS")
         else:
             logger.warning("⚠️ SSL сертификаты не найдены, запуск с HTTP")
@@ -30,6 +34,10 @@
         port=settings.PORT,
         log_level=settings.LOG_LEVEL,
         access_log=True,
-        ssl_keyfile=ssl_keyfile if SSL_ENABLED else None,
-        ssl_certfile=ssl_certfile if SSL_ENABLED else None,
+        ssl_keyfile=ssl_keyfile if ssl_enabled else None,
+        ssl_certfile=ssl_certfile if ssl_enabled else None,
     )
+
+
+if __name__ == "__main__":
+    main()

models/model_board.py

@@ -1,52 +1,37 @@
-from pydantic import BaseModel
+"""Модели данных для досок NextCloud Deck"""
+
 from typing import Dict, List, Optional, Union
 
-# TODO: Референсные данные - удалить после тестов
-# "title": "Board title",
-# "owner": {
-#     "primaryKey": "admin",
-#     "uid": "admin",
-#     "displayname": "Administrator"
-# },
-# "color": "ff0000",
-# "archived": false,
-# "labels": [],
-# "acl": [],
-# "permissions": {
-#     "PERMISSION_READ": true,
-#     "PERMISSION_EDIT": true,
-#     "PERMISSION_MANAGE": true,
-#     "PERMISSION_SHARE": true
-# },
-# "users": [],
-# "shared": 0,
-# "deletedAt": 0,
-# "id": 10,
-# "lastModified": 1586269585,
-# "settings": {
-#     "notify-due": "off",
-#     "calendar": true
+from pydantic import BaseModel
 
 
 class Owner(BaseModel):
+    """Модель владельца доски"""
+
     primaryKey: str
     uid: str
     displayname: str
 
 
 class Permissions(BaseModel):
+    """Модель разрешений доски"""
+
     PERMISSION_READ: bool
     PERMISSION_EDIT: bool
     PERMISSION_MANAGE: bool
     PERMISSION_SHARE: bool
 
 
 class Settings(BaseModel):
+    """Модель настроек доски"""
+
     notify_due: str
     calendar: bool
 
 
 class ModelBoard(BaseModel):
+    """Основная модель доски"""
+
     title: str
     owner: Owner
     color: str

models/model_stack.py

@@ -1,17 +1,13 @@
+"""Модели данных для стеков NextCloud Deck"""
+
 from typing import List, Optional
 
 from pydantic import BaseModel
 
-# "title": "ToDo",
-# "boardId": 2,
-# "deletedAt": 0,
-# "lastModified": 1541426139,
-# "cards": [...],
-# "order": 999,
-# "id": 4
-
 
 class ModelStack(BaseModel):
+    """Модель стека карточек"""
+
     title: str
     boardId: int
     deletedAt: int

routes/routes_base.py

@@ -1,3 +1,5 @@
+"""Базовые API эндпоинты приложения"""
+
 from fastapi import APIRouter
 
 # Создаем роутер для базовых API эндпоинтов

routes/routes_webhook.py

@@ -1,11 +1,11 @@
+"""Роуты для обработки вебхуков Telegram"""
+
 from fastapi import APIRouter, Request
-from handlers.handler_logging import logger
+
 from handlers.handler_bot import process_update
+from handlers.handler_logging import logger
 
-# Создаем роутер для вебхука
 webhook_router = APIRouter(tags=["webhook"])
-
-# Простой путь без токена
 WEBHOOK_PATH = "/webhook"
 
 
@@ -19,13 +19,3 @@ async def telegram_webhook(update: Request):
     except Exception as e:
         logger.error(f"Ошибка обработки вебхука: {e}")
         return {"ok": False, "error": str(e)}
-
-
-@webhook_router.get(WEBHOOK_PATH)
-async def webhook_debug():
-    """Отладочная ручка для проверки вебхука"""
-    return {
-        "message": "Webhook endpoint is active",
-        "path": WEBHOOK_PATH,
-        "method": "Use POST for Telegram webhooks",
-    }