3.0 Выпуск в PrimoRU

2025-04-13 06:50:23 +07:00
parent b8f7ce5b2a
commit 17d10fbf78
51 changed files with 1191 additions and 1611 deletions
--- a/BotLibrary/loggers/logs.py
+++ b/BotLibrary/loggers/logs.py
@@ -1,107 +1,295 @@
 # BotLibrary/loggers/logs.py
-# Создание логгеров и их шаблон для проекта
+# Кастомные логгеры для проекта, с более стандартизированным использованием

-import sys
 from loguru import logger
-from ProjectsFiles import BotLogs, ProjectPath
+from aiogram.types import Message
+
+from BotLibrary.system.bots import BotInfo
+from BotLibrary.validators.username import username
+from BotLibrary.analytics.type_msg import type_msg
+
+from ProjectsFiles import BotLogs, Permissions, ProjectPath, BotVar, bot_owner

 # Настройка экспорта из модуля
-__all__ = ("setup_logger",)
-
-# Создание обычного логгера + логгер в файл
-async def setup_logger(logging: bool = BotLogs.permission,
-                       to_file: bool = BotLogs.permission_to_file) -> None:
-    """
-    Настройка логгеров для проекта, выводящих логи в консоль и файлы.
-    Логгеры конфигурируются в зависимости от настроек в конфигах проекта.
-
-    Если разрешено логирование, добавляются логи для уровней DEBUG, INFO, WARNING, ERROR.
-    И кастомные такие, как START, NEW_USER, LEAVE_USER
-
-    :param logging: Разрешение на логирование в консоль (config)
-    :param to_file: Разрешение на логирование в файл (config)
-
-    :return: Создание логеров под различные уровни
-    """
-    logger.remove()  # Удаляем все стандартные логгеры
+__all__ = ("Logs",)


