dycw-utilities 0.164.0__tar.gz → 0.164.1__tar.gz

{dycw_utilities-0.164.0 → dycw_utilities-0.164.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.164.0
+Version: 0.164.1
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.164.0 → dycw_utilities-0.164.1}/pyproject.toml

@@ -232,7 +232,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.164.0"
+version = "0.164.1"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -265,7 +265,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.164.0"
+current_version = "0.164.1"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.164.0 → dycw_utilities-0.164.1}/src/tests/test_logging.py

@@ -1,14 +1,15 @@
 from __future__ import annotations
 
 from asyncio import sleep
+from dataclasses import dataclass, field
 from io import StringIO
-from logging import Formatter, StreamHandler, getLogger
+from logging import Formatter, LoggerAdapter, StreamHandler, getLogger
 from pathlib import Path
 from re import search
 from typing import TYPE_CHECKING, Any, cast
 
 from hypothesis import given
-from hypothesis.strategies import booleans, integers
+from hypothesis.strategies import integers
 from pytest import LogCaptureFixture, mark, param, raises
 
 from tests.conftest import SKIPIF_CI_AND_WINDOWS
@@ -20,6 +21,7 @@ from utilities.logging import (
     _compute_rollover_actions,
     _FieldStyleKeys,
     _RotatingLogFile,
+    add_adapter,
     add_filters,
     basic_config,
     get_format_str,
@@ -41,14 +43,37 @@ if TYPE_CHECKING:
     from whenever import ZonedDateTime
 
 
+class TestAddAdapter:
+    def test_main(self, *, caplog: LogCaptureFixture) -> None:
+        logger = getLogger(name := unique_str())
+        logger.setLevel("DEBUG")
+
+        def process(msg: str, x: int, /) -> str:
+            return f"x={x}: {msg}"
+
+        @dataclass
+        class Example:
+            x: int = 0
+            logger: LoggerAdapter = field(init=False)
+
+            def __post_init__(self) -> None:
+                self.logger = add_adapter(logger, process, self.x)
+                self.logger.info("Initializing...")
+
+        _ = Example()
+        record = one(r for r in caplog.records if r.name == name)
+        assert record.message == "x=0: Initializing..."
+
+
 class TestAddFilters:
-    @given(expected=booleans())
+    @mark.parametrize("expected", [param(True), param(False)])
     def test_main(self, *, expected: bool) -> None:
         logger = getLogger(unique_str())
         logger.addHandler(handler := StreamHandler(buffer := StringIO()))
+        logger.setLevel("DEBUG")
         add_filters(handler, lambda _: expected)
         assert len(handler.filters) == 1
-        logger.warning("message")
+        logger.info("message")
         result = buffer.getvalue() != ""
         assert result is expected
 

{dycw_utilities-0.164.0 → dycw_utilities-0.164.1}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.164.0"
+__version__ = "0.164.1"

{dycw_utilities-0.164.0 → dycw_utilities-0.164.1}/src/utilities/logging.py

@@ -8,6 +8,7 @@ from logging import (
     Formatter,
     Handler,
     Logger,
+    LoggerAdapter,
     LogRecord,
     StreamHandler,
     basicConfig,
@@ -22,6 +23,7 @@ from socket import gethostname
 from typing import (
     TYPE_CHECKING,
     Any,
+    Concatenate,
     Literal,
     NotRequired,
     Self,
@@ -53,7 +55,7 @@ from utilities.whenever import (
 )
 
 if TYPE_CHECKING:
-    from collections.abc import Iterable, Mapping
+    from collections.abc import Callable, Iterable, Mapping, MutableMapping
     from datetime import time
     from logging import _FilterType
 
@@ -63,6 +65,7 @@ if TYPE_CHECKING:
         MaybeCallablePathLike,
         MaybeIterable,
         PathLike,
+        StrMapping,
     )
 
 
@@ -75,6 +78,35 @@ _DEFAULT_WHEN: _When = "D"
 ##
 
 
+def add_adapter[**P](
+    logger: Logger,
+    process: Callable[Concatenate[str, P], str],
+    /,
+    *args: P.args,
+    **kwargs: P.kwargs,
+) -> LoggerAdapter:
+    """Add an adapter to a logger."""
+
+    class CustomAdapter(LoggerAdapter):
+        @override
+        def process(
+            self, msg: str, kwargs: MutableMapping[str, Any]
+        ) -> tuple[str, MutableMapping[str, Any]]:
+            extra = cast("_ArgsAndKwargs", self.extra)
+            new_msg = process(msg, *extra["args"], **extra["kwargs"])
+            return new_msg, kwargs
+
+    return CustomAdapter(logger, extra=_ArgsAndKwargs(args=args, kwargs=kwargs))
+
+
+class _ArgsAndKwargs(TypedDict):
+    args: tuple[Any, ...]
+    kwargs: StrMapping
+
+
+##
+
+
 def add_filters(handler: Handler, /, *filters: _FilterType) -> None:
     """Add a set of filters to a handler."""
     for filter_i in filters:
@@ -589,6 +621,7 @@ def to_logger(logger: LoggerLike | None = None, /) -> Logger:
 __all__ = [
     "GetLoggingLevelNumberError",
     "SizeAndTimeRotatingFileHandler",
+    "add_adapter",
     "add_filters",
     "basic_config",
     "get_format_str",

{dycw_utilities-0.164.0 → dycw_utilities-0.164.1}/src/utilities/typing.py

@@ -333,7 +333,7 @@ def is_instance_gen(
                 warn_name_errors=warn_name_errors,
             )
             for t in type_
-        )  # skipif-ci-and-not-windows
+        )
     if is_literal_type(type_):
         return obj in get_args(type_)
     if is_union_type(type_):