File size: 12,038 Bytes
747451d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | ###################################################################################
# Copyright (c) 2021, 2024 STMicroelectronics.
# All rights reserved.
# This software is licensed under terms that can be found in the LICENSE file in
# the root directory of this software component.
# If no LICENSE file comes with this software, it is provided AS-IS.
###################################################################################
"""
ST AI runner - Utilities
"""
import sys
import logging
import re
import copy
from io import StringIO
from typing import Union, List
from colorama import init, Fore, Style
_LOGGER_NAME_ = 'STAI-RUNNER'
STMAI_RUNNER_LOGGER_NAME = _LOGGER_NAME_
def escape_ansi(line):
"""Remove ANSI character from string"""
ansi_escape = re.compile(r'(\x9B|\x1B\[)[0-?]*[ -/]*[@-~]')
return ansi_escape.sub('', str(line))
class IndentFormatter(logging.Formatter):
"""Default Log Formatter"""
indent = 0
inc = 0
def __init__(self, format_str="%(levelname)s %(message)s"):
super().__init__(fmt=format_str)
def enable_inc(self, enable: bool = True):
"""."""
self.inc = 3 if enable else 0
def is_target_msg(self, msg):
"""."""
return msg and msg.strip().startswith('[TARGET:')
def indent_msg(self, msg):
"""."""
inc = 0
clean_msg_ = escape_ansi(msg)
if clean_msg_.startswith('->'):
inc = self.inc
if clean_msg_.startswith('<-'):
self.indent -= self.inc
self.indent = 0 if self.indent < 0 else self.indent
if self.indent > 0:
msg = ' ' * self.indent + msg
self.indent += inc
return msg
class ColorFormatter(IndentFormatter):
"""Color Formatter"""
COLORS = {
"W": Fore.LIGHTYELLOW_EX, # WARNING
"E": Fore.RED + Style.BRIGHT, # ERROR
"D": Fore.CYAN, # DEBUG
"I": Fore.GREEN, # INFO
"C": Fore.RED, # CRITICAL
"T": Fore.MAGENTA # TARGET.INFO
}
def __init__(self, with_prefix=False):
self.with_prefix = with_prefix
super().__init__()
def format(self, record):
"""Update/format the specified record"""
if hasattr(record, 'original_levelname'):
lvl_name = record.original_levelname
target_msg = record.target_msg
msg = self.indent_msg(record.original_msg)
else:
lvl_name = record.levelname
target_msg = self.is_target_msg(str(record.msg))
msg = self.indent_msg(str(record.msg))
record.msg = msg
slvl_name_ = lvl_name[0]
slvl_name_ = 'T' if (target_msg and slvl_name_ == 'I') else slvl_name_
cls_name_ = (':' + record.name) if self.with_prefix else ''
color = self.COLORS.get(slvl_name_, '')
add_prefix = lvl_name != "INFO" or self.with_prefix
if color:
if slvl_name_ == 'T' or add_prefix:
record.levelname = color + '[' + slvl_name_ + cls_name_ + ']' + Style.RESET_ALL
record.msg = color + record.msg + Style.RESET_ALL
else:
record.levelname = ''
return super().format(record)
class DefaultFormatter(IndentFormatter):
"""Default Formatter"""
def __init__(self, with_prefix=False):
self.with_prefix = with_prefix
super().__init__()
def format(self, record):
"""Update/format the specified record"""
if hasattr(record, 'original_levelname'):
lvl_name = record.original_levelname
target_msg = record.target_msg
msg = self.indent_msg(record.original_msg)
else:
lvl_name = record.levelname
target_msg = self.is_target_msg(str(record.msg))
msg = self.indent_msg(str(record.msg))
record.msg = escape_ansi(msg) # remove ANSI characters
cls_name_ = (':' + record.name) if self.with_prefix else ''
slvl_name_ = 'T' if target_msg else lvl_name[0]
add_prefix = lvl_name != "INFO" or self.with_prefix
if slvl_name_ == 'T' or add_prefix:
record.levelname = '[' + slvl_name_ + cls_name_ + ']'
else:
record.levelname = ''
return super().format(record)
class FileFormatter(IndentFormatter):
"""File Formatter"""
def __init__(self, with_prefix=False):
"""Constructor"""
self.with_prefix = with_prefix
super().__init__()
def format(self, record):
"""Update/format the specified record"""
record.original_levelname = record.levelname
record.target_msg = self.is_target_msg(str(record.msg))
record.original_msg = self.indent_msg(str(record.msg))
record.msg = escape_ansi(record.original_msg)
cls_name_ = (':' + record.name) if self.with_prefix else ''
slvl_name_ = 'T' if record.target_msg else record.levelname[0]
record.levelname = '[' + slvl_name_ + cls_name_ + ']'
return super().format(record)
class DefaultStrHandler(logging.StreamHandler):
"""Default handler"""
def __init__(self, stream=None):
"""."""
stream = sys.stdout if stream is None else stream
super(DefaultStrHandler, self).__init__(stream)
def get_logger(name=None, level=logging.WARNING, color=True, filename=None, with_prefix=True):
"""Utility function to create a logger object"""
logger = logging.getLogger(name)
if logger.handlers and len(logger.handlers) == 2 and isinstance(logger.handlers[1], DefaultStrHandler):
# w/ log file
return logger
elif logger.handlers and len(logger.handlers) == 1 and isinstance(logger.handlers[0], DefaultStrHandler):
# wo/ log file
return logger
if color:
init()
if filename is not None:
logger.setLevel(logging.DEBUG)
fh = logging.FileHandler(filename, mode='w', encoding='utf-8')
fh.setLevel(logging.DEBUG)
fh_formatter = FileFormatter(with_prefix=with_prefix)
fh_formatter.enable_inc()
fh.setFormatter(fh_formatter)
logger.addHandler(fh)
else:
logger.setLevel(level)
console = DefaultStrHandler()
console.setLevel(level)
if color:
formatter = ColorFormatter(with_prefix=with_prefix)
else:
formatter = DefaultFormatter(with_prefix=with_prefix)
formatter.enable_inc(filename is None)
console.setFormatter(formatter)
logger.addHandler(console)
logger.propagate = False
return logger
def get_log_level(logger: logging.Logger):
"""Return effective log level for console"""
if logger.handlers and len(logger.handlers) == 2 and isinstance(logger.handlers[1], DefaultStrHandler):
# w/ log file
return logger.handlers[1].level
elif logger.handlers and len(logger.handlers) == 1 and isinstance(logger.handlers[0], DefaultStrHandler):
# wo/ log file
return logger.handlers[0].level
return logger.getEffectiveLevel()
def set_log_level(level: Union[str, int] = logging.DEBUG, logger: Union[logging.Logger, None] = None):
"""Set the log level of the module""" # noqa: DAR101,DAR201,DAR401
if isinstance(level, str):
level = level.upper()
level = logging.getLevelName(level)
if logger is None:
logger = get_logger(_LOGGER_NAME_)
logger.setLevel(level)
if logger.handlers:
logger.handlers[0].setLevel(level)
class TableWriter(StringIO):
"""Pretty-print tabular data (table form)"""
N_SPACE = 2
def __init__(self, indent: int = 0, csep: str = ' '):
"""Create the Table instance""" # noqa: DAR101,DAR201
self._header = [] # type: List[str]
self._notes = [] # type: List[str]
self._datas = [] # type: List[Union[List[str], str]]
self._title = '' # type: str
self._fmt = '' # type: str
self._sizes = [] # type: List[int]
self._indent = int(max(indent, 0))
self._csep = csep
super(TableWriter, self).__init__()
def set_header(self, items: Union[List[str], str]):
"""Set the name of the columns""" # noqa: DAR101,DAR201
items = self._update_sizes(items)
self._header = items
def set_title(self, title: str):
"""Set the title (optional)""" # noqa: DAR101,DAR201
self._title = title
def set_fmt(self, fmt: str):
"""Set format description (optional)""" # noqa: DAR101,DAR201
self._fmt = fmt
def add_note(self, note: str):
"""Add a note (footer position)""" # noqa: DAR101,DAR201
self._notes.append(note)
def add_row(self, items: Union[List[str], str]):
"""Add a row (list of item)""" # noqa: DAR101,DAR201
items = self._update_sizes(items)
self._datas.append(items)
def add_separator(self, value: str = '-'):
"""Add a separtor (line)""" # noqa: DAR101,DAR201
self._datas.append(value)
def _update_sizes(self, items: Union[List[str], str]) -> List[str]:
"""Update the column sizes""" # noqa: DAR101,DAR201,DAR401
items = [items] if isinstance(items, str) else items
if not self._sizes:
self._sizes = [len(str(item)) + TableWriter.N_SPACE for item in items]
else:
if len(items) > len(self._sizes):
raise ValueError('Size of the provided row is invalid')
for i, item in enumerate(items):
self._sizes[i] = max(len(str(item)) + TableWriter.N_SPACE, self._sizes[i])
return items
def _write_row(self, items: List[str], fmt):
"""Create a formated row""" # noqa: DAR101,DAR201
nfmt = ['.'] * len(self._sizes)
for i, val in enumerate(fmt):
if i < len(nfmt):
nfmt[i] = val
row = ''
for i, item in enumerate(items):
sup = self._sizes[i] - len(str(item))
if nfmt[i] == '>':
row += ' ' * sup + str(item) + ' ' * len(self._csep)
else:
row += str(item) + ' ' * sup + ' ' * len(self._csep)
self.write(row)
def _write_separator(self, val: str):
"""Create a formatted separator""" # noqa: DAR101,DAR201
row = ''
for size in self._sizes:
row += val * size + self._csep
self.write(row)
def write(self, msg: str, newline: str = '\n'):
"""Write fct""" # noqa: DAR101,DAR201
super(TableWriter, self).write(' ' * self._indent + msg + newline)
def getvalue(self, fmt: str = '', endline: bool = False):
"""Buid and return the formatted table""" # noqa: DAR101,DAR201
fmt = fmt if fmt else self._fmt
self.write('')
if self._title:
self.write(self._title)
self._write_separator('-')
if self._header:
self._write_row(self._header, fmt)
self._write_separator('-')
for data in self._datas:
if isinstance(data, str):
self._write_separator(data)
else:
self._write_row(data, fmt)
if endline or self._notes:
self._write_separator('-')
for note in self._notes:
self.write(note)
buff = super(TableWriter, self).getvalue()
return buff
def __str__(self):
return self.getvalue()
def truncate_name(name: str, maxlen: int = 30):
"""Return a truncated string""" # noqa: DAR101, DAR201
maxlen = max(maxlen, 4)
l_, r_ = (3, 1) if maxlen <= 12 else (12, 10)
return (name[:maxlen - l_] + ".." + name[-r_:]) if maxlen < len(name) else name
|