-    # Если есть разрешение, то он создает новые уровни
-    if logging and BotLogs.permission_to_file:
-        # Добавляем новый уровень START
-        logger.level("START", no=25, color="white", icon="🔸")
-    if logging and BotLogs.permission_new_user:
-        # Добавляем новый уровень NEW_USER
-        logger.level("NEW_USER", no=4, color="white", icon="👋")
-    if logging and BotLogs.permission_leave_user:
-        # Добавляем новый уровень LEAVE_USER
-        logger.level("LEAVE_USER", no=3, color="white", icon="🫰")
+class Logs:
+    """Класс для логирования с разными уровнями через loguru."""
+    @staticmethod
+    def setup(logging: bool = BotLogs.permission,
+              to_file: bool = BotLogs.permission_to_file) -> None:
+        """
+        Настройка логгеров для проекта, выводящих логи в консоль и файлы.
+        Логгеры конфигурируются в зависимости от настроек в конфигах проекта.
+
+        Если разрешено логирование, добавляются логи для уровней DEBUG, INFO, WARNING, ERROR.
+        И кастомные такие, как START, NEW_USER, LEAVE_USER
+
+        :param logging: Разрешение на логирование в консоль (config)
+        :param to_file: Разрешение на логирование в файл (config)
+        :return: Создание логеров под различные уровни
+        """
+        logger.remove()  # Удаляем все стандартные логгеры
+
+        # Если есть разрешение, то он создает новые уровни
+        if logging and BotLogs.permission_to_file:
+            # Добавляем новый уровень START
+            logger.level("START", no=25, color="white", icon="🔸")
+        if logging and BotLogs.permission_new_user:
+            # Добавляем новый уровень NEW_USER
+            logger.level("NEW_USER", no=4, color="white", icon="👋")
+        if logging and BotLogs.permission_leave_user:
+            # Добавляем новый уровень LEAVE_USER
+            logger.level("LEAVE_USER", no=3, color="white", icon="🫰")
+
+        # Настройка логирования в консоль для каждого уровня
+        if logging:
+            from sys import stderr
+            logger.add(stderr,
+                       colorize=True,
+                       format=BotLogs.start_text,
+                       level="START",
+                       filter=lambda record: record["level"].name == "START"
+                       )
+            logger.add(stderr,
+                       colorize=True,
+                       format=BotLogs.debug_text,
+                       level="DEBUG",
+                       filter=lambda record: record["level"].name == "DEBUG")
+            logger.add(stderr,
+                       colorize=True,
+                       format=BotLogs.info_text,
+                       level="INFO",
+                       filter=lambda record: record["level"].name == "INFO")
+            logger.add(stderr,
+                       colorize=True,
+                       format=BotLogs.warning_text,
+                       level="WARNING",
+                       filter=lambda record: record["level"].name == "WARNING")
+            logger.add(stderr,
+                       colorize=True,
+                       format=BotLogs.error_text,
+                       level="ERROR",
+                       filter=lambda record: record["level"].name == "ERROR")
+
+        # Добавление логгера для записи в файл
+        if to_file:
+            logger.add(ProjectPath.start_log_file,
+                       rotation=BotLogs.max_size,
+                       format=BotLogs.start_text,
+                       backtrace=True,
+                       diagnose=True,
+                       level="START",
+                       filter=lambda record: record["level"].name == "START")
+            logger.add(ProjectPath.debug_log_file,
+                       rotation=BotLogs.max_size,
+                       format=BotLogs.debug_text,
+                       backtrace=True,
+                       diagnose=True,
+                       level="DEBUG",
+                       filter=lambda record: record["level"].name == "DEBUG")
+            logger.add(ProjectPath.info_log_file,
+                       rotation=BotLogs.max_size,
+                       format=BotLogs.info_text,
+                       backtrace=True,
+                       diagnose=True,
+                       level="INFO",
+                       filter=lambda record: record["level"].name == "INFO")
+            logger.add(ProjectPath.warning_log_file,
+                       rotation=BotLogs.max_size,
+                       format=BotLogs.warning_text,
+                       backtrace=True,
+                       diagnose=True,
+                       level="WARNING",
+                       filter=lambda record: record["level"].name == "WARNING")
+            logger.add(ProjectPath.error_log_file,
+                       rotation=BotLogs.max_size,
+                       format=BotLogs.error_text,
+                       backtrace=True,
+                       diagnose=True,
+                       level="ERROR",
+                       filter=lambda record: record["level"].name == "ERROR")


-    # Настройка логирования в консоль для каждого уровня
-    if logging:
-        logger.add(sys.stderr,
-                   colorize=True,
-                   format=BotLogs.start_text,
-                   level="START",
-                   filter=lambda record: record["level"].name == "START"
-        )
-        logger.add(sys.stderr,
-                   colorize=True,
-                   format=BotLogs.debug_text,
-                   level="DEBUG",
-                   filter=lambda record: record["level"].name == "DEBUG")
-        logger.add(sys.stderr,
-                   colorize=True,
-                   format=BotLogs.info_text,
-                   level="INFO",
-                   filter=lambda record: record["level"].name == "INFO")
-        logger.add(sys.stderr,
-                   colorize=True,
-                   format=BotLogs.warning_text,
-                   level="WARNING",
-                   filter=lambda record: record["level"].name == "WARNING")
-        logger.add(sys.stderr,
-                   colorize=True,
-                   format=BotLogs.error_text,
-                   level="ERROR",
-                   filter=lambda record: record["level"].name == "ERROR")
+    @staticmethod
+    def start(text: str = "Логирование!",
+              system: str = "PRIMO",
+              log_type: str = "AEP",
+              user: str = "@Console") -> None:
+        """
+        Логирует сообщение на уровне START.
+
+        :param text: Сообщение для логирования.
+        :param system: Тип системы логирования.
+        :param log_type: Тип лога (например, "Help").
+        :param user: Имя пользователя или источник вызова лога.
+
+        :return: Вывод сообщения об старте бота
+        """
+        logger.bind(system=system, user=user, log_type=log_type).log("START", text)


-    # Добавление логгера для записи в файл
-    if to_file:
-        logger.add(ProjectPath.start_log_file,
-                   rotation=BotLogs.max_size,
-                   format=BotLogs.start_text,
-                   backtrace=True,
-                   diagnose=True,
-                   level="START",
-                   filter=lambda record: record["level"].name == "START")
-        logger.add(ProjectPath.debug_log_file,
-                   rotation=BotLogs.max_size,
-                   format=BotLogs.debug_text,
-                   backtrace=True,
-                   diagnose=True,
-                   level="DEBUG",
-                   filter=lambda record: record["level"].name == "DEBUG")
-        logger.add(ProjectPath.info_log_file,
-                    rotation=BotLogs.max_size,
-                    format=BotLogs.info_text,
-                    backtrace=True,
-                    diagnose=True,
-                    level="INFO",
-                    filter=lambda record: record["level"].name == "INFO")
-        logger.add(ProjectPath.warning_log_file,
-                    rotation=BotLogs.max_size,
-                    format=BotLogs.warning_text,
-                    backtrace=True,
-                    diagnose=True,
-                    level="WARNING",
-                    filter=lambda record: record["level"].name == "WARNING")
-        logger.add(ProjectPath.error_log_file,
-                    rotation=BotLogs.max_size,
-                    format=BotLogs.error_text,
-                    backtrace=True,
-                    diagnose=True,
-                    level="ERROR",
-                    filter=lambda record: record["level"].name == "ERROR")
+    @staticmethod
+    def debug(text: str = "Логирование!",
+              system: str = "DEBUG",
+              log_type: str = "Logs",
+              user: str = "@Console",
+              message: Message = None) -> None:
+        """
+        Логирует сообщение на уровне DEBUG.
+
+        :param text: Сообщение для логирования.
+        :param system: Тип системы логирования.
+        :param log_type: Тип лога (например, "Help").
+        :param user: Имя пользователя или источник вызова лога.
+        :param message: Сообщение от пользователя, если необходимо извлечь имя.
+
+        :return: Вывод сообщения об дебаг-информации
+        """
+        if message:
+            user = username(message)
+        logger.bind(system=system, log_type=log_type, user=user).debug(text)
+
+
+    @staticmethod
+    def info(text: str = "Логирование!",
+             system: str = "PRIMO",
+             log_type: str = "Logs",
+             user: str = "@Console",
+             message: Message = None) -> None:
+        """
+        Логирует сообщение на уровне INFO.
+
+        :param text: Сообщение для логирования.
+        :param system: Тип системы логирования.
+        :param log_type: Тип лога (например, "Logs").
+        :param user: Имя пользователя или источник вызова лога.
+        :param message: Сообщение от пользователя, если необходимо извлечь имя.
+
+        :return: Вывод сообщения об некой информации
+        """
+        if message:
+            user = username(message)
+        logger.bind(system=system, log_type=log_type, user=user).info(text)
+
+
+    @staticmethod
+    def warning(text: str = "Логирование!",
+                system: str = "WARNING",
+                log_type: str = "Logs",
+                user: str = "@Console",
+                message: Message = None) -> None:
+        """
+        Логирует сообщение на уровне WARNING.
+
+        :param text: Сообщение для логирования.
+        :param system: Тип системы логирования.
+        :param log_type: Тип лога (например, "Logs").
+        :param user: Имя пользователя или источник вызова лога.
+        :param message: Сообщение от пользователя, если необходимо извлечь имя.
+
+        :return: Вывод сообщения об предупреждении
+        """
+        if message:
+            user = username(message)
+        logger.bind(system=system, log_type=log_type, user=user).warning(text)
+
+
+    @staticmethod
+    def error(text: str = "Логирование!",
+              system: str = "ERROR",
+              log_type: str = "Logs",
+              user: str = "@Console",
+              message: Message = None) -> None:
+        """
+        Логирует сообщение на уровне ERROR.
+
+        :param text: Сообщение для логирования.
+        :param system: Тип системы логирования.
+        :param log_type: Тип лога (например, "Logs").
+        :param user: Имя пользователя или источник вызова лога.
+        :param message: Сообщение от пользователя, если необходимо извлечь имя.
+
+        :return: Вывод сообщения об ошибке
+        """
+        if message:
+            user = username(message)
+        logger.bind(system=system, log_type=log_type, user=user).error(text)
+
+
+    @staticmethod
+    def msg(message: Message,
+            log_type: str = "Message",
+            user: str = None,
+            msg_type: str = None,
+            permission: bool = BotLogs.permission) -> None:
+        """
+        Логирует сообщение, если оно не обработано.
+
+        :param message: Сообщение от пользователя.
+        :param log_type: Тип лога (по умолчанию "Message").
+        :param permission: Разрешение на логирование (config).
+        :param user: Получение пользователя (автоматически).
+        :param msg_type: Получение типа сообщения (автоматически).
+.
+        :return: Вывод сообщения об обычном сообщении пользователя.
+        """
+        # Получаем айди чата
+        chat_id = message.chat.id
+
+        # Получаем username или id пользователя
+        if user is None:
+            user: str = f"@{message.from_user.username or message.from_user.id}"
+        if msg_type is None:
+            msg_type: str = type_msg(message)
+
+        # Логирование только если разрешено
+        if permission:
+            # Проверка на наличие текста и его типа
+            if message.text is None and msg_type not in ("Новые участники чата", "Ушедший участник чата"):
+                Logs.info(log_type=log_type, user=user, text=f"Получено сообщение из ({chat_id}) : {msg_type}")
+            elif message.text is not None:
+                Logs.info(log_type=log_type, user=user,
+                          text=f"Получено сообщение из ({chat_id}) : {message.text}")
+
+
+    @staticmethod
+    def console(console: bool = Permissions.start_info_console,
+                file: bool = Permissions.start_info_to_file,
+                path: str = ProjectPath.bot_info_log_file) -> None:
+        """
+        Собирает информацию о боте и выводит её в консоль, а также возвращает как строку.
+
+        :param console: Разрешение на внесение информации в консоль (config)
+        :param file: Разрешение на внесение информации в файл (config)
+        :param path: Путь до файла для сохранения информации о боте (config)
+        :return: Информация о боте в виде строки.
+        """
+        # Собираем данные о боте
+        bot_name: str = f"Основное имя: {BotInfo.first_name}\n"
+        bot_post_name: str = f"Владельцы бота: {bot_owner}\n"
+        bot_username: str = f"Юзернейм: @{BotInfo.username}\n"
+        bot_id: str = f"ID: {BotInfo.id}\n"
+        bot_can_join_groups: str = f"Может ли вступать в группы: {BotInfo.can_join_groups}\n"
+        bot_can_read_all_group_messages: str = f"Чтение всех сообщений: {BotInfo.can_read_all_group_messages}\n"
+        bot_supports_inline_queries: str = f"Поддерживает инлайн-запросы: {BotInfo.supports_inline_queries}\n"
+        bot_can_connect_to_business: str = f"Подключение к бизнес-аккаунтам: {BotInfo.can_connect_to_business}\n"
+        bot_has_main_web_app: str = f"Основное веб-приложение: {BotInfo.has_main_web_app}\n"
+
+        # Формируем полный текст с выводом информации о боте
+        bot_all_info: str = (f"{bot_name} {bot_post_name} {bot_username} {bot_id} "
+                             f"{bot_can_join_groups} {bot_can_read_all_group_messages} "
+                             f"{bot_supports_inline_queries} {bot_can_connect_to_business} "
+                             f"{bot_has_main_web_app}")
+
+        # Печатаем всю информацию в консоль с задержкой
+        if console:
+            from colorama import Fore
+            print(Fore.CYAN + bot_all_info)
+
+        # Печатаем всю информацию в файл
+        if file:
+            #  Преобразуем словарь bot_all_info в строку и записываем в файл
+            with open(path, 'w', encoding=BotVar.encod) as file:
+                file.write(str(bot_all_info))