1998aac349
Previously we set loglevel >= WARNING printed to stderr and loglevel < WARNING printed to stdout. To be more flexible, we replace this `WARNING` value with an argument: split_level and leave `WARNING` as default split_level if not set. Signed-off-by: Yanray Wang <yanray.wang@arm.com>
57 lines
2 KiB
Python
57 lines
2 KiB
Python
"""Auxiliary functions used for logging module.
|
|
"""
|
|
|
|
# Copyright The Mbed TLS Contributors
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# 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.
|
|
|
|
import logging
|
|
import sys
|
|
|
|
def configure_logger(
|
|
logger: logging.Logger,
|
|
log_format="[%(levelname)s]: %(message)s",
|
|
split_level=logging.WARNING
|
|
) -> None:
|
|
"""
|
|
Configure the logging.Logger instance so that:
|
|
- Format is set to any log_format.
|
|
Default: "[%(levelname)s]: %(message)s"
|
|
- loglevel >= split_level are printed to stderr.
|
|
- loglevel < split_level are printed to stdout.
|
|
Default: logging.WARNING
|
|
"""
|
|
class MaxLevelFilter(logging.Filter):
|
|
# pylint: disable=too-few-public-methods
|
|
def __init__(self, max_level, name=''):
|
|
super().__init__(name)
|
|
self.max_level = max_level
|
|
|
|
def filter(self, record: logging.LogRecord) -> bool:
|
|
return record.levelno <= self.max_level
|
|
|
|
log_formatter = logging.Formatter(log_format)
|
|
|
|
# set loglevel >= split_level to be printed to stderr
|
|
stderr_hdlr = logging.StreamHandler(sys.stderr)
|
|
stderr_hdlr.setLevel(split_level)
|
|
stderr_hdlr.setFormatter(log_formatter)
|
|
|
|
# set loglevel < split_level to be printed to stdout
|
|
stdout_hdlr = logging.StreamHandler(sys.stdout)
|
|
stdout_hdlr.addFilter(MaxLevelFilter(split_level - 1))
|
|
stdout_hdlr.setFormatter(log_formatter)
|
|
|
|
logger.addHandler(stderr_hdlr)
|
|
logger.addHandler(stdout_hdlr)
|