@GitHK review: rename

Author: sanderegg

packages/pytest-simcore/src/pytest_simcore/logging.py

@@ -6,18 +6,18 @@
 
 import pytest
 from pytest_mock import MockerFixture
-from servicelib.logging_utils import setup_async_loggers_lifespan
+from servicelib.logging_utils import async_loggers
 
 
 @pytest.fixture(autouse=True)
 def preserve_caplog_for_async_logging(mocker: MockerFixture) -> None:
-    # Patch setup_async_loggers_lifespan to preserve caplog handlers,
+    # Patch async_loggers to preserve caplog handlers,
     # and pytest logs in general as pytest captures logs in a special way
     # that is not compatible with the queue handler used in async logging.
-    original_setup = setup_async_loggers_lifespan
+    original_setup = async_loggers
 
     @contextmanager
-    def patched_setup_async_loggers_lifespan(**kwargs) -> Iterator[None]:
+    def patched_async_loggers(**kwargs) -> Iterator[None]:
         # Find caplog's handler in root logger
         root_logger = logging.getLogger()
         caplog_handlers = [
@@ -32,11 +32,11 @@ def patched_setup_async_loggers_lifespan(**kwargs) -> Iterator[None]:
             yield
 
     methods_to_patch = [
-        "servicelib.logging_utils.setup_async_loggers_lifespan",
-        "servicelib.fastapi.logging_lifespan.setup_async_loggers_lifespan",
-        "tests.test_logging_utils.setup_async_loggers_lifespan",
+        "servicelib.logging_utils.async_loggers",
+        "servicelib.fastapi.logging_lifespan.async_loggers",
+        "tests.test_logging_utils.async_loggers",
     ]
     for method in methods_to_patch:
         with contextlib.suppress(AttributeError, ModuleNotFoundError):
             # Patch the method to use our patched version
-            mocker.patch(method, patched_setup_async_loggers_lifespan)
+            mocker.patch(method, patched_async_loggers)

packages/service-library/src/servicelib/fastapi/logging_lifespan.py

@@ -7,8 +7,8 @@
 
 from ..logging_utils import (
     LogLevelInt,
+    async_loggers,
     log_context,
-    setup_async_loggers_lifespan,
 )
 from ..logging_utils_filtering import LoggerName, MessageSubstring
 from .lifespan_utils import Lifespan
@@ -27,7 +27,7 @@ def logging_lifespan(
     """Returns a FastAPI-compatible lifespan handler to set up async logging."""
     exit_stack = AsyncExitStack()
     exit_stack.enter_context(
-        setup_async_loggers_lifespan(
+        async_loggers(
             log_base_level=log_base_level,
             noisy_loggers=noisy_loggers,
             log_format_local_dev_enabled=log_format_local_dev_enabled,
@@ -62,7 +62,7 @@ def setup_logging_shutdown_event(
     """
     exit_stack = AsyncExitStack()
     exit_stack.enter_context(
-        setup_async_loggers_lifespan(
+        async_loggers(
             log_base_level=log_base_level,
             noisy_loggers=noisy_loggers,
             log_format_local_dev_enabled=log_format_local_dev_enabled,

packages/service-library/src/servicelib/logging_utils.py

@@ -258,7 +258,7 @@ def setup_loggers(
 
 
 @contextmanager
-def setup_async_loggers_lifespan(
+def async_loggers(
     *,
     log_format_local_dev_enabled: bool,
     logger_filter_mapping: dict[LoggerName, list[MessageSubstring]],
@@ -270,7 +270,7 @@ def setup_async_loggers_lifespan(
     context manager for non-blocking logging infrastructure.
 
     Usage:
-        with setup_async_loggers_lifespan(log_format_local_dev_enabled=True, logger_filter_mapping={}, tracing_settings=None):
+        with async_loggers(log_format_local_dev_enabled=True, logger_filter_mapping={}, tracing_settings=None):
             # Your async application code here
             logger.info("This is non-blocking!")
 

packages/service-library/tests/test_logging_utils.py

@@ -13,12 +13,12 @@
     LogExtra,
     LogLevelInt,
     LogMessageStr,
+    async_loggers,
     guess_message_log_level,
     log_context,
     log_decorator,
     log_exceptions,
     set_parent_module_log_level,
-    setup_async_loggers_lifespan,
 )
 from tenacity import (
     retry,
@@ -443,7 +443,7 @@ def test_setup_async_loggers_basic(
     caplog.clear()
     caplog.set_level(logging.INFO)
 
-    with setup_async_loggers_lifespan(
+    with async_loggers(
         log_format_local_dev_enabled=log_format_local_dev_enabled,
         logger_filter_mapping={},  # No filters for this test
         tracing_settings=None,  # No tracing for this test
@@ -467,7 +467,7 @@ def test_setup_async_loggers_with_filters(
         "test_filtered_logger": ["filtered_message"],
     }
 
-    with setup_async_loggers_lifespan(
+    with async_loggers(
         log_format_local_dev_enabled=True,
         logger_filter_mapping=filter_mapping,
         tracing_settings=None,  # No tracing for this test
@@ -504,7 +504,7 @@ def test_setup_async_loggers_with_tracing_settings(
 
     # Note: We can't easily test actual tracing without setting up OpenTelemetry
     # But we can test that the function accepts the parameter
-    with setup_async_loggers_lifespan(
+    with async_loggers(
         log_format_local_dev_enabled=False,
         logger_filter_mapping={},  # No filters for this test
         tracing_settings=None,
@@ -526,7 +526,7 @@ def test_setup_async_loggers_context_manager_cleanup(
 
     test_logger = logging.getLogger("test_cleanup_logger")
 
-    with setup_async_loggers_lifespan(
+    with async_loggers(
         log_format_local_dev_enabled=True,
         logger_filter_mapping={},
         tracing_settings=None,
@@ -552,7 +552,7 @@ def _raise_test_exception():
         raise ValueError(exc_msg)
 
     try:
-        with setup_async_loggers_lifespan(
+        with async_loggers(
             log_format_local_dev_enabled=True,
             logger_filter_mapping={},
             tracing_settings=None,

services/web/server/src/simcore_service_webserver/log.py

@@ -8,7 +8,7 @@
 from aiodebug import log_slow_callbacks  # type: ignore[import-untyped]
 from aiohttp import web
 from aiohttp.log import access_logger
-from servicelib.logging_utils import setup_async_loggers_lifespan
+from servicelib.logging_utils import async_loggers
 from simcore_service_webserver.application_settings import ApplicationSettings
 
 _NOISY_LOGGERS: Final[tuple[str, ...]] = (
@@ -33,7 +33,7 @@
 def setup_logging(app_settings: ApplicationSettings) -> CleanupEvent:
     exit_stack = AsyncExitStack()
     exit_stack.enter_context(
-        setup_async_loggers_lifespan(
+        async_loggers(
             log_base_level=app_settings.log_level,
             noisy_loggers=_NOISY_LOGGERS,
             log_format_local_dev_enabled=app_settings.WEBSERVER_LOG_FORMAT_LOCAL_DEV_ENABLED,