|
| 1 | +# Copyright (c) ZenML GmbH 2025. All Rights Reserved. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at: |
| 6 | +# |
| 7 | +# https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 12 | +# or implied. See the License for the specific language governing |
| 13 | +# permissions and limitations under the License. |
| 14 | +"""Module for centralized WarningController implementation.""" |
| 15 | + |
| 16 | +import logging |
| 17 | +from collections import Counter |
| 18 | +from typing import Any |
| 19 | + |
| 20 | +from zenml.enums import LoggingLevels |
| 21 | +from zenml.utils.singleton import SingletonMetaClass |
| 22 | +from zenml.utils.warnings.base import WarningConfig, WarningVerbosity |
| 23 | +from zenml.utils.warnings.registry import WarningCodes |
| 24 | + |
| 25 | +logger = logging.getLogger(__name__) |
| 26 | + |
| 27 | + |
| 28 | +class WarningController(metaclass=SingletonMetaClass): |
| 29 | + """Class responsible for centralized handling of warning messages.""" |
| 30 | + |
| 31 | + def __init__(self) -> None: |
| 32 | + """WarningController constructor.""" |
| 33 | + self._warning_configs: dict[str, WarningConfig] = {} |
| 34 | + self._warning_statistics: dict[str, int] = Counter() |
| 35 | + |
| 36 | + def register(self, warning_configs: dict[str, WarningConfig]) -> None: |
| 37 | + """Register a warning config collection to the controller. |
| 38 | +
|
| 39 | + Args: |
| 40 | + warning_configs: Configs to be registered. Key should be the warning code. |
| 41 | + """ |
| 42 | + self._warning_configs.update(warning_configs) |
| 43 | + |
| 44 | + @staticmethod |
| 45 | + def _resolve_call_details() -> tuple[str, int]: |
| 46 | + import inspect |
| 47 | + |
| 48 | + frame = inspect.stack()[3] # public methods -> _log -> _resolve |
| 49 | + module = inspect.getmodule(frame[0]) |
| 50 | + module_name = module.__name__ if module else "<unknown module>" |
| 51 | + line_number = frame.lineno |
| 52 | + |
| 53 | + return module_name, line_number |
| 54 | + |
| 55 | + @staticmethod |
| 56 | + def _get_display_message( |
| 57 | + message: str, |
| 58 | + module_name: str, |
| 59 | + line_number: int, |
| 60 | + config: WarningConfig, |
| 61 | + ) -> str: |
| 62 | + """Helper method to build the warning message string. |
| 63 | +
|
| 64 | + Args: |
| 65 | + message: The warning message. |
| 66 | + module_name: The module that the warning call originated from. |
| 67 | + line_number: The line number that the warning call originated from. |
| 68 | + config: The warning configuration. |
| 69 | +
|
| 70 | + Returns: |
| 71 | + A warning message containing extra fields/info based on warning config. |
| 72 | + """ |
| 73 | + display = f"[{config.code}]({config.category}) - {message}" |
| 74 | + |
| 75 | + if config.verbosity == WarningVerbosity.MEDIUM: |
| 76 | + display = f"{module_name}:{line_number} {display}" |
| 77 | + |
| 78 | + if config.verbosity == WarningVerbosity.HIGH: |
| 79 | + display = f"{display}\n{config.description}" |
| 80 | + |
| 81 | + return display |
| 82 | + |
| 83 | + def _log( |
| 84 | + self, |
| 85 | + warning_code: WarningCodes, |
| 86 | + message: str, |
| 87 | + level: LoggingLevels, |
| 88 | + **kwargs: dict[str, Any], |
| 89 | + ) -> None: |
| 90 | + """Core function for warning handling. |
| 91 | +
|
| 92 | + Args: |
| 93 | + warning_code: The code of the warning configuration. |
| 94 | + message: The warning message. |
| 95 | + level: The level of the warning. |
| 96 | + **kwargs: Keyword arguments (for formatted messages). |
| 97 | +
|
| 98 | + """ |
| 99 | + warning_config = self._warning_configs.get(warning_code) |
| 100 | + |
| 101 | + # resolves the module and line number of the warning call. |
| 102 | + module_name, line_number = self._resolve_call_details() |
| 103 | + |
| 104 | + if not warning_config: |
| 105 | + # If no config is available just follow default behavior: |
| 106 | + logger.warning(f"{module_name}:{line_number} - {message}") |
| 107 | + return |
| 108 | + |
| 109 | + if warning_config.is_throttled: |
| 110 | + if warning_code in self._warning_statistics: |
| 111 | + # Throttled code has already appeared - skip. |
| 112 | + return |
| 113 | + |
| 114 | + display_message = self._get_display_message( |
| 115 | + message=message, |
| 116 | + module_name=module_name, |
| 117 | + line_number=line_number, |
| 118 | + config=warning_config, |
| 119 | + ) |
| 120 | + |
| 121 | + self._warning_statistics[warning_code] += 1 |
| 122 | + |
| 123 | + if level == LoggingLevels.INFO: |
| 124 | + logger.info(display_message.format(**kwargs)) |
| 125 | + else: |
| 126 | + # Assumes warning level is the default if an invalid option is passed. |
| 127 | + logger.warning(display_message.format(**kwargs)) |
| 128 | + |
| 129 | + def warn( |
| 130 | + self, *, warning_code: WarningCodes, message: str, **kwargs: Any |
| 131 | + ) -> None: |
| 132 | + """Method to execute warning handling logic with warning log level. |
| 133 | +
|
| 134 | + Args: |
| 135 | + warning_code: The code of the warning (see WarningCodes enum) |
| 136 | + message: The message to display. |
| 137 | + **kwargs: Keyword arguments (for formatted messages). |
| 138 | + """ |
| 139 | + self._log(warning_code, message, LoggingLevels.WARNING, **kwargs) |
| 140 | + |
| 141 | + def info( |
| 142 | + self, *, warning_code: WarningCodes, message: str, **kwargs: Any |
| 143 | + ) -> None: |
| 144 | + """Method to execute warning handling logic with info log level. |
| 145 | +
|
| 146 | + Args: |
| 147 | + warning_code: The code of the warning (see WarningCodes enum) |
| 148 | + message: The message to display. |
| 149 | + **kwargs: Keyword arguments (for formatted messages). |
| 150 | + """ |
| 151 | + self._log(warning_code, message, LoggingLevels.INFO, **kwargs) |
| 152 | + |
| 153 | + @staticmethod |
| 154 | + def create() -> "WarningController": |
| 155 | + """Factory function for WarningController. |
| 156 | +
|
| 157 | + Creates a new warning controller and registers system warning configs. |
| 158 | +
|
| 159 | + Returns: |
| 160 | + A warning controller instance. |
| 161 | + """ |
| 162 | + from zenml.utils.warnings.registry import WARNING_CONFIG_REGISTRY |
| 163 | + |
| 164 | + registry = WarningController() |
| 165 | + |
| 166 | + registry.register(warning_configs=WARNING_CONFIG_REGISTRY) |
| 167 | + |
| 168 | + return registry |
0 commit comments