|
| 1 | +"""Centralized logging configuration for NetGraph.""" |
| 2 | + |
| 3 | +import logging |
| 4 | +import sys |
| 5 | +from typing import Optional |
| 6 | + |
| 7 | +# Flag to track if we've already set up the root logger |
| 8 | +_ROOT_LOGGER_CONFIGURED = False |
| 9 | + |
| 10 | + |
| 11 | +def setup_root_logger( |
| 12 | + level: int = logging.INFO, |
| 13 | + format_string: Optional[str] = None, |
| 14 | + handler: Optional[logging.Handler] = None, |
| 15 | +) -> None: |
| 16 | + """Set up the root NetGraph logger with a single handler. |
| 17 | +
|
| 18 | + This should only be called once to avoid duplicate handlers. |
| 19 | +
|
| 20 | + Args: |
| 21 | + level: Logging level (default: INFO). |
| 22 | + format_string: Custom format string (optional). |
| 23 | + handler: Custom handler (optional, defaults to StreamHandler). |
| 24 | + """ |
| 25 | + global _ROOT_LOGGER_CONFIGURED |
| 26 | + |
| 27 | + if _ROOT_LOGGER_CONFIGURED: |
| 28 | + return |
| 29 | + |
| 30 | + root_logger = logging.getLogger("ngraph") |
| 31 | + root_logger.setLevel(level) |
| 32 | + |
| 33 | + # Clear any existing handlers to avoid duplicates |
| 34 | + root_logger.handlers.clear() |
| 35 | + |
| 36 | + # Default format with timestamps, level, logger name, and message |
| 37 | + if format_string is None: |
| 38 | + format_string = "%(asctime)s - %(name)s - %(levelname)s - %(message)s" |
| 39 | + |
| 40 | + # Default to console output, but allow override for testing |
| 41 | + if handler is None: |
| 42 | + handler = logging.StreamHandler(sys.stdout) |
| 43 | + |
| 44 | + formatter = logging.Formatter(format_string) |
| 45 | + handler.setFormatter(formatter) |
| 46 | + root_logger.addHandler(handler) |
| 47 | + |
| 48 | + # Let logs propagate to root logger so pytest can capture them |
| 49 | + root_logger.propagate = True |
| 50 | + |
| 51 | + _ROOT_LOGGER_CONFIGURED = True |
| 52 | + |
| 53 | + _ROOT_LOGGER_CONFIGURED = True |
| 54 | + |
| 55 | + |
| 56 | +def get_logger(name: str) -> logging.Logger: |
| 57 | + """Get a logger with NetGraph's standard configuration. |
| 58 | +
|
| 59 | + This is the main function that should be used throughout the package. |
| 60 | + All loggers will inherit from the root 'ngraph' logger configuration. |
| 61 | +
|
| 62 | + Args: |
| 63 | + name: Logger name (typically __name__ from calling module). |
| 64 | +
|
| 65 | + Returns: |
| 66 | + Configured logger instance. |
| 67 | + """ |
| 68 | + # Ensure root logger is set up |
| 69 | + setup_root_logger() |
| 70 | + |
| 71 | + # Get the logger - it will inherit from the root ngraph logger |
| 72 | + logger = logging.getLogger(name) |
| 73 | + |
| 74 | + # Don't add handlers to child loggers - they inherit from root |
| 75 | + # Just set the level |
| 76 | + logger.setLevel(logging.NOTSET) # Inherit from parent |
| 77 | + |
| 78 | + return logger |
| 79 | + |
| 80 | + |
| 81 | +def set_global_log_level(level: int) -> None: |
| 82 | + """Set the log level for all NetGraph loggers. |
| 83 | +
|
| 84 | + Args: |
| 85 | + level: Logging level (e.g., logging.DEBUG, logging.INFO). |
| 86 | + """ |
| 87 | + # Ensure root logger is set up |
| 88 | + setup_root_logger() |
| 89 | + |
| 90 | + # Set the root level for all ngraph loggers |
| 91 | + root_logger = logging.getLogger("ngraph") |
| 92 | + root_logger.setLevel(level) |
| 93 | + |
| 94 | + # Also update handlers to respect the new level |
| 95 | + for handler in root_logger.handlers: |
| 96 | + handler.setLevel(level) |
| 97 | + |
| 98 | + |
| 99 | +def enable_debug_logging() -> None: |
| 100 | + """Enable debug logging for the entire package.""" |
| 101 | + set_global_log_level(logging.DEBUG) |
| 102 | + |
| 103 | + |
| 104 | +def disable_debug_logging() -> None: |
| 105 | + """Disable debug logging, set to INFO level.""" |
| 106 | + set_global_log_level(logging.INFO) |
| 107 | + |
| 108 | + |
| 109 | +def reset_logging() -> None: |
| 110 | + """Reset logging configuration (mainly for testing).""" |
| 111 | + global _ROOT_LOGGER_CONFIGURED |
| 112 | + _ROOT_LOGGER_CONFIGURED = False |
| 113 | + |
| 114 | + # Clear any existing handlers from ngraph logger |
| 115 | + root_logger = logging.getLogger("ngraph") |
| 116 | + root_logger.handlers.clear() |
| 117 | + root_logger.setLevel(logging.NOTSET) |
| 118 | + |
| 119 | + |
| 120 | +# Initialize the root logger when the module is imported |
| 121 | +setup_root_logger() |
0 commit comments