logging-ext2 0.0.1__tar.gz → 0.1.1__tar.gz

{logging_ext2-0.0.1 → logging_ext2-0.1.1}/.gitignore

@@ -172,3 +172,5 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+*.log.*

{logging_ext2-0.0.1 → logging_ext2-0.1.1}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: logging-ext2
-Version: 0.0.1
+Version: 0.1.1
 Summary: extend python logging library
-Project-URL: Documentation, https://github.com/Xiang Wang/logging-ext2#readme
-Project-URL: Issues, https://github.com/Xiang Wang/logging-ext2/issues
-Project-URL: Source, https://github.com/Xiang Wang/logging-ext2
+Project-URL: Documentation, https://github.com/ramwin/logging-ext2#readme
+Project-URL: Issues, https://github.com/ramwin/logging-ext2/issues
+Project-URL: Source, https://github.com/ramwin/logging-ext2
 Author-email: Xiang Wang <ramwin@qq.com>
 License-Expression: MIT
 License-File: LICENSE

{logging_ext2-0.0.1 → logging_ext2-0.1.1}/pyproject.toml

@@ -27,9 +27,9 @@ classifiers = [
 dependencies = []
 
 [project.urls]
-Documentation = "https://github.com/Xiang Wang/logging-ext2#readme"
-Issues = "https://github.com/Xiang Wang/logging-ext2/issues"
-Source = "https://github.com/Xiang Wang/logging-ext2"
+Documentation = "https://github.com/ramwin/logging-ext2#readme"
+Issues = "https://github.com/ramwin/logging-ext2/issues"
+Source = "https://github.com/ramwin/logging-ext2"
 
 [tool.hatch.version]
 path = "src/logging_ext2/__about__.py"

{logging_ext2-0.0.1 → logging_ext2-0.1.1}/src/logging_ext2/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present Xiang Wang <ramwin@qq.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.0.1"
+__version__ = "0.1.1"

logging_ext2-0.1.1/src/logging_ext2/handlers.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Xiang Wang <ramwin@qq.com>
+
+
+import datetime
+import subprocess
+
+from logging import Handler, NOTSET
+from pathlib import Path
+from .types import PathWithDatetime
+
+
+class TimedRotatingFileHandler(Handler):
+    """
+    compare to logging.TimedRotatingFileHandler, this handler will write
+    log directly to file like 'info.log.2025-04-19'.
+    """
+
+    def __init__(self, level=NOTSET, filename="log.log",
+                 datetime_formatter="%Y-%m-%d", max_keep=10, flat_keep=2):
+        """
+        params:
+            max_keep: how many files will the rotation keep
+            flat_keep: how many files will stay in text mod, the other (max_keep-flat_keep) will be compressed using gzip
+        """
+        self.filename = Path(filename).name
+        self.base_dir = Path(filename).parent
+        self.datetime_formatter = datetime_formatter
+        self.current_time_str = self.get_time_str()
+        self.stream = self.init_stream()
+        self.max_keep = max_keep
+        self.flat_keep = flat_keep
+        super().__init__(level)
+
+    def init_stream(self):
+        filepath = self.base_dir.joinpath(
+                f"{self.filename}.{self.get_time_str()}")
+        return open(filepath, "a")
+
+    def get_time_str(self) -> str:
+        return datetime.datetime.now().strftime(self.datetime_formatter)
+
+    def emit(self, record):
+        if self.should_rollover():
+            self.do_rollover()
+        self.stream.write(self.format(record) + "\n")
+        self.stream.flush()
+
+    def should_rollover(self) -> bool:
+        new_time_str = self.get_time_str()
+        return new_time_str != self.current_time_str
+
+    def do_rollover(self):
+        self.stream.close()
+        paths: List[Path] = [
+                i
+                for i in self.base_dir.iterdir()
+                if i.is_file() and i.name.startswith(self.filename)
+        ]
+        paths.sort(key=lambda x: x.name, reverse=True)
+        to_delete: Path
+        for to_delete in paths[self.max_keep:]:
+            to_delete.unlink(missing_ok=True)
+        for to_gzip_path in paths[self.flat_keep:self.max_keep]:
+            # here use the system gzip command to ignore exceptions like
+            # permission denied or file not found
+            if to_gzip_path.suffix == ".gz":
+                continue
+            subprocess.run(["gzip", to_gzip_path])
+        self.stream = self.init_stream()

logging_ext2-0.1.1/src/logging_ext2/types.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Xiang Wang <ramwin@qq.com>
+
+
+import datetime
+from dataclasses import dataclass
+from pathlib import Path
+
+
+@dataclass
+class PathWithDatetime:
+    path: Path
+    datetime: datetime.datetime

logging_ext2-0.1.1/tests/__init__.py

@@ -0,0 +1,51 @@
+# SPDX-FileCopyrightText: 2025-present Xiang Wang <ramwin@qq.com>
+#
+# SPDX-License-Identifier: MIT
+
+import logging
+import time
+import unittest
+from logging_ext2.handlers import TimedRotatingFileHandler
+
+
+class Test(unittest.TestCase):
+
+    def test(self):
+        loggera = logging.getLogger("loggera")
+        handlera = TimedRotatingFileHandler(
+            filename="tests/info.log",
+            datetime_formatter="%Y-%m-%d_%H:%M:%S",
+            max_keep=5, flat_keep=2)
+        loggera.addHandler(logging.StreamHandler())
+        loggera.addHandler(handlera)
+        loggera.setLevel(logging.INFO)
+        handlera.setFormatter(logging.Formatter("%(lineno)d %(process)d %(asctime)s %(message)s"))
+
+        loggerb = logging.getLogger("loggerb")
+        loggerb.addHandler(TimedRotatingFileHandler(
+            filename="tests/info.log",
+            datetime_formatter="%Y-%m-%d_%H:%M:%S",
+            max_keep=5, flat_keep=2))
+        loggerb.addHandler(logging.StreamHandler())
+        loggerb.setLevel(logging.INFO)
+
+        loggera.info("first")
+        loggera.info("second")
+        loggera.info("third")
+        loggerb.info("first")
+        loggerb.info("second")
+        loggerb.info("third")
+        time.sleep(1)
+        loggera.info("first")
+        loggera.info("second")
+        loggera.info("third")
+        loggerb.info("first")
+        loggerb.info("second")
+        loggerb.info("third")
+        time.sleep(1)
+        loggera.info("first")
+        loggera.info("second")
+        loggera.info("third")
+        loggerb.info("first")
+        loggerb.info("second")
+        loggerb.info("third")

logging_ext2-0.0.1/tests/__init__.py

@@ -1,3 +0,0 @@
-# SPDX-FileCopyrightText: 2025-present Xiang Wang <ramwin@qq.com>
-#
-# SPDX-License-Identifier: MIT