fix: Use the standard logger and remove the print based logger

Author: abeiderman

src/configdirector/__init__.py

@@ -25,7 +25,6 @@
     ConfigDirectorTypeError,
     ConfigDirectorValidationError,
 )
-from .logger import ConsoleLogger, create_console_logger, get_default_logger
 from .types import (
     ClientEvent,
     ClientHooks,
@@ -41,7 +40,6 @@
     ConnectionOptions,
     Context,
     EvaluationReason,
-    LoggingLevel,
     Metadata,
     Subscription,
     TelemetryOptions,
@@ -67,16 +65,12 @@
     "ConfigsUpdatedEvent",
     "ConnectionMode",
     "ConnectionOptions",
-    "ConsoleLogger",
     "Context",
     "EvaluationReason",
-    "LoggingLevel",
     "Metadata",
     "Subscription",
     "TelemetryOptions",
     "WatchHandler",
     "__version__",
     "create_client",
-    "create_console_logger",
-    "get_default_logger",
 ]

src/configdirector/_evaluation/config_evaluator.py

@@ -35,12 +35,6 @@ class _RuleResult:
 
 class ConfigEvaluator:
     def __init__(self, logger: ConfigDirectorLogger) -> None:
-        for method in ("debug", "info", "warning", "error"):
-            if not callable(getattr(logger, method, None)):
-                raise TypeError(
-                    f"The provided logger is not a valid ConfigDirectorLogger: it has no "
-                    f"callable '{method}' method."
-                )
         self._logger = logger
         self._condition_evaluator = ConditionEvaluator()
 

src/configdirector/_eventsource/client.py

@@ -9,7 +9,6 @@
 from typing import Any, TypeVar
 
 from ..errors import ConfigDirectorTypeError
-from ..logger import get_default_logger
 from ..types import ConfigDirectorLogger
 from .errors import StreamClosedError, ValueOutOfRangeError
 from .parser import DEFAULT_MAX_EVENT_CHARS, DEFAULT_MAX_LINE_CHARS, EventSourceParser
@@ -52,7 +51,7 @@ def __init__(
         read_timeout: float | None = None,
         follow_redirects: bool = True,
         transport: Callable[[StreamRequest], ResponseStream] = open_stream,
-        logger: ConfigDirectorLogger | None = None,
+        logger: ConfigDirectorLogger,
         on_connect: Callable[[], None] | None = None,
         on_disconnect: Callable[[], None] | None = None,
         on_message: Callable[[EventSourceMessage], None] | None = None,
@@ -73,7 +72,7 @@ def __init__(
         self._read_timeout = read_timeout
         self._follow_redirects = follow_redirects
         self._transport = transport
-        self._logger = logger if logger is not None else get_default_logger()
+        self._logger = logger
         self._max_line_chars = max_line_chars
         self._max_event_chars = max_event_chars
 

src/configdirector/_logger.py

@@ -0,0 +1,13 @@
+import logging
+
+
+def get_default_logger(log_level: int | str | None = None) -> logging.Logger:
+    """Return the standard library logger the SDK uses when none is supplied.
+
+    Configure it like any other logger::
+
+        logging.getLogger("configdirector").setLevel(logging.DEBUG)
+    """
+    logger = logging.getLogger(__name__)
+    logger.setLevel(logging.WARNING if log_level is None else log_level)
+    return logger

src/configdirector/client.py

@@ -12,6 +12,7 @@
 
 from ._bundle import ConfigBundle
 from ._evaluation import Config, ConfigEvaluator, EvaluationContext
+from ._logger import get_default_logger
 from ._telemetry import (
     MAX_EVENT_QUEUE_LIMIT,
     MIN_EVENT_QUEUE_LIMIT,
@@ -22,7 +23,6 @@
 from ._value_parser import parse_config_value
 from ._version import SDK_NAME, __version__
 from .errors import ConfigDirectorTypeError, ConfigDirectorValidationError
-from .logger import get_default_logger
 from .types import (
     ClientEvent,
     ClientHooks,
@@ -95,10 +95,11 @@ def __init__(
         metadata: Metadata | None = None,
         connection: ConnectionOptions | None = None,
         logger: ConfigDirectorLogger | None = None,
+        log_level: int | str | None = None,
         telemetry: TelemetryOptions | None = None,
         hooks: ClientHooks | None = None,
     ) -> None:
-        self._logger = logger if logger is not None else get_default_logger()
+        self._logger = logger if logger is not None else get_default_logger(log_level)
         if _is_blank(server_sdk_key):
             raise ConfigDirectorValidationError(
                 "No server SDK key was provided, the client cannot be instantiated without a "

src/configdirector/logger.py

@@ -23,7 +23,6 @@
     "ConnectionOptions",
     "Context",
     "EvaluationReason",
-    "LoggingLevel",
     "Metadata",
     "Subscription",
     "TelemetryOptions",
@@ -51,9 +50,6 @@
 ConnectionMode = Literal["streaming", "polling", "one-time"]
 """How the SDK retrieves config state from ConfigDirector."""
 
-LoggingLevel = Literal["debug", "info", "warning", "error", "off"]
-"""Verbosity of the SDK's console logger."""
-
 EvaluationReason = Literal[
     "found-match",
     "config-state-missing",

src/configdirector/types.py

@@ -16,7 +16,7 @@
     TargetingRules,
 )
 
-from .helpers import create_stubbed_logger
+from helpers import create_stubbed_logger
 
 CONFIG_ID = "11111111-1111-4111-8111-111111111111"
 

tests/evaluation/helpers.py

@@ -17,10 +17,13 @@
 )
 
 from .helpers import FailingTransport, FakeResponse, FakeTransport, sse, wait_for
+from helpers import create_stubbed_logger
 
 URL = "http://localhost/sse"
 _R = TypeVar("_R")
 
+logger = create_stubbed_logger()
+
 
 def record(sink: list[Any], attribute: str | None, *, returning: _R) -> Callable[[ReconnectionState], _R]:
     def handler(state: ReconnectionState) -> _R:
@@ -49,6 +52,7 @@ def clients() -> Iterator[list[EventSourceClient]]:
 
 
 def build(clients: list[EventSourceClient], **kwargs: object) -> EventSourceClient:
+    kwargs.setdefault("logger", logger)
     client = EventSourceClient(URL, **kwargs)  # type: ignore[arg-type]
     clients.append(client)
     return client
@@ -606,7 +610,7 @@ class TestInvalidOptions:
     )
     def test_a_non_callable_handler_is_rejected(self, option: str) -> None:
         with pytest.raises(ConfigDirectorTypeError, match=option):
-            EventSourceClient(URL, **{option: "not callable"})  # type: ignore[arg-type]
+            EventSourceClient(URL, logger=logger, **{option: "not callable"})  # type: ignore[arg-type]
 
 
 class TestConcurrentLifecycle: