structlog-config 0.4.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

structlog_config/__init__.py

@@ -9,9 +9,6 @@ from structlog.processors import ExceptionRenderer
 from structlog.tracebacks import ExceptionDictTransformer
 from structlog.typing import FilteringBoundLogger
 
-from structlog_config.fastapi_access_logger import (
-    client_ip_from_request,
-)
 from structlog_config.formatters import (
     PathPrettifier,
     add_fastapi_context,

structlog_config/fastapi_access_logger.py

@@ -1,3 +1,7 @@
+"""
+Requires fastapi and is not loaded by default since fastapi is not a default dependency.
+"""
+
 from time import perf_counter
 from urllib.parse import quote
 
@@ -11,7 +15,8 @@ from starlette.routing import Match, Mount
 from starlette.types import Scope
 from starlette.websockets import WebSocket
 
-log = structlog.get_logger("access_log")
+# should name this access "access_log" or something
+log = structlog.get_logger()
 ipw = IpWare()
 
 
@@ -109,6 +114,8 @@ def is_static_assets_request(scope: Scope) -> bool:
     )
 
 
+# TODO issue with this approach is if there is an error we don't get a path logged :/
+#      maybe we should log a ERROR with the path information and wrap it with a try?
 def add_middleware(
     app: FastAPI,
 ) -> None:

structlog_config/levels.py

@@ -2,6 +2,8 @@ import logging
 
 from decouple import config
 
+from .constants import TRACE_LOG_LEVEL, package_logger
+
 
 def get_environment_log_level_as_string() -> str:
     level = config("LOG_LEVEL", default="INFO", cast=str).upper()
@@ -22,14 +24,55 @@ def compare_log_levels(left: str, right: str) -> int:
 
     Asks the question "Is INFO higher than DEBUG?"
     """
-    level_map = logging.getLevelNamesMapping()
-    left_level = level_map.get(left, left)
-    right_level = level_map.get(right, right)
+    left_level = _resolve_level_name(left)
+    right_level = _resolve_level_name(right)
 
-    # TODO should more gracefully fail here, but let's see what happens
-    if not isinstance(left_level, int) or not isinstance(right_level, int):
+    if left_level is None or right_level is None:
         raise ValueError(
-            f"Invalid log level comparison: {left} ({type(left_level)}) vs {right} ({type(right_level)})"
+            f"Invalid log level comparison: {left} ({left_level}) vs {right} ({right_level})"
         )
 
     return left_level - right_level
+
+
+def _resolve_level_name(level_name: str) -> int | None:
+    """Translate a log level name to its numeric value."""
+    level_map = logging.getLevelNamesMapping()
+    resolved = level_map.get(level_name)
+
+    if isinstance(resolved, int):
+        return resolved
+
+    if level_name == "TRACE":
+        return getattr(logging, "TRACE", TRACE_LOG_LEVEL)
+
+    try:
+        return int(level_name)
+    except (TypeError, ValueError):
+        return None
+
+
+def is_debug_level() -> bool:
+    """
+    Return True when the global logger is configured for DEBUG or TRACE verbosity.
+
+    Helpful for enabling `debug` flags on various 3rd party libraries. This makes it easy to turn
+    on debug modes globally via LOG_LEVEL environment variable.
+    """
+    root_logger = logging.getLogger()
+    current_level = root_logger.getEffectiveLevel()
+
+    if current_level == logging.NOTSET:
+        # Root loggers default to NOTSET until configured. In that state logging falls back to
+        # environment configuration, so resolve the env value manually to avoid treating it as INFO.
+        package_logger.warning(
+            "Detected root logger level logging.NOTSET; falling back to LOG_LEVEL env value."
+        )
+        env_level = _resolve_level_name(get_environment_log_level_as_string())
+        if env_level is None:
+            return False
+        current_level = env_level
+
+    debug_level = _resolve_level_name("DEBUG") or logging.DEBUG
+
+    return current_level <= debug_level

{structlog_config-0.4.1.dist-info → structlog_config-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structlog-config
-Version: 0.4.1
+Version: 0.5.0
 Summary: A comprehensive structlog configuration with sensible defaults for development and production environments, featuring context management, exception formatting, and path prettification.
 Keywords: logging,structlog,json-logging,structured-logging
 Author: Michael Bianco

{structlog_config-0.4.1.dist-info → structlog_config-0.5.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
-structlog_config/__init__.py,sha256=sSO1F6S__4-3FZU1JursNYzudWZd3uT3KndddF-cUck,6816
+structlog_config/__init__.py,sha256=DyY4x3_dY_hPNbS1aM7JRCGadTa1dYDIPzgrHu3AP68,6733
 structlog_config/constants.py,sha256=O1nPnB29yZdqqaI7aeTUrimA3LOtA5WpP6BGPLWJvj8,510
 structlog_config/env_config.py,sha256=_EJO0rgAKndRPSh4wuBaH3bui9F3nIpn8FaEkjAjZso,1737
 structlog_config/environments.py,sha256=JpZYVVDGxEf1EaKdPdn6Jo-4wJK6SqF0ueFl7e2TBvI,612
-structlog_config/fastapi_access_logger.py,sha256=hHkueC2m-19su5lIEfeJbzMprJ1HeC_WoOKPpaQmHPo,5143
+structlog_config/fastapi_access_logger.py,sha256=QuvteKBZGsEiVaPEpdpsK1jjCYEPKnhmsQDC89M2JKc,5452
 structlog_config/formatters.py,sha256=ll0Y0QeRs1DMmD-ft1n1zA4Vn2STRSK-mOrczYB2OjE,5898
-structlog_config/levels.py,sha256=z1fTpvCCbAwcFK2k7rHWh_p-FqfFh4yIWCTZ1MNf_4U,993
+structlog_config/levels.py,sha256=LqXG4l01mIpxS2qI7PF_Vp9K7IrO0D5qU_x-Uo3LNuM,2372
 structlog_config/packages.py,sha256=asxrzLR-iRYAbkoSYutyTdIRcruTjHgkzfe2pjm2VFM,519
 structlog_config/stdlib_logging.py,sha256=Wnn59oRBIqn708CpR-akqVcG9ccSfCMLh56_7wxZRH0,7350
 structlog_config/trace.py,sha256=dBaSynxmw4Wg79wSHqYEMoByvv--v_oQw61dRdg4xUI,2016
 structlog_config/warnings.py,sha256=gKEcuHWqH0BaKitJtQkv-uJ0Z3uCH5nn6k8qpqjR-RM,998
-structlog_config-0.4.1.dist-info/WHEEL,sha256=4n27za1eEkOnA7dNjN6C5-O2rUiw6iapszm14Uj-Qmk,79
-structlog_config-0.4.1.dist-info/METADATA,sha256=9ZEpVM56Y6ZOXhqwc7YmFIYbB-wVSNfTHwY2mM5wRx8,6329
-structlog_config-0.4.1.dist-info/RECORD,,
+structlog_config-0.5.0.dist-info/WHEEL,sha256=4n27za1eEkOnA7dNjN6C5-O2rUiw6iapszm14Uj-Qmk,79
+structlog_config-0.5.0.dist-info/METADATA,sha256=d1CeOq9mFTIcBP80JKqnGZ_mEHud_5ooaI-6KDn51mM,6329
+structlog_config-0.5.0.dist-info/RECORD,,