blob: 1828300f2a10e1200bc47a8a77176c87add4444d [file] [log] [blame]
# Copyright 2020 The Pigweed Authors
# 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
# 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.
"""Configure the system logger for the default pw command log format."""
import logging
from typing import NamedTuple, Optional
import pw_cli.color
import pw_cli.env
import pw_cli.plugins
# Log level used for captured output of a subprocess run through pw.
class LogLevel(NamedTuple):
level: int
color: str
ascii: str
emoji: str
# Shorten all the log levels to 3 characters for column-aligned logs.
# Color the logs using ANSI codes.
# pylint: disable=bad-whitespace
# yapf: disable
LogLevel(logging.CRITICAL, 'bold_red', 'CRT', '☠️ '),
LogLevel(logging.ERROR, 'red', 'ERR', '❌'),
LogLevel(logging.WARNING, 'yellow', 'WRN', '⚠️ '),
LogLevel(logging.INFO, 'magenta', 'INF', 'ℹ️ '),
LogLevel(LOGLEVEL_STDOUT, 'cyan', 'OUT', '💬'),
LogLevel(logging.DEBUG, 'blue', 'DBG', '👾'),
# yapf: enable
# pylint: enable=bad-whitespace
_LOG = logging.getLogger(__name__)
_STDERR_HANDLER = logging.StreamHandler()
def main():
# Force the log level to make sure all logs are shown.
# Log one message for every log level.
_LOG.critical('Something terrible has happened!')
_LOG.error('There was an error on our last operation')
_LOG.warning('Looks like something is amiss; consider investigating')'The operation went as expected')
_LOG.log(LOGLEVEL_STDOUT, 'Standard output of subprocess')
_LOG.debug('Adding 1 to i')
def install(level: int = logging.INFO,
use_color: Optional[bool] = None,
hide_timestamp: bool = False) -> None:
"""Configure the system logger for the default pw command log format."""
colors = pw_cli.color.colors(use_color)
env = pw_cli.env.pigweed_environment()
if env.PW_SUBPROCESS or hide_timestamp:
# If the logger is being run in the context of a pw subprocess, the
# time and date are omitted (since pw_cli.process will provide them).
timestamp_fmt = ''
# This applies a gray background to the time to make the log lines
# distinct from other input, in a way that's easier to see than plain
# colored text.
timestamp_fmt = colors.black_on_white('%(asctime)s') + ' '
# Set log level on root logger to debug, otherwise any higher levels
# elsewhere are ignored.
root = logging.getLogger()
logging.Formatter(timestamp_fmt + '%(levelname)s %(message)s',
'%Y%m%d %H:%M:%S'))
if env.PW_EMOJI:
name_attr = 'emoji'
colorize = lambda ll: str
name_attr = 'ascii'
colorize = lambda ll: getattr(colors, ll.color)
for log_level in _LOG_LEVELS:
name = getattr(log_level, name_attr)
logging.addLevelName(log_level.level, colorize(log_level)(name))
def set_level(log_level: int):
"""Sets the log level for logs to stderr."""
# Note: normally this shouldn't be done at the top level without a try/catch
# around the pw_cli.plugins registry import, since pw_cli might not be
# installed.
short_help='Show how how logs look at various levels',
if __name__ == '__main__':