clean-logging 0.3.0__py3-none-any.whl

clean_logging/__init__.py

@@ -0,0 +1,4 @@
+from .infrastructure.loggin_setup import setup_logging
+from .core.interfaces.log_repository_interface import ILogRepository
+
+__all__ = ["setup_logging", "ILogRepository"]

clean_logging/core/interfaces/log_repository_interface.py

@@ -0,0 +1,21 @@
+from abc import ABC, abstractmethod
+
+
+
+
+class ILogRepository(ABC):
+    @abstractmethod
+    def get_logs(self, limit: int = None, offset: int = None):
+        """
+        Save or update a log.
+
+        Args:
+            log: Log entity from the domain layer.
+
+        Returns:
+            T: The saved or updated log entity.
+
+        Raises:
+            ValueError: If required fields are missing.
+        """
+        pass

clean_logging/infrastructure/loggin_setup.py

@@ -0,0 +1,84 @@
+import logging
+
+import coloredlogs
+import queue
+import threading
+from clean_logging.core.interfaces.log_repository_interface import ILogRepository
+
+
+# ایجاد یک کیو برای ذخیره موقت لاگ‌ها
+log_queue = queue.Queue()
+
+
+def setup_logging(log_repository: ILogRepository):
+    """تنظیم Logger برای نمایش رنگی در ترمینال و ذخیره در دیتابیس."""
+
+    if log_repository is None:
+        raise ValueError("Log repository must be provided for logging setup.")
+
+    if not logging.getLogger().hasHandlers():
+        logger = logging.getLogger()  # Logger اصلی
+        logger.setLevel(logging.DEBUG)
+
+        # نمایش لاگ با رنگ در ترمینال
+        coloredlogs.install(
+            level='DEBUG',
+            logger=logger,
+            fmt='%(asctime)s - %(name)s - %(levelname)s - %(funcName)s - %(message)s',
+            datefmt='%Y-%m-%d %H:%M:%S',
+            level_styles={
+                'debug': {'color': 'green'},
+                'info': {'color': 'blue'},
+                'warning': {'color': 'yellow'},
+                'error': {'color': 'red'},
+                'critical': {'color': 'red', 'bold': True},
+            },
+            field_styles={
+                'asctime': {'color': 'cyan'},
+                'name': {'color': 'white'},
+                'levelname': {'color': 'white', 'bold': True},
+                'funcName': {'color': 'magenta'},
+            }
+        )
+
+       
+        import re
+        def remove_ansi_codes(text: str) -> str:
+            
+            ansi_escape = re.compile(r'\x1b\[[0-?]*[ -/]*[@-~]')
+            return ansi_escape.sub('', text)
+        class QueueLogHandler(logging.Handler):
+            def emit(self, record):
+                try:
+                    message = record.getMessage()
+                    clean_message = remove_ansi_codes(message)  
+                    # اضافه کردن لاگ به کیو
+                    log_repository.log_queue.put({
+                        'level': record.levelname,
+                        'message': clean_message,
+                        'function_name': record.funcName,
+                        'filename': record.pathname,
+                        'lineno': record.lineno
+                    })
+                except Exception as e:
+                    print(f"[QueueLogHandler] خطا در افزودن به کیو: {str(e)}")
+
+        # اضافه کردن هندلر کیو
+        queue_handler = QueueLogHandler()
+        logger.addHandler(queue_handler)
+        logging.getLogger("urllib3").setLevel(logging.WARNING)
+        #logging.getLogger("requests").setLevel(logging.WARNING)
+        logging.getLogger("charset_normalizer").setLevel(logging.WARNING)
+        logging.getLogger("asyncio").setLevel(logging.WARNING)
+      
+        class StaticFileFilter(logging.Filter):
+            def filter(self, record):
+                if record.name == 'werkzeug':
+                    msg = record.getMessage()
+                    if ' /static/' in msg:  # فاصله قبل از /static/ برای جلوگیری از false positive
+                        return False
+                return True
+
+        logging.getLogger('werkzeug').addFilter(StaticFileFilter())
+        # شروع ترد برای ذخیره لاگ‌ها از کیو به دیتابیس
+        log_repository.start_queue_processor()

clean_logging/infrastructure/repositories/file_log_repository.py

