dycw-utilities 0.129.7__tar.gz → 0.129.8__tar.gz

{dycw_utilities-0.129.7 → dycw_utilities-0.129.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.129.7
+Version: 0.129.8
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
@@ -98,7 +98,6 @@ Requires-Dist: polars-lts-cpu<1.31,>=1.30.0; extra == 'zzz-test-jupyter'
 Provides-Extra: zzz-test-logging
 Requires-Dist: atomicwrites<1.5,>=1.4.1; extra == 'zzz-test-logging'
 Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'zzz-test-logging'
-Requires-Dist: concurrent-log-handler<0.10,>=0.9.26; extra == 'zzz-test-logging'
 Requires-Dist: rich<14.1,>=14.0.0; extra == 'zzz-test-logging'
 Requires-Dist: tomlkit<0.14,>=0.13.2; extra == 'zzz-test-logging'
 Requires-Dist: tzlocal<5.4,>=5.3.1; extra == 'zzz-test-logging'

{dycw_utilities-0.129.7 → dycw_utilities-0.129.8}/pyproject.toml

@@ -17,7 +17,6 @@ dev = [
   "cachetools >= 5.5.2, < 5.6",
   "click >= 8.2.1, < 8.3",
   "coloredlogs >= 15.0.1, < 15.1",
-  "concurrent-log-handler >= 0.9.26, < 0.10",
   "cryptography >= 45.0.3, < 45.1",
   "cvxpy >= 1.6.5, < 1.7",
   "eventkit >= 1.0.3, < 1.1",
@@ -94,7 +93,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.129.7"
+version = "0.129.8"
 
 [project.optional-dependencies]
 test = [
@@ -197,7 +196,6 @@ zzz-test-jupyter = [
 zzz-test-logging = [
   "atomicwrites >= 1.4.1, < 1.5",
   "coloredlogs >= 15.0.1, < 15.1",
-  "concurrent-log-handler >= 0.9.26, < 0.10",
   "rich >= 14.0.0, < 14.1",
   "tomlkit >= 0.13.2, < 0.14",
   "tzlocal >= 5.3.1, < 5.4",
@@ -334,7 +332,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.129.7"
+current_version = "0.129.8"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.129.7 → dycw_utilities-0.129.8}/src/tests/test_logging.py

@@ -73,9 +73,13 @@ class TestAddFilters:
 
 class TestBasicConfig:
     @mark.parametrize("log", [param(True), param(False)])
-    def test_main(self, *, caplog: LogCaptureFixture, log: bool) -> None:
+    @mark.parametrize("whenever", [param(True), param(False)])
+    @mark.parametrize("plain", [param(True), param(False)])
+    def test_main(
+        self, *, caplog: LogCaptureFixture, log: bool, whenever: bool, plain: bool
+    ) -> None:
         logger = unique_str() if log else None
-        basic_config(logger=logger)
+        basic_config(obj=logger, whenever=whenever, plain=plain)
         logger_use = getLogger()
         logger_use.warning("message")
         assert "message" in caplog.messages
@@ -484,6 +488,13 @@ class TestSizeAndTimeRotatingFileHandler:
             content = fh.read()
         assert content == "message\n"
 
+    @skipif_windows
+    def test_create_parents(self, *, tmp_path: Path) -> None:
+        logger = getLogger(unique_str())
+        filename = tmp_path.joinpath("foo", "bar", "bar", "log")
+        logger.addHandler(SizeAndTimeRotatingFileHandler(filename=filename))
+        assert filename.exists()
+
     @skipif_windows
     def test_size(self, *, tmp_path: Path) -> None:
         logger = getLogger(unique_str())

{dycw_utilities-0.129.7 → dycw_utilities-0.129.8}/src/tests/test_whenever.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import datetime as dt
 from datetime import timezone
+from logging import getLogger, setLogRecordFactory
 from re import escape
 from typing import TYPE_CHECKING
 from zoneinfo import ZoneInfo
@@ -40,6 +41,7 @@ from utilities.hypothesis import (
     timedeltas_2w,
     zoned_datetimes,
 )
+from utilities.text import unique_str
 from utilities.tzdata import HongKong
 from utilities.whenever import (
     MAX_SERIALIZABLE_TIMEDELTA,
@@ -60,6 +62,7 @@ from utilities.whenever import (
     SerializePlainDateTimeError,
     SerializeTimeDeltaError,
     SerializeZonedDateTimeError,
+    WheneverLogRecord,
     _CheckValidZonedDateTimeUnequalError,
     _EnsureTimedeltaNanosecondError,
     _EnsureTimedeltaParseError,
@@ -492,3 +495,10 @@ class TestToDateTimeDelta:
             _ToDateTimeDeltaError, match="Unable to create DateTimeDelta; got .*"
         ):
             _ = _to_datetime_delta(timedelta)
+
+
+class TestWheneverLogRecord:
+    def test_main(self) -> None:
+        logger = getLogger(unique_str())
+        setLogRecordFactory(WheneverLogRecord)
+        logger.warning("message")

{dycw_utilities-0.129.7 → dycw_utilities-0.129.8}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.129.7"
+__version__ = "0.129.8"

{dycw_utilities-0.129.7 → dycw_utilities-0.129.8}/src/utilities/logging.py

@@ -107,8 +107,9 @@ class SizeAndTimeRotatingFileHandler(BaseRotatingHandler):
         utc: bool = False,
         atTime: dt.time | None = None,
     ) -> None:
-        filename = str(Path(filename))
-        super().__init__(filename, mode, encoding=encoding, delay=delay, errors=errors)
+        path = Path(filename)
+        path.parent.mkdir(parents=True, exist_ok=True)
+        super().__init__(path, mode, encoding=encoding, delay=delay, errors=errors)
         self._max_bytes = maxBytes if maxBytes >= 1 else None
         self._backup_count = backupCount if backupCount >= 1 else None
         self._filename = Path(self.baseFilename)
@@ -117,7 +118,7 @@ class SizeAndTimeRotatingFileHandler(BaseRotatingHandler):
         self._suffix = self._filename.suffix
         self._patterns = _compute_rollover_patterns(self._stem, self._suffix)
         self._time_handler = TimedRotatingFileHandler(
-            filename,
+            path,
             when=when,
             interval=interval,
             backupCount=backupCount,
@@ -415,26 +416,53 @@ def add_filters(handler: Handler, /, *filters: _FilterType) -> None:
 
 def basic_config(
     *,
-    logger: LoggerOrName | None = None,
+    obj: LoggerOrName | Handler | None = None,
     format_: str = "{asctime} | {name} | {levelname:8} | {message}",
+    whenever: bool = False,
     level: LogLevel = "INFO",
+    plain: bool = False,
 ) -> None:
     """Do the basic config."""
+    if whenever:
+        format_ = format_.replace("{asctime}", "{zoned_datetime}")
     datefmt = maybe_sub_pct_y("%Y-%m-%d %H:%M:%S")
-    if logger is None:
-        basicConfig(format=format_, datefmt=datefmt, style="{", level=level)
-    else:
-        logger_use = get_logger(logger=logger)
-        logger_use.setLevel(level)
-        logger_use.addHandler(handler := StreamHandler())
-        handler.setLevel(level)
-        try:
-            from coloredlogs import ColoredFormatter
-        except ModuleNotFoundError:  # pragma: no cover
-            formatter = Formatter(fmt=format_, datefmt=datefmt, style="{")
-        else:
-            formatter = ColoredFormatter(fmt=format_, datefmt=datefmt, style="{")
-        handler.setFormatter(formatter)
+    match obj:
+        case None:
+            basicConfig(format=format_, datefmt=datefmt, style="{", level=level)
+        case Logger() as logger:
+            logger.setLevel(level)
+            logger.addHandler(handler := StreamHandler())
+            basic_config(
+                obj=handler,
+                format_=format_,
+                whenever=whenever,
+                level=level,
+                plain=plain,
+            )
+        case str() as name:
+            basic_config(
+                obj=get_logger(logger=name),
+                format_=format_,
+                whenever=whenever,
+                level=level,
+                plain=plain,
+            )
+        case Handler() as handler:
+            handler.setLevel(level)
+            if plain:
+                formatter = Formatter(fmt=format_, datefmt=datefmt, style="{")
+            else:
+                try:
+                    from coloredlogs import ColoredFormatter
+                except ModuleNotFoundError:  # pragma: no cover
+                    formatter = Formatter(fmt=format_, datefmt=datefmt, style="{")
+                else:
+                    formatter = ColoredFormatter(
+                        fmt=format_, datefmt=datefmt, style="{"
+                    )
+            handler.setFormatter(formatter)
+        case _ as never:
+            assert_never(never)
 
 
 ##

{dycw_utilities-0.129.7 → dycw_utilities-0.129.8}/src/utilities/whenever.py

@@ -4,7 +4,9 @@ import datetime as dt
 import re
 from contextlib import suppress
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, override
+from functools import cache
+from logging import LogRecord
+from typing import TYPE_CHECKING, Any, override
 
 from whenever import (
     Date,
@@ -33,6 +35,8 @@ from utilities.re import (
 from utilities.zoneinfo import UTC, ensure_time_zone, get_time_zone_name
 
 if TYPE_CHECKING:
+    from zoneinfo import ZoneInfo
+
     from utilities.types import (
         DateLike,
         DateTimeLike,
@@ -561,6 +565,64 @@ class SerializeZonedDateTimeError(Exception):
 ##
 
 
+class WheneverLogRecord(LogRecord):
+    """Log record powered by `whenever`."""
+
+    zoned_datetime: str
+
+    @override
+    def __init__(
+        self,
+        name: str,
+        level: int,
+        pathname: str,
+        lineno: int,
+        msg: object,
+        args: Any,
+        exc_info: Any,
+        func: str | None = None,
+        sinfo: str | None = None,
+    ) -> None:
+        super().__init__(
+            name, level, pathname, lineno, msg, args, exc_info, func, sinfo
+        )
+        length = self._get_length()
+        plain = format(self._get_now().to_plain().format_common_iso(), f"{length}s")
+        time_zone = self._get_time_zone_key()
+        self.zoned_datetime = f"{plain}[{time_zone}]"
+
+    @classmethod
+    @cache
+    def _get_time_zone(cls) -> ZoneInfo:
+        """Get the local timezone."""
+        try:
+            from utilities.tzlocal import get_local_time_zone
+        except ModuleNotFoundError:  # pragma: no cover
+            return UTC
+        return get_local_time_zone()
+
+    @classmethod
+    @cache
+    def _get_time_zone_key(cls) -> str:
+        """Get the local timezone as a string."""
+        return cls._get_time_zone().key
+
+    @classmethod
+    @cache
+    def _get_length(cls) -> int:
+        """Get maximum length of a formatted string."""
+        now = cls._get_now().replace(nanosecond=1000).to_plain()
+        return len(now.format_common_iso())
+
+    @classmethod
+    def _get_now(cls) -> ZonedDateTime:
+        """Get the current zoned datetime."""
+        return ZonedDateTime.now(cls._get_time_zone().key)
+
+
+##
+
+
 def _to_datetime_delta(timedelta: dt.timedelta, /) -> DateTimeDelta:
     """Serialize a timedelta."""
     total_microseconds = datetime_duration_to_microseconds(timedelta)
@@ -610,6 +672,7 @@ __all__ = [
     "SerializePlainDateTimeError",
     "SerializeTimeDeltaError",
     "SerializeZonedDateTimeError",
+    "WheneverLogRecord",
     "check_valid_zoned_datetime",
     "ensure_date",
     "ensure_datetime",