msg.py 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. """
  2. BitBake 'msg' implementation
  3. Message handling infrastructure for bitbake
  4. """
  5. # Copyright (C) 2006 Richard Purdie
  6. #
  7. # SPDX-License-Identifier: GPL-2.0-only
  8. #
  9. import sys
  10. import copy
  11. import logging
  12. import collections
  13. from itertools import groupby
  14. import warnings
  15. import bb
  16. import bb.event
  17. class BBLogFormatter(logging.Formatter):
  18. """Formatter which ensures that our 'plain' messages (logging.INFO + 1) are used as is"""
  19. DEBUG3 = logging.DEBUG - 2
  20. DEBUG2 = logging.DEBUG - 1
  21. DEBUG = logging.DEBUG
  22. VERBOSE = logging.INFO - 1
  23. NOTE = logging.INFO
  24. PLAIN = logging.INFO + 1
  25. VERBNOTE = logging.INFO + 2
  26. ERROR = logging.ERROR
  27. WARNING = logging.WARNING
  28. CRITICAL = logging.CRITICAL
  29. levelnames = {
  30. DEBUG3 : 'DEBUG',
  31. DEBUG2 : 'DEBUG',
  32. DEBUG : 'DEBUG',
  33. VERBOSE: 'NOTE',
  34. NOTE : 'NOTE',
  35. PLAIN : '',
  36. VERBNOTE: 'NOTE',
  37. WARNING : 'WARNING',
  38. ERROR : 'ERROR',
  39. CRITICAL: 'ERROR',
  40. }
  41. color_enabled = False
  42. BASECOLOR, BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = list(range(29,38))
  43. COLORS = {
  44. DEBUG3 : CYAN,
  45. DEBUG2 : CYAN,
  46. DEBUG : CYAN,
  47. VERBOSE : BASECOLOR,
  48. NOTE : BASECOLOR,
  49. PLAIN : BASECOLOR,
  50. VERBNOTE: BASECOLOR,
  51. WARNING : YELLOW,
  52. ERROR : RED,
  53. CRITICAL: RED,
  54. }
  55. BLD = '\033[1;%dm'
  56. STD = '\033[%dm'
  57. RST = '\033[0m'
  58. def getLevelName(self, levelno):
  59. try:
  60. return self.levelnames[levelno]
  61. except KeyError:
  62. self.levelnames[levelno] = value = 'Level %d' % levelno
  63. return value
  64. def format(self, record):
  65. record.levelname = self.getLevelName(record.levelno)
  66. if record.levelno == self.PLAIN:
  67. msg = record.getMessage()
  68. else:
  69. if self.color_enabled:
  70. record = self.colorize(record)
  71. msg = logging.Formatter.format(self, record)
  72. if hasattr(record, 'bb_exc_formatted'):
  73. msg += '\n' + ''.join(record.bb_exc_formatted)
  74. elif hasattr(record, 'bb_exc_info'):
  75. etype, value, tb = record.bb_exc_info
  76. formatted = bb.exceptions.format_exception(etype, value, tb, limit=5)
  77. msg += '\n' + ''.join(formatted)
  78. return msg
  79. def colorize(self, record):
  80. color = self.COLORS[record.levelno]
  81. if self.color_enabled and color is not None:
  82. record = copy.copy(record)
  83. record.levelname = "".join([self.BLD % color, record.levelname, self.RST])
  84. record.msg = "".join([self.STD % color, record.msg, self.RST])
  85. return record
  86. def enable_color(self):
  87. self.color_enabled = True
  88. class BBLogFilter(object):
  89. def __init__(self, handler, level, debug_domains):
  90. self.stdlevel = level
  91. self.debug_domains = debug_domains
  92. loglevel = level
  93. for domain in debug_domains:
  94. if debug_domains[domain] < loglevel:
  95. loglevel = debug_domains[domain]
  96. handler.setLevel(loglevel)
  97. handler.addFilter(self)
  98. def filter(self, record):
  99. if record.levelno >= self.stdlevel:
  100. return True
  101. if record.name in self.debug_domains and record.levelno >= self.debug_domains[record.name]:
  102. return True
  103. return False
  104. class BBLogFilterStdErr(BBLogFilter):
  105. def filter(self, record):
  106. if not BBLogFilter.filter(self, record):
  107. return False
  108. if record.levelno >= logging.ERROR:
  109. return True
  110. return False
  111. class BBLogFilterStdOut(BBLogFilter):
  112. def filter(self, record):
  113. if not BBLogFilter.filter(self, record):
  114. return False
  115. if record.levelno < logging.ERROR:
  116. return True
  117. return False
  118. # Message control functions
  119. #
  120. loggerDefaultDebugLevel = 0
  121. loggerDefaultVerbose = False
  122. loggerVerboseLogs = False
  123. loggerDefaultDomains = []
  124. def init_msgconfig(verbose, debug, debug_domains=None):
  125. """
  126. Set default verbosity and debug levels config the logger
  127. """
  128. bb.msg.loggerDefaultDebugLevel = debug
  129. bb.msg.loggerDefaultVerbose = verbose
  130. if verbose:
  131. bb.msg.loggerVerboseLogs = True
  132. if debug_domains:
  133. bb.msg.loggerDefaultDomains = debug_domains
  134. else:
  135. bb.msg.loggerDefaultDomains = []
  136. def constructLogOptions():
  137. debug = loggerDefaultDebugLevel
  138. verbose = loggerDefaultVerbose
  139. domains = loggerDefaultDomains
  140. if debug:
  141. level = BBLogFormatter.DEBUG - debug + 1
  142. elif verbose:
  143. level = BBLogFormatter.VERBOSE
  144. else:
  145. level = BBLogFormatter.NOTE
  146. debug_domains = {}
  147. for (domainarg, iterator) in groupby(domains):
  148. dlevel = len(tuple(iterator))
  149. debug_domains["BitBake.%s" % domainarg] = logging.DEBUG - dlevel + 1
  150. return level, debug_domains
  151. def addDefaultlogFilter(handler, cls = BBLogFilter, forcelevel=None):
  152. level, debug_domains = constructLogOptions()
  153. if forcelevel is not None:
  154. level = forcelevel
  155. cls(handler, level, debug_domains)
  156. #
  157. # Message handling functions
  158. #
  159. def fatal(msgdomain, msg):
  160. if msgdomain:
  161. logger = logging.getLogger("BitBake.%s" % msgdomain)
  162. else:
  163. logger = logging.getLogger("BitBake")
  164. logger.critical(msg)
  165. sys.exit(1)
  166. def logger_create(name, output=sys.stderr, level=logging.INFO, preserve_handlers=False, color='auto'):
  167. """Standalone logger creation function"""
  168. logger = logging.getLogger(name)
  169. console = logging.StreamHandler(output)
  170. format = bb.msg.BBLogFormatter("%(levelname)s: %(message)s")
  171. if color == 'always' or (color == 'auto' and output.isatty()):
  172. format.enable_color()
  173. console.setFormatter(format)
  174. if preserve_handlers:
  175. logger.addHandler(console)
  176. else:
  177. logger.handlers = [console]
  178. logger.setLevel(level)
  179. return logger
  180. def has_console_handler(logger):
  181. for handler in logger.handlers:
  182. if isinstance(handler, logging.StreamHandler):
  183. if handler.stream in [sys.stderr, sys.stdout]:
  184. return True
  185. return False