Cleanup and removing some support for older configurations

Author: crimsonknave

.github/workflows/pytest.yaml

@@ -14,16 +14,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        # pytest-forked does not work on windows and we currently use it for isolation
-        # of logging configs as logging.dictConfig has a setting to not disable old loggers
-        # but, does seem to trample old handlers, filters and formatters
-        os: [ubuntu-latest, macos-latest]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "pypy3.9", "pypy3.10"]
-        exclude:
-          - os: macos-latest
-            python-version: "3.9"
-          - os: windows-latest
-            python-version: "3.9"
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v4

SUPPORT.md

@@ -6,7 +6,7 @@ This project uses GitHub issues to track bugs and feature requests. Please searc
 
 For help or questions about using this project, please create an issue or discussion.
 
-- Annotated Logger is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner.
+Annotated Logger is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner.
 
 ## GitHub Support Policy
 

annotated_logger/__init__.py

@@ -24,7 +24,7 @@
 from makefun import wraps
 
 from annotated_logger.filter import AnnotatedFilter
-from annotated_logger.plugins import BasePlugin, RuntimeAnnotationsPlugin
+from annotated_logger.plugins import BasePlugin
 
 if TYPE_CHECKING:  # pragma: no cover
     from collections.abc import MutableMapping
@@ -255,8 +255,6 @@ class AnnotatedLogger:
     Args:
     ----
         annotations: Dictionary of annotations to be added to every log message
-        runtime_annotations: [Deprecated] Dictionary of method references to be called
-            when a log message is emitted. Use the `RuntimeAnnotationsPlugin` instead.
         plugins: list of plugins to use
 
     Methods:
@@ -271,10 +269,7 @@ class AnnotatedLogger:
     def __init__(  # noqa: PLR0913
         self,
         annotations: dict[str, Any] | None = None,
-        runtime_annotations: dict[str, Callable[[logging.LogRecord], Any]]
-        | None = None,
         plugins: list[BasePlugin] | None = None,
-        formatter: logging.Formatter | None = None,
         max_length: int | None = None,
         log_level: int = logging.INFO,
         name: str = "annotated_logger",
@@ -285,9 +280,7 @@ def __init__(  # noqa: PLR0913
         Args:
         ----
         annotations: Dictionary of static annotations - default None
-        runtime_annotations: Dictionary of dynamic annotations - default None
         plugins: List of plugins to be applied - default [BasePlugin]
-        formatter: Formatter for the handler. If none is provided a JsonFormatter
             is created and used - default None
         max_length: Integer, maximum length of a message before it's broken into
             multiple message and log calls. - default None
@@ -315,12 +308,6 @@ def __init__(  # noqa: PLR0913
         self.annotations = annotations or {}
         self.plugins = [BasePlugin()]
         self.plugins.extend(plugins)
-        # Preserve the `runtime_annotations` param for backwards compat
-        if runtime_annotations:
-            self.plugins.append(RuntimeAnnotationsPlugin(runtime_annotations))
-        if formatter and config:
-            msg = "Cannot pass both formatter and config."
-            raise ValueError(msg)
 
         if config is None:
             config = deepcopy(DEFAULT_LOGGING_CONFIG)

example/invalid_order.py

@@ -1,9 +1,8 @@
 from annotated_logger import AnnotatedAdapter, AnnotatedLogger
-from annotated_logger.plugins import RemoverPlugin
 
 # Actions runs in async.io it appears and that inejcts `taskName`
 # But, locally that's not there, so it messes up the absent all tests
-annotated_logger = AnnotatedLogger(plugins=[RemoverPlugin(["taskName"])])
+annotated_logger = AnnotatedLogger()
 
 annotate_logs = annotated_logger.annotate_logs
 

example/logging_config.py

@@ -159,8 +159,10 @@ def runtime(_record: logging.LogRecord) -> str:
     # This param is kept for backwards compatibility and creates a
     # RuntimeAnnotationsPlugin instead.
     # This is left as an example and to provide test coverage.
-    runtime_annotations={"runtime": runtime},
-    plugins=[RenamerPlugin(time="created", lvl="levelname")],
+    plugins=[
+        RenamerPlugin(time="created", lvl="levelname"),
+        RuntimeAnnotationsPlugin({"runtime": runtime}),
+    ],
     log_level=logging.DEBUG,
     max_length=200,
     name="annotated_logger.logging_config",

notes.md

@@ -1,6 +1,7 @@
 import logging
 
 from annotated_logger import AnnotatedLogger
+from annotated_logger.plugins import RuntimeAnnotationsPlugin
 
 
 def runtime(_record: logging.LogRecord):
@@ -9,7 +10,7 @@ def runtime(_record: logging.LogRecord):
 
 annotated_logger = AnnotatedLogger(
     annotations={"extra": "new data"},
-    runtime_annotations={"runtime": runtime},
+    plugins=[RuntimeAnnotationsPlugin({"runtime": runtime})],
 )
 
 annotate_logs = annotated_logger.annotate_logs

test/demo.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import logging
 from typing import TYPE_CHECKING
 
 import pytest
@@ -10,7 +9,6 @@
 import example.calculator
 import example.default
 import test.demo
-from annotated_logger import AnnotatedLogger
 from annotated_logger.plugins import RuntimeAnnotationsPlugin
 
 if TYPE_CHECKING:
@@ -620,10 +618,3 @@ def test_annotated_logger_must_be_first(self):
             TypeError, match="^annotated_logger must be the first argument$"
         ):
             import example.invalid_order  # noqa: F401
-
-    def test_cannot_use_both_formatter_and_config(self):
-        formatter = logging.Formatter("%(time)s %(lvl)s %(name)s %(message)s")
-        with pytest.raises(
-            ValueError, match="^Cannot pass both formatter and config.$"
-        ):
-            AnnotatedLogger(formatter=formatter, config={"logging": "config"})