# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
"""Flower Logger."""
import logging
from logging import WARN, LogRecord
from logging.handlers import HTTPHandler
from typing import TYPE_CHECKING, Any, Dict, Optional, TextIO, Tuple
# Create logger
LOGGER_NAME = "flwr"
FLOWER_LOGGER = logging.getLogger(LOGGER_NAME)
FLOWER_LOGGER.setLevel(logging.DEBUG)
LOG_COLORS = {
"DEBUG": "\033[94m", # Blue
"INFO": "\033[92m", # Green
"WARNING": "\033[93m", # Yellow
"ERROR": "\033[91m", # Red
"CRITICAL": "\033[95m", # Magenta
"RESET": "\033[0m", # Reset to default
}
if TYPE_CHECKING:
StreamHandler = logging.StreamHandler[Any]
else:
StreamHandler = logging.StreamHandler
class ConsoleHandler(StreamHandler):
"""Console handler that allows configurable formatting."""
def __init__(
self,
timestamps: bool = False,
json: bool = False,
colored: bool = True,
stream: Optional[TextIO] = None,
) -> None:
super().__init__(stream)
self.timestamps = timestamps
self.json = json
self.colored = colored
def emit(self, record: LogRecord) -> None:
"""Emit a record."""
if self.json:
record.message = record.getMessage().replace("\t", "").strip()
# Check if the message is empty
if not record.message:
return
super().emit(record)
def format(self, record: LogRecord) -> str:
"""Format function that adds colors to log level."""
seperator = " " * (8 - len(record.levelname))
if self.json:
log_fmt = "{lvl='%(levelname)s', time='%(asctime)s', msg='%(message)s'}"
else:
log_fmt = (
f"{LOG_COLORS[record.levelname] if self.colored else ''}"
f"%(levelname)s {'%(asctime)s' if self.timestamps else ''}"
f"{LOG_COLORS['RESET'] if self.colored else ''}"
f": {seperator} %(message)s"
)
formatter = logging.Formatter(log_fmt)
return formatter.format(record)
def update_console_handler(
level: Optional[int] = None,
timestamps: Optional[bool] = None,
colored: Optional[bool] = None,
) -> None:
"""Update the logging handler."""
for handler in logging.getLogger(LOGGER_NAME).handlers:
if isinstance(handler, ConsoleHandler):
if level is not None:
handler.setLevel(level)
if timestamps is not None:
handler.timestamps = timestamps
if colored is not None:
handler.colored = colored
# Configure console logger
console_handler = ConsoleHandler(
timestamps=False,
json=False,
colored=True,
)
console_handler.setLevel(logging.INFO)
FLOWER_LOGGER.addHandler(console_handler)
class CustomHTTPHandler(HTTPHandler):
"""Custom HTTPHandler which overrides the mapLogRecords method."""
# pylint: disable=too-many-arguments,bad-option-value,R1725
def __init__(
self,
identifier: str,
host: str,
url: str,
method: str = "GET",
secure: bool = False,
credentials: Optional[Tuple[str, str]] = None,
) -> None:
super().__init__(host, url, method, secure, credentials)
self.identifier = identifier
def mapLogRecord(self, record: LogRecord) -> Dict[str, Any]:
"""Filter for the properties to be send to the logserver."""
record_dict = record.__dict__
return {
"identifier": self.identifier,
"levelname": record_dict["levelname"],
"name": record_dict["name"],
"asctime": record_dict["asctime"],
"filename": record_dict["filename"],
"lineno": record_dict["lineno"],
"message": record_dict["message"],
}
logger = logging.getLogger(LOGGER_NAME) # pylint: disable=invalid-name
log = logger.log # pylint: disable=invalid-name
def warn_preview_feature(name: str) -> None:
"""Warn the user when they use a preview feature."""
log(
WARN,
"""PREVIEW FEATURE: %s
This is a preview feature. It could change significantly or be removed
entirely in future versions of Flower.
""",
name,
)
def warn_deprecated_feature(name: str) -> None:
"""Warn the user when they use a deprecated feature."""
log(
WARN,
"""DEPRECATED FEATURE: %s
This is a deprecated feature. It will be removed
entirely in future versions of Flower.
""",
name,
)
def set_logger_propagation(
child_logger: logging.Logger, value: bool = True
) -> logging.Logger:
"""Set the logger propagation attribute.
Parameters
----------
child_logger : logging.Logger
Child logger object
value : bool
Boolean setting for propagation. If True, both parent and child logger
display messages. Otherwise, only the child logger displays a message.
This False setting prevents duplicate logs in Colab notebooks.
Reference: https://stackoverflow.com/a/19561320
Returns
-------
logging.Logger
Child logger object with updated propagation setting
"""
child_logger.propagate = value
if not child_logger.propagate:
child_logger.log(logging.DEBUG, "Logger propagate set to False")
return child_logger