|
| 1 | +"""Internal logging infrastructure for the mcpd SDK. |
| 2 | +
|
| 3 | +This module provides a logging shim controlled by the MCPD_LOG_LEVEL environment |
| 4 | +variable. Logging is disabled by default to avoid contaminating stdout/stderr in |
| 5 | +MCP server contexts. |
| 6 | +
|
| 7 | +CRITICAL: Only enable MCPD_LOG_LEVEL in non-MCP-server contexts. MCP servers use |
| 8 | +stdout for JSON-RPC communication, and any logging output will break the protocol. |
| 9 | +""" |
| 10 | + |
| 11 | +import logging |
| 12 | +import os |
| 13 | +from enum import Enum |
| 14 | +from typing import Protocol |
| 15 | + |
| 16 | + |
| 17 | +class LogLevel(str, Enum): |
| 18 | + """Valid log level values for MCPD_LOG_LEVEL environment variable. |
| 19 | +
|
| 20 | + Aligns with mcpd server binary log levels for consistency across the mcpd ecosystem. |
| 21 | + """ |
| 22 | + |
| 23 | + TRACE = "trace" |
| 24 | + DEBUG = "debug" |
| 25 | + INFO = "info" |
| 26 | + WARN = "warn" |
| 27 | + ERROR = "error" |
| 28 | + OFF = "off" |
| 29 | + |
| 30 | + |
| 31 | +class Logger(Protocol): |
| 32 | + """Logger protocol defining the SDK's logging interface. |
| 33 | +
|
| 34 | + This protocol matches standard logging levels and allows custom logger injection. |
| 35 | + All methods accept a message and optional formatting arguments. |
| 36 | + """ |
| 37 | + |
| 38 | + def trace(self, msg: str, *args: object) -> None: |
| 39 | + """Log a trace-level message (most verbose).""" |
| 40 | + ... |
| 41 | + |
| 42 | + def debug(self, msg: str, *args: object) -> None: |
| 43 | + """Log a debug-level message.""" |
| 44 | + ... |
| 45 | + |
| 46 | + def info(self, msg: str, *args: object) -> None: |
| 47 | + """Log an info-level message.""" |
| 48 | + ... |
| 49 | + |
| 50 | + def warn(self, msg: str, *args: object) -> None: |
| 51 | + """Log a warning-level message.""" |
| 52 | + ... |
| 53 | + |
| 54 | + def error(self, msg: str, *args: object) -> None: |
| 55 | + """Log an error-level message.""" |
| 56 | + ... |
| 57 | + |
| 58 | + |
| 59 | +# Custom TRACE level (below DEBUG=10). |
| 60 | +_TRACE = 5 |
| 61 | +logging.addLevelName(_TRACE, "TRACE") |
| 62 | + |
| 63 | +_RANKS: dict[str, int] = { |
| 64 | + LogLevel.TRACE.value: _TRACE, |
| 65 | + LogLevel.DEBUG.value: logging.DEBUG, |
| 66 | + LogLevel.INFO.value: logging.INFO, |
| 67 | + LogLevel.WARN.value: logging.WARNING, |
| 68 | + "warning": logging.WARNING, # Alias for backwards compatibility. |
| 69 | + LogLevel.ERROR.value: logging.ERROR, |
| 70 | + LogLevel.OFF.value: 1000, # Higher than any standard level. |
| 71 | +} |
| 72 | + |
| 73 | + |
| 74 | +def _resolve_log_level(raw: str | None) -> str: |
| 75 | + """Resolve the log level from environment variable value. |
| 76 | +
|
| 77 | + Args: |
| 78 | + raw: Raw value from MCPD_LOG_LEVEL environment variable. |
| 79 | +
|
| 80 | + Returns: |
| 81 | + Valid log level string matching LogLevel enum values. |
| 82 | + Returns LogLevel.OFF.value if raw is None, empty, or not a valid level. |
| 83 | + """ |
| 84 | + candidate = raw.lower() if raw else None |
| 85 | + return candidate if candidate and candidate in _RANKS else LogLevel.OFF.value |
| 86 | + |
| 87 | + |
| 88 | +def _get_level() -> str: |
| 89 | + """Get the current log level from environment variable (lazy evaluation). |
| 90 | +
|
| 91 | + This function is called on each log statement to support dynamic level changes. |
| 92 | +
|
| 93 | + Note: |
| 94 | + Dynamic level changes can facilitate testing. |
| 95 | +
|
| 96 | + Returns: |
| 97 | + The resolved log level string. |
| 98 | + """ |
| 99 | + return _resolve_log_level(os.getenv("MCPD_LOG_LEVEL")) |
| 100 | + |
| 101 | + |
| 102 | +def _create_default_logger() -> Logger: |
| 103 | + """Create the default logger with lazy level evaluation. |
| 104 | +
|
| 105 | + Returns: |
| 106 | + A Logger instance that checks MCPD_LOG_LEVEL on each log call, |
| 107 | + enabling dynamic level changes without module reloading. |
| 108 | + """ |
| 109 | + # Create logger and handler once (not per-call). |
| 110 | + _logger = logging.getLogger(__name__) |
| 111 | + |
| 112 | + if not _logger.handlers: |
| 113 | + # Add stderr handler (default for StreamHandler). |
| 114 | + handler = logging.StreamHandler() |
| 115 | + handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s")) |
| 116 | + _logger.addHandler(handler) |
| 117 | + _logger.propagate = False |
| 118 | + |
| 119 | + class _DefaultLogger: |
| 120 | + """Default logger that checks level on each call (lazy evaluation).""" |
| 121 | + |
| 122 | + def trace(self, msg: str, *args: object) -> None: |
| 123 | + """Log trace-level message.""" |
| 124 | + lvl = _get_level() |
| 125 | + if lvl != LogLevel.OFF.value and _RANKS[lvl] <= _RANKS[LogLevel.TRACE.value]: |
| 126 | + _logger.setLevel(_TRACE) |
| 127 | + _logger.log(_TRACE, msg, *args) |
| 128 | + |
| 129 | + def debug(self, msg: str, *args: object) -> None: |
| 130 | + """Log debug-level message.""" |
| 131 | + lvl = _get_level() |
| 132 | + if lvl != LogLevel.OFF.value and _RANKS[lvl] <= _RANKS[LogLevel.DEBUG.value]: |
| 133 | + _logger.setLevel(logging.DEBUG) |
| 134 | + _logger.debug(msg, *args) |
| 135 | + |
| 136 | + def info(self, msg: str, *args: object) -> None: |
| 137 | + """Log info-level message.""" |
| 138 | + lvl = _get_level() |
| 139 | + if lvl != LogLevel.OFF.value and _RANKS[lvl] <= _RANKS[LogLevel.INFO.value]: |
| 140 | + _logger.setLevel(logging.INFO) |
| 141 | + _logger.info(msg, *args) |
| 142 | + |
| 143 | + def warn(self, msg: str, *args: object) -> None: |
| 144 | + """Log warning-level message.""" |
| 145 | + lvl = _get_level() |
| 146 | + if lvl != LogLevel.OFF.value and _RANKS[lvl] <= _RANKS[LogLevel.WARN.value]: |
| 147 | + _logger.setLevel(logging.WARNING) |
| 148 | + _logger.warning(msg, *args) |
| 149 | + |
| 150 | + def error(self, msg: str, *args: object) -> None: |
| 151 | + """Log error-level message.""" |
| 152 | + lvl = _get_level() |
| 153 | + if lvl != LogLevel.OFF.value and _RANKS[lvl] <= _RANKS[LogLevel.ERROR.value]: |
| 154 | + _logger.setLevel(logging.ERROR) |
| 155 | + _logger.error(msg, *args) |
| 156 | + |
| 157 | + return _DefaultLogger() |
| 158 | + |
| 159 | + |
| 160 | +class _PartialLoggerWrapper: |
| 161 | + """Wrapper that combines partial custom logger with default logger fallback. |
| 162 | +
|
| 163 | + This enables partial logger implementations where users can override specific |
| 164 | + methods while keeping defaults for others. |
| 165 | + """ |
| 166 | + |
| 167 | + def __init__(self, custom: object, default: Logger): |
| 168 | + """Initialize the wrapper. |
| 169 | +
|
| 170 | + Args: |
| 171 | + custom: Partial logger implementation (may not have all methods). |
| 172 | + default: Default logger to use for missing methods. |
| 173 | + """ |
| 174 | + self._custom = custom |
| 175 | + self._default = default |
| 176 | + |
| 177 | + def trace(self, msg: str, *args: object) -> None: |
| 178 | + """Log trace-level message.""" |
| 179 | + if hasattr(self._custom, LogLevel.TRACE.value): |
| 180 | + self._custom.trace(msg, *args) |
| 181 | + else: |
| 182 | + self._default.trace(msg, *args) |
| 183 | + |
| 184 | + def debug(self, msg: str, *args: object) -> None: |
| 185 | + """Log debug-level message.""" |
| 186 | + if hasattr(self._custom, LogLevel.DEBUG.value): |
| 187 | + self._custom.debug(msg, *args) |
| 188 | + else: |
| 189 | + self._default.debug(msg, *args) |
| 190 | + |
| 191 | + def info(self, msg: str, *args: object) -> None: |
| 192 | + """Log info-level message.""" |
| 193 | + if hasattr(self._custom, LogLevel.INFO.value): |
| 194 | + self._custom.info(msg, *args) |
| 195 | + else: |
| 196 | + self._default.info(msg, *args) |
| 197 | + |
| 198 | + def warn(self, msg: str, *args: object) -> None: |
| 199 | + """Log warning-level message.""" |
| 200 | + if hasattr(self._custom, LogLevel.WARN.value): |
| 201 | + self._custom.warn(msg, *args) |
| 202 | + else: |
| 203 | + self._default.warn(msg, *args) |
| 204 | + |
| 205 | + def error(self, msg: str, *args: object) -> None: |
| 206 | + """Log error-level message.""" |
| 207 | + if hasattr(self._custom, LogLevel.ERROR.value): |
| 208 | + self._custom.error(msg, *args) |
| 209 | + else: |
| 210 | + self._default.error(msg, *args) |
| 211 | + |
| 212 | + |
| 213 | +def create_logger(impl: Logger | object | None = None) -> Logger: |
| 214 | + """Create a logger, optionally using a custom implementation. |
| 215 | +
|
| 216 | + This function allows SDK users to inject their own logger implementation. |
| 217 | + Supports partial implementations - any omitted methods will fall back to the |
| 218 | + default logger, which respects the MCPD_LOG_LEVEL environment variable. |
| 219 | +
|
| 220 | + Args: |
| 221 | + impl: Optional custom Logger implementation or partial implementation. |
| 222 | + If None, uses the default logger controlled by MCPD_LOG_LEVEL. |
| 223 | + If partially provided, custom methods are used and omitted methods |
| 224 | + fall back to default logger (which respects MCPD_LOG_LEVEL). |
| 225 | +
|
| 226 | + Returns: |
| 227 | + A Logger instance with all methods implemented. |
| 228 | +
|
| 229 | + Example: |
| 230 | + >>> # Use default logger (controlled by MCPD_LOG_LEVEL). |
| 231 | + >>> logger = create_logger() |
| 232 | + >>> |
| 233 | + >>> # Full custom logger. |
| 234 | + >>> class MyLogger: |
| 235 | + ... def trace(self, msg, *args): pass |
| 236 | + ... def debug(self, msg, *args): pass |
| 237 | + ... def info(self, msg, *args): pass |
| 238 | + ... def warn(self, msg, *args): print(f"WARN: {msg % args}") |
| 239 | + ... def error(self, msg, *args): print(f"ERROR: {msg % args}") |
| 240 | + >>> logger = create_logger(MyLogger()) |
| 241 | + >>> |
| 242 | + >>> # Partial logger: custom warn/error, default (MCPD_LOG_LEVEL-aware) for others. |
| 243 | + >>> class PartialLogger: |
| 244 | + ... def warn(self, msg, *args): print(f"WARN: {msg % args}") |
| 245 | + ... def error(self, msg, *args): print(f"ERROR: {msg % args}") |
| 246 | + ... # trace, debug, info use default logger (respects MCPD_LOG_LEVEL) |
| 247 | + >>> logger = create_logger(PartialLogger()) |
| 248 | + """ |
| 249 | + if impl is None: |
| 250 | + return _default_logger |
| 251 | + |
| 252 | + # Check if it's a full Logger implementation (has all required methods). |
| 253 | + required_methods = [ |
| 254 | + LogLevel.TRACE.value, |
| 255 | + LogLevel.DEBUG.value, |
| 256 | + LogLevel.INFO.value, |
| 257 | + LogLevel.WARN.value, |
| 258 | + LogLevel.ERROR.value, |
| 259 | + ] |
| 260 | + if all(hasattr(impl, method) for method in required_methods): |
| 261 | + return impl |
| 262 | + |
| 263 | + # Partial implementation - wrap with fallback to default logger. |
| 264 | + return _PartialLoggerWrapper(impl, _default_logger) |
| 265 | + |
| 266 | + |
| 267 | +# Module-level default logger (created at import time). |
| 268 | +_default_logger: Logger = _create_default_logger() |
0 commit comments