fix(picologging): better handle unsupported environments (#3918)

* fix(picologging): updates to handle unsupported environments (python 3.13, etc.)

* fix: add ignores

* fix: trim whitespace

Author: cofin

litestar/logging/config.py

@@ -292,13 +292,16 @@ def configure(self) -> GetLogger:
 
         if self.logging_module == "picologging":
             try:
-                from picologging import config, getLogger
+                from picologging import (  # pyright: ignore[reportMissingImports,reportGeneralTypeIssues]
+                    config,  # pyright: ignore[reportMissingImports,reportGeneralTypeIssues]
+                    getLogger,  # pyright: ignore[reportMissingImports,reportGeneralTypeIssues]
+                )
             except ImportError as e:
                 raise MissingDependencyException("picologging") from e
 
             excluded_fields.add("incremental")
         else:
-            from logging import config, getLogger  # type: ignore[no-redef, assignment]
+            from logging import config, getLogger  # type: ignore[no-redef,assignment,unused-ignore]
 
         values = {
             _field.name: getattr(self, _field.name)

litestar/logging/picologging.py

@@ -11,15 +11,15 @@
 
 
 try:
-    import picologging  # noqa: F401
+    import picologging  # noqa: F401 # pyright: ignore[reportMissingImports]
 except ImportError as e:
     raise MissingDependencyException("picologging") from e
 
-from picologging import StreamHandler
-from picologging.handlers import QueueHandler, QueueListener
+from picologging import StreamHandler  # pyright: ignore[reportMissingImports]
+from picologging.handlers import QueueHandler, QueueListener  # pyright: ignore[reportMissingImports]
 
 
-class QueueListenerHandler(QueueHandler):
+class QueueListenerHandler(QueueHandler):  # type: ignore[misc,unused-ignore]
     """Configure queue listener and handler to support non-blocking logging configuration."""
 
     def __init__(self, handlers: list[Any] | None = None) -> None:
@@ -32,8 +32,8 @@ def __init__(self, handlers: list[Any] | None = None) -> None:
             - Requires ``picologging`` to be installed.
         """
         super().__init__(Queue(-1))
-        handlers = resolve_handlers(handlers) if handlers else [StreamHandler()]
-        self.listener = QueueListener(self.queue, *handlers)
+        handlers = resolve_handlers(handlers) if handlers else [StreamHandler()]  # pyright: ignore[reportGeneralTypeIssues]
+        self.listener = QueueListener(self.queue, *handlers)  # pyright: ignore[reportGeneralTypeIssues]
         self.listener.start()
 
         atexit.register(self.listener.stop)

pyproject.toml

@@ -31,21 +31,21 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = [
-    "anyio>=3",
-    "httpx>=0.22",
-    "exceptiongroup; python_version < \"3.11\"",
-    "importlib-metadata; python_version < \"3.10\"",
-    "importlib-resources>=5.12.0; python_version < \"3.9\"",
-    "msgspec>=0.18.2",
-    "multidict>=6.0.2",
-    "polyfactory>=2.6.3",
-    "pyyaml",
-    "typing-extensions",
-    "click",
-    "rich>=13.0.0",
-    "rich-click",
-    "multipart>=1.2.0",
-    # default litestar plugins
+  "anyio>=3",
+  "httpx>=0.22",
+  "exceptiongroup; python_version < \"3.11\"",
+  "importlib-metadata; python_version < \"3.10\"",
+  "importlib-resources>=5.12.0; python_version < \"3.9\"",
+  "msgspec>=0.18.2",
+  "multidict>=6.0.2",
+  "polyfactory>=2.6.3",
+  "pyyaml",
+  "typing-extensions",
+  "click",
+  "rich>=13.0.0",
+  "rich-click",
+  "multipart>=1.2.0",
+  # default litestar plugins
     "litestar-htmx>=0.4.0"
 ]
 description = "Litestar - A production-ready, highly performant, extensible ASGI API Framework"
@@ -140,16 +140,16 @@ dev = [
 ]
 
 docs = [
-    "sphinx>=7.1.2",
-    "sphinx-autobuild>=2021.3.14",
-    "sphinx-copybutton>=0.5.2",
-    "sphinx-toolbox>=3.5.0",
-    "sphinx-design>=0.5.0",
-    "sphinx-click>=4.4.0",
-    "sphinxcontrib-mermaid>=0.9.2",
-    "auto-pytabs[sphinx]>=0.5.0",
-    "litestar-sphinx-theme @ git+https://github.com/litestar-org/litestar-sphinx-theme.git",
-    "sphinx-paramlinks>=0.6.0",
+  "sphinx>=7.1.2",
+  "sphinx-autobuild>=2021.3.14",
+  "sphinx-copybutton>=0.5.2",
+  "sphinx-toolbox>=3.5.0",
+  "sphinx-design>=0.5.0",
+  "sphinx-click>=4.4.0",
+  "sphinxcontrib-mermaid>=0.9.2",
+  "auto-pytabs[sphinx]>=0.5.0",
+  "litestar-sphinx-theme @ git+https://github.com/litestar-org/litestar-sphinx-theme.git",
+  "sphinx-paramlinks>=0.6.0",
 ]
 linting = [
   "ruff>=0.2.1",
@@ -256,6 +256,10 @@ module = ["tests.examples.*", "tests.docker_service_fixtures"]
 module = ["tests.*"]
 disable_error_code = ["truthy-bool"]
 
+[[tool.mypy.overrides]]
+disable_error_code = ["assignment"]
+module = ["tests.unit.test_logging.*"]
+
 [[tool.mypy.overrides]]
 disallow_untyped_decorators = false
 module = ["tests.unit.test_kwargs.test_reserved_kwargs_injection"]
@@ -290,6 +294,7 @@ module = [
   "litestar.plugins.pydantic.*",
   "tests.unit.test_contrib.test_sqlalchemy",
   "tests.unit.test_contrib.test_pydantic.*",
+  "tests.unit.test_logging.test_logging_config",
   "litestar.openapi.spec.base",
   "litestar.utils.helpers",
   "litestar.channels.plugin",

tests/helpers.py

@@ -1,14 +1,16 @@
 from __future__ import annotations
 
 import atexit
+import importlib.util
 import inspect
 import logging
 import random
 import sys
 from contextlib import AbstractContextManager, contextmanager
+from pathlib import Path
 from typing import Any, AsyncContextManager, Awaitable, ContextManager, Generator, TypeVar, cast, overload
 
-import picologging
+import pytest
 from _pytest.logging import LogCaptureHandler, _LiveLoggingNullHandler
 
 from litestar._openapi.schema_generation import SchemaCreator
@@ -90,9 +92,9 @@ def cleanup_logging_impl() -> Generator:
         # Don't interfere with PyTest handler config
         if not isinstance(std_handler, (_LiveLoggingNullHandler, LogCaptureHandler)):
             std_root_logger.removeHandler(std_handler)
-
+    picologging = pytest.importorskip("picologging")
     # Reset root logger (`picologging` module)
-    pico_root_logger: picologging.Logger = picologging.getLogger()
+    pico_root_logger: picologging.Logger = picologging.getLogger()  # type: ignore[name-defined,unused-ignore] # pyright: ignore[reportPrivateUsage,reportGeneralTypeIssues,reportAssignmentType,reportInvalidTypeForm]
     for pico_handler in pico_root_logger.handlers:
         pico_root_logger.removeHandler(pico_handler)
 
@@ -111,3 +113,10 @@ def cleanup_logging_impl() -> Generator:
 def not_none(val: T | None) -> T:
     assert val is not None
     return val
+
+
+def purge_module(module_names: list[str], path: str | Path) -> None:
+    for name in module_names:
+        if name in sys.modules:
+            del sys.modules[name]
+    Path(importlib.util.cache_from_source(path)).unlink(missing_ok=True)  # type: ignore[arg-type]