structlog-config 0.4.2__tar.gz → 0.5.0__tar.gz

{structlog_config-0.4.2 → structlog_config-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structlog-config
-Version: 0.4.2
+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.2 → structlog_config-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "structlog-config"
-version = "0.4.2"
+version = "0.5.0"
 description = "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"]
 readme = "README.md"

structlog_config-0.5.0/structlog_config/levels.py

@@ -0,0 +1,78 @@
+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()
+
+    if not level.strip():
+        level = "INFO"
+
+    return level
+
+
+def compare_log_levels(left: str, right: str) -> int:
+    """
+    Compare log levels using logging.getLevelNamesMapping for accurate int values.
+
+    Example:
+    >>> compare_log_levels("DEBUG", "INFO")
+    -1  # DEBUG is less than INFO
+
+    Asks the question "Is INFO higher than DEBUG?"
+    """
+    left_level = _resolve_level_name(left)
+    right_level = _resolve_level_name(right)
+
+    if left_level is None or right_level is None:
+        raise ValueError(
+            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.2/structlog_config/levels.py

@@ -1,35 +0,0 @@
-import logging
-
-from decouple import config
-
-
-def get_environment_log_level_as_string() -> str:
-    level = config("LOG_LEVEL", default="INFO", cast=str).upper()
-
-    if not level.strip():
-        level = "INFO"
-
-    return level
-
-
-def compare_log_levels(left: str, right: str) -> int:
-    """
-    Compare log levels using logging.getLevelNamesMapping for accurate int values.
-
-    Example:
-    >>> compare_log_levels("DEBUG", "INFO")
-    -1  # DEBUG is less than INFO
-
-    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)
-
-    # TODO should more gracefully fail here, but let's see what happens
-    if not isinstance(left_level, int) or not isinstance(right_level, int):
-        raise ValueError(
-            f"Invalid log level comparison: {left} ({type(left_level)}) vs {right} ({type(right_level)})"
-        )
-
-    return left_level - right_level