@@ -0,0 +1,153 @@
+import os
+import queue
+import re
+import threading
+import time
+from datetime import datetime, timedelta, timezone
+from typing import Optional
+
+
+class FileLogRepository:
+    def __init__(
+        self,
+        log_dir: str = "files/logs",
+        retention_days: int = 3,
+        log_queue: Optional[queue.Queue] = None
+    ):
+        self.log_dir = log_dir
+        self.retention_days = retention_days
+        self.log_queue = log_queue
+        self._stop_event = threading.Event()
+        self._lock = threading.Lock()
+        self._last_cleanup = datetime.now(timezone.utc)
+
+        os.makedirs(self.log_dir, exist_ok=True)
+        self.delete_old_logs()
+
+    def _should_cleanup(self) -> bool:
+        now = datetime.now(timezone.utc)
+        return (now - self._last_cleanup) >= timedelta(hours=24)
+
+    def _cleanup_if_needed(self):
+        if self._should_cleanup():
+            self.delete_old_logs()
+            self._last_cleanup = datetime.now(timezone.utc)
+
+    def _get_log_filename(self) -> str:
+        today = datetime.now(timezone.utc).strftime("%Y-%m-%d")
+        return os.path.join(self.log_dir, f"app_{today}.log")
+    
+    def _write_log(self, log_entry: dict):
+        """نوشتن لاگ به صورت ساده: timestamp [LEVEL] message"""
+        timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S")
+        level = log_entry.get("level", "INFO").upper()
+        message = log_entry.get("message", "")
+
+        # فرمت: 2025-04-05 14:30:22 [INFO] پیام...
+        log_line = f"{timestamp} [{level}] {message}\n"
+
+        log_file = self._get_log_filename()
+        try:
+            with self._lock:
+                with open(log_file, "a", encoding="utf-8") as f:
+                    f.write(log_line)
+        except Exception as e:
+            print(f"[FileLogRepository] خطا در نوشتن لاگ: {e}")
+
+    def start_queue_processor(self):
+        if not self.log_queue:
+            print("[FileLogRepository] کیو تعریف نشده است.")
+            return
+
+        def process_queue():
+            while not self._stop_event.is_set():
+                try:
+                    log = self.log_queue.get(timeout=3)
+                    self._write_log({
+                        "level": log["level"],
+                        "message": log["message"],
+                        # سایر فیلدها (function_name و ...) نادیده گرفته می‌شوند
+                    })
+                    self.log_queue.task_done()
+                except queue.Empty:
+                    pass
+                except Exception as e:
+                    print(f"[FileQueueProcessor] خطا: {e}")
+                    time.sleep(1)
+
+                self._cleanup_if_needed()
+
+        thread = threading.Thread(target=process_queue, daemon=True)
+        thread.start()
+
+    def stop_queue_processor(self):
+        self._stop_event.set()
+
+    def get_logs(self, limit: int = 20, offset: int = 0) -> list:
+        """
+        خواندن لاگ‌ها و بازگرداندن به صورت لیستی از دیکشنری‌ها:
+        [
+            {"timestamp": "2025-04-05 14:30:22", "level": "INFO", "message": "..."},
+            ...
+        ]
+        """
+        logs = []
+        log_pattern = re.compile(r'^(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}) \[([A-Z]+)\] (.*)$')
+
+        try:
+            log_files = []
+            for i in range(self.retention_days):
+                date_str = (datetime.now(timezone.utc).date() - timedelta(days=i)).strftime("%Y-%m-%d")
+                file_path = os.path.join(self.log_dir, f"app_{date_str}.log")
+                if os.path.exists(file_path):
+                    log_files.append(file_path)
+
+            # خواندن از جدیدترین فایل به قدیمی‌ترین
+            for log_file in log_files:
+                with open(log_file, "r", encoding="utf-8") as f:
+                    lines = f.readlines()
+                    # معکوس کردن خطوط هر فایل برای جدیدترین اول
+                    for line in reversed(lines):
+                        line = line.strip()
+                        if not line:
+                            continue
+                        match = log_pattern.match(line)
+                        if match:
+                            timestamp, level, message = match.groups()
+                            logs.append({
+                                "timestamp": timestamp,
+                                "level": level,
+                                "message": message
+                            })
+                        # اگر خط فرمت استاندارد نداشت، نادیده گرفته می‌شود
+
+            return logs[offset:offset + limit]
+
+        except Exception as e:
+            print(f"[FileLogRepository] خطا در خواندن لاگ‌ها: {e}")
+            return []
+
+    def delete_old_logs(self):
+        try:
+            cutoff = datetime.now(timezone.utc).date() - timedelta(days=self.retention_days)
+            for filename in os.listdir(self.log_dir):
+                if filename.startswith("app_") and filename.endswith(".log"):
+                    try:
+                        date_str = filename.replace("app_", "").replace(".log", "")
+                        log_date = datetime.strptime(date_str, "%Y-%m-%d").date()
+                        if log_date < cutoff:
+                            os.remove(os.path.join(self.log_dir, filename))
+                    except Exception:
+                        continue
+            self._last_cleanup = datetime.now(timezone.utc)
+        except Exception as e:
+            print(f"[FileLogRepository] خطا در حذف فایل‌های قدیمی: {e}")
+
+    def get_total_log_count(self) -> int:
+        # اگر نیاز به شمارش دقیق دارید، می‌توانید خطوط را بشمارید
+        # ولی برای سادگی همچنان 100 برمی‌گردانیم
+        return 1000
+        
+    def close_connection(self):
+        self.stop_queue_processor()
+        self.delete_old_logs()

clean_logging-0.3.0.dist-info/METADATA

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: clean_logging
+Version: 0.3.0
+Summary: A clean, modular, and interface-driven logging utility for Clean Architecture projects
+Author-email: qasem <qasemt@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/qasemt/clean_logging
+Project-URL: Repository, https://github.com/qasemt/clean_logging
+Project-URL: Documentation, https://github.com/qasemt/clean_logging#readme
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown

clean_logging-0.3.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+clean_logging/__init__.py,sha256=TitWZSGyPrpKT42dDeCUHXjUoDaMikLt2pNLmK8_zSw,173
+clean_logging/core/interfaces/log_repository_interface.py,sha256=kmD5ECSmAZp15fXMcsPgA84m3fER3J41WXtz0ddH0Uw,443
+clean_logging/infrastructure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clean_logging/infrastructure/loggin_setup.py,sha256=V0_BgXoj3kGu4rewqKwntH4yyjferhRjuTlr5xfqLZw,3477
+clean_logging/infrastructure/repositories/file_log_repository.py,sha256=g4QnyURa1_Y8UI-8J1nSQQZw__IN2bpaBWrev6OmVTY,6244
+clean_logging-0.3.0.dist-info/METADATA,sha256=vfH1vlTkdiv5LulZ7rCESveX-GSSoilO7LfGz_f_NTw,1026
+clean_logging-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clean_logging-0.3.0.dist-info/top_level.txt,sha256=lyi6HJxeiSbpxFxX4npEWPZTBls4Qaq7dyzF7w1zqRs,14
+clean_logging-0.3.0.dist-info/RECORD,,

clean_logging-0.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

clean_logging-0.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+clean_logging