logging-ext2 0.0.1__py3-none-any.whl → 0.1.0__py3-none-any.whl

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.0"

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/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.0.1.dist-info → logging_ext2-0.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: logging-ext2
-Version: 0.0.1
+Version: 0.1.0
 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

logging_ext2-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+logging_ext2/__about__.py,sha256=1RdZckQx6I2F1xvr1wmGF9zZKGRTU0NyAEl0IEUEwOs,121
+logging_ext2/__init__.py,sha256=BA6rgdmh3z2v01cbHU1FRMsBIRV5vQjh2w9FzG2F2GY,99
+logging_ext2/handlers.py,sha256=lG5CnPSO0fYouzmwfReASCCRzZzLv7gwKY8WCJHImy0,2426
+logging_ext2/types.py,sha256=cLjODjTgxrZEXUZzOkrFm3s6bUG3Itc_fS7KJ-MSWC8,237
+logging_ext2-0.1.0.dist-info/METADATA,sha256=4pcS8ViOlx2VcFk6lZ2MxV1GbjzHOaA4sfSLjHh8RTE,1444
+logging_ext2-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+logging_ext2-0.1.0.dist-info/licenses/LICENSE,sha256=RckqF9bdq7oO9RrL4iZYuXNhkIcXexbXNF2ToiaJymU,1067
+logging_ext2-0.1.0.dist-info/RECORD,,

logging_ext2-0.0.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-logging_ext2/__about__.py,sha256=ukYgyXwD_W0QxMVx6Epm_vepx0sXhPK3A5dPE1PkIGw,121
-logging_ext2/__init__.py,sha256=BA6rgdmh3z2v01cbHU1FRMsBIRV5vQjh2w9FzG2F2GY,99
-logging_ext2-0.0.1.dist-info/METADATA,sha256=9wlVkWAIItOLdspWsvbTBbzf_udLkQNjIvvGkSTVyIQ,1444
-logging_ext2-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-logging_ext2-0.0.1.dist-info/licenses/LICENSE,sha256=RckqF9bdq7oO9RrL4iZYuXNhkIcXexbXNF2ToiaJymU,1067
-logging_ext2-0.0.1.dist-info/RECORD,,