logger.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  1. # This Python file uses the following encoding: utf-8
  2. # @author runhey
  3. # github https://github.com/runhey
  4. import datetime
  5. import logging
  6. import os
  7. import sys
  8. import traceback
  9. from io import TextIOBase
  10. from typing import Callable, List
  11. from rich.console import Console, ConsoleOptions, ConsoleRenderable, NewLine
  12. from rich.highlighter import RegexHighlighter, NullHighlighter
  13. from rich.logging import RichHandler
  14. from rich.text import Text
  15. from rich.rule import Rule
  16. from rich.style import Style
  17. from rich.theme import Theme
  18. from rich.traceback import Traceback
  19. def empty_function(*args, **kwargs):
  20. pass
  21. # cnocr will set root logger in cnocr.utils
  22. # Delete logging.basicConfig to avoid logging the same message twice.
  23. logging.basicConfig = empty_function
  24. logging.raiseExceptions = True # Set True if wanna see encode errors on console
  25. # Remove HTTP keywords (GET, POST etc.)
  26. RichHandler.KEYWORDS = []
  27. class RichFileHandler(RichHandler):
  28. # Rename
  29. pass
  30. class LogStream(TextIOBase):
  31. def __init__(self, *args, func: Callable[[ConsoleRenderable], None] = None, **kwargs):
  32. super().__init__(*args, **kwargs)
  33. self._func = func
  34. def write(self, msg: str) -> int:
  35. if isinstance(msg, bytes):
  36. msg = msg.decode("utf-8")
  37. self._func(msg)
  38. return len(msg)
  39. class RichRenderableHandler(RichHandler):
  40. """
  41. Pass renderable into a function
  42. 主要是传入一个回调函数
  43. """
  44. def __init__(self, *args, func: Callable[[ConsoleRenderable], None] = None, **kwargs):
  45. super().__init__(*args, **kwargs)
  46. self._func = func
  47. def emit(self, record: logging.LogRecord) -> None:
  48. message = self.format(record)
  49. tb = None
  50. if (
  51. self.rich_tracebacks
  52. and record.exc_info
  53. and record.exc_info != (None, None, None)
  54. ):
  55. exc_type, exc_value, exc_traceback = record.exc_info
  56. traceback.print_tb(exc_traceback)
  57. self._func(exc_traceback)
  58. assert exc_type is not None
  59. assert exc_value is not None
  60. tb = Traceback.from_exception(
  61. exc_type,
  62. exc_value,
  63. exc_traceback,
  64. width=self.tracebacks_width,
  65. extra_lines=self.tracebacks_extra_lines,
  66. theme=self.tracebacks_theme,
  67. word_wrap=self.tracebacks_word_wrap,
  68. show_locals=self.tracebacks_show_locals,
  69. locals_max_length=self.locals_max_length,
  70. locals_max_string=self.locals_max_string,
  71. )
  72. # 这个好理解转化为特定格式, getMessage()返回寸str
  73. message = record.getMessage()
  74. if self.formatter:
  75. record.message = record.getMessage()
  76. formatter = self.formatter
  77. if hasattr(formatter, "usesTime") and formatter.usesTime():
  78. record.asctime = formatter.formatTime(
  79. record, formatter.datefmt)
  80. message = formatter.formatMessage(record)
  81. # 这个message_renderable是一个Text对象
  82. message_renderable = self.render_message(record, message)
  83. log_renderable: ConsoleRenderable = self.render(
  84. record=record, traceback=tb, message_renderable=message_renderable
  85. )
  86. # msg2 = Text.from_markup(message).markup
  87. # 这个message_renderable是一个Text对象
  88. # traceback是表示异常的对象
  89. # Directly put renderable into function
  90. self._func(message_renderable)
  91. def handle(self, record: logging.LogRecord) -> bool:
  92. if not self._func:
  93. return True
  94. super().handle(record)
  95. class HTMLConsole(Console):
  96. """
  97. Force full feature console
  98. but not working lol :(
  99. """
  100. @property
  101. def options(self) -> ConsoleOptions:
  102. return ConsoleOptions(
  103. max_height=self.size.height,
  104. size=self.size,
  105. legacy_windows=False,
  106. min_width=1,
  107. max_width=self.width,
  108. encoding='utf-8',
  109. is_terminal=False,
  110. )
  111. class Highlighter(RegexHighlighter):
  112. base_style = 'web.'
  113. highlights = [
  114. # (r'(?P<datetime>(\d{2}|\d{4})(?:\-)?([0]{1}\d{1}|[1]{1}[0-2]{1})'
  115. # r'(?:\-)?([0-2]{1}\d{1}|[3]{1}[0-1]{1})(?:\s)?([0-1]{1}\d{1}|'
  116. # r'[2]{1}[0-3]{1})(?::)?([0-5]{1}\d{1})(?::)?([0-5]{1}\d{1}).\d+\b)'),
  117. (r'(?P<time>([0-1]{1}\d{1}|[2]{1}[0-3]{1})(?::)?'
  118. r'([0-5]{1}\d{1})(?::)?([0-5]{1}\d{1})(.\d+\b))'),
  119. r"(?P<brace>[\{\[\(\)\]\}])",
  120. r"\b(?P<bool_true>True)\b|\b(?P<bool_false>False)\b|\b(?P<none>None)\b",
  121. r"(?P<path>(([A-Za-z]\:)|.)?\B([\/\\][\w\.\-\_\+]+)*[\/\\])(?P<filename>[\w\.\-\_\+]*)?",
  122. # r"(?<![\\\w])(?P<str>b?\'\'\'.*?(?<!\\)\'\'\'|b?\'.*?(?<!\\)\'|b?\"\"\".*?(?<!\\)\"\"\"|b?\".*?(?<!\\)\")",
  123. ]
  124. WEB_THEME = Theme({
  125. "web.brace": Style(bold=True),
  126. "web.bool_true": Style(color="bright_green", italic=True),
  127. "web.bool_false": Style(color="bright_red", italic=True),
  128. "web.none": Style(color="magenta", italic=True),
  129. "web.path": Style(color="magenta"),
  130. "web.filename": Style(color="bright_magenta"),
  131. "web.str": Style(color="green", italic=False, bold=False),
  132. "web.time": Style(color="cyan"),
  133. "rule.text": Style(bold=True),
  134. })
  135. def show_handlers(handlers):
  136. # 获取并打印日志记录器中处理器的信息
  137. for handler in logger.handlers:
  138. # 获取处理器的类名
  139. handler_class = handler.__class__.__name__
  140. print(f"Handler class: {handler_class}")
  141. # 获取处理器的级别
  142. handler_level = logging.getLevelName(handler.level)
  143. print(f"Handler level: {handler_level}")
  144. # 获取处理器的格式化器
  145. formatter = handler.formatter
  146. if formatter is not None:
  147. formatter_class = formatter.__class__.__name__
  148. print(f"Formatter class: {formatter_class}")
  149. # 其他处理器的属性和方法,根据需要进行获取和打印
  150. print() # 打印空行,用于分隔处理器的信息
  151. # Logger init
  152. logger_debug = False
  153. logger = logging.getLogger('oas')
  154. logger.setLevel(logging.DEBUG if logger_debug else logging.INFO)
  155. file_formatter = logging.Formatter(
  156. fmt='%(asctime)s.%(msecs)03d | %(levelname)s | %(message)s', datefmt='%Y-%m-%d %H:%M:%S')
  157. console_formatter = logging.Formatter(
  158. fmt='%(asctime)s.%(msecs)03d │ %(message)s', datefmt='%Y-%m-%d %H:%M:%S')
  159. web_formatter = logging.Formatter(
  160. fmt='%(asctime)s.%(msecs)03d │ %(message)s', datefmt='%H:%M:%S')
  161. # Add console logger
  162. # console = logging.StreamHandler(stream=sys.stdout)
  163. # console.setFormatter(formatter)
  164. # console.flush = sys.stdout.flush
  165. # logger.addHandler(console)
  166. # Add rich console logger
  167. stdout_console = console = Console()
  168. console_hdlr = RichHandler(
  169. show_path=False,
  170. show_time=False,
  171. rich_tracebacks=True,
  172. tracebacks_show_locals=True,
  173. tracebacks_extra_lines=3,
  174. )
  175. console_hdlr.setFormatter(console_formatter)
  176. logger.addHandler(console_hdlr)
  177. # Ensure running in Alas root folder
  178. os.chdir(os.path.join(os.path.dirname(__file__), '../'))
  179. # Add file logger
  180. pyw_name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
  181. # 这个函数貌似没有用到
  182. def _set_file_logger(name=pyw_name):
  183. if '_' in name:
  184. name = name.split('_', 1)[0]
  185. log_file = f'./log/{datetime.date.today()}_{name}.txt'
  186. try:
  187. file = logging.FileHandler(log_file, encoding='utf-8')
  188. except FileNotFoundError:
  189. os.mkdir('./log')
  190. file = logging.FileHandler(log_file, encoding='utf-8')
  191. file.setFormatter(file_formatter)
  192. logger.handlers = [h for h in logger.handlers if not isinstance(
  193. h, (logging.FileHandler, RichFileHandler))]
  194. logger.addHandler(file)
  195. logger.log_file = log_file
  196. def set_file_logger(name=pyw_name):
  197. if '_' in name:
  198. name = name.split('_', 1)[0]
  199. log_file = f'./log/{datetime.date.today()}_{name}.txt'
  200. try:
  201. file = open(log_file, mode='a', encoding='utf-8')
  202. except FileNotFoundError:
  203. os.mkdir('./log')
  204. file = open(log_file, mode='a', encoding='utf-8')
  205. file_console = Console(
  206. file=file,
  207. no_color=True,
  208. highlight=False,
  209. width=119,
  210. )
  211. hdlr = RichFileHandler(
  212. console=file_console,
  213. show_path=False,
  214. show_time=False,
  215. show_level=False,
  216. rich_tracebacks=True,
  217. tracebacks_show_locals=True,
  218. tracebacks_extra_lines=3,
  219. highlighter=NullHighlighter(),
  220. )
  221. hdlr.setFormatter(file_formatter)
  222. logger.handlers = [h for h in logger.handlers if not isinstance(
  223. h, (logging.FileHandler, RichFileHandler))]
  224. logger.addHandler(hdlr)
  225. logger.log_file = log_file
  226. # 给web设置
  227. def set_func_logger(func):
  228. stream = LogStream(func=func)
  229. file_console = Console(
  230. file=stream,
  231. no_color=True,
  232. highlight=False,
  233. width=160,
  234. )
  235. hdlr = RichFileHandler(
  236. console=file_console,
  237. show_path=False,
  238. show_time=False,
  239. show_level=True,
  240. rich_tracebacks=True,
  241. tracebacks_show_locals=True,
  242. tracebacks_extra_lines=3,
  243. highlighter=NullHighlighter(),
  244. )
  245. hdlr.setFormatter(web_formatter)
  246. logger.addHandler(hdlr)
  247. def _get_renderables(
  248. self: Console, *objects, sep=" ", end="\n", justify=None, emoji=None, markup=None, highlight=None,
  249. ) -> List[ConsoleRenderable]:
  250. """
  251. Refer to rich.console.Console.print()
  252. """
  253. if not objects:
  254. objects = (NewLine(),)
  255. render_hooks = self._render_hooks[:]
  256. with self:
  257. renderables = self._collect_renderables(
  258. objects,
  259. sep,
  260. end,
  261. justify=justify,
  262. emoji=emoji,
  263. markup=markup,
  264. highlight=highlight,
  265. )
  266. for hook in render_hooks:
  267. renderables = hook.process_renderables(renderables)
  268. return renderables
  269. def print(*objects: ConsoleRenderable, **kwargs):
  270. for hdlr in logger.handlers:
  271. if isinstance(hdlr, RichRenderableHandler):
  272. for renderable in _get_renderables(hdlr.console, *objects, **kwargs):
  273. hdlr._func(renderable)
  274. elif isinstance(hdlr, RichHandler):
  275. hdlr.console.print(*objects)
  276. def rule(title="", *, characters="─", style="rule.line", end="\n", align="center"):
  277. rule = Rule(title=title, characters=characters,
  278. style=style, end=end, align=align)
  279. print(rule)
  280. def hr(title, level=3):
  281. title = str(title).upper()
  282. if level == 1:
  283. logger.rule(title, characters='═')
  284. logger.info(title)
  285. if level == 2:
  286. logger.rule(title, characters='─')
  287. logger.info(title)
  288. if level == 3:
  289. logger.info(f"[bold]<<< {title} >>>[/bold]", extra={"markup": True})
  290. if level == 0:
  291. logger.rule(characters='═')
  292. logger.rule(title, characters=' ')
  293. logger.rule(characters='═')
  294. def attr(name, text):
  295. logger.info('[%s] %s' % (str(name), str(text)))
  296. def attr_align(name, text, front='', align=22):
  297. name = str(name).rjust(align)
  298. if front:
  299. name = front + name[len(front):]
  300. logger.info('%s: %s' % (name, str(text)))
  301. def show():
  302. logger.info('INFO')
  303. logger.warning('WARNING')
  304. logger.debug('DEBUG')
  305. logger.error('ERROR')
  306. logger.critical('CRITICAL')
  307. logger.hr('hr0', 0)
  308. logger.hr('hr1', 1)
  309. logger.hr('hr2', 2)
  310. logger.hr('hr3', 3)
  311. logger.info(r'Brace { [ ( ) ] }')
  312. logger.info(r'True, False, None')
  313. logger.info(r'E:/path\\to/alas/alas.exe, /root/alas/, ./relative/path/log.txt')
  314. local_var1 = 'This is local variable'
  315. # Line before exception
  316. raise Exception("Exception")
  317. # Line below exception
  318. def error_convert(func):
  319. def error_wrapper(msg, *args, **kwargs):
  320. if isinstance(msg, Exception):
  321. msg = f'{type(msg).__name__}: {msg}'
  322. return func(msg, *args, **kwargs)
  323. return error_wrapper
  324. logger.error = error_convert(logger.error)
  325. logger.hr = hr
  326. logger.attr = attr
  327. logger.attr_align = attr_align
  328. logger.set_file_logger = set_file_logger
  329. logger.set_func_logger = set_func_logger
  330. logger.rule = rule
  331. logger.print = print
  332. logger.log_file: str
  333. logger.set_file_logger()
  334. logger.hr('Start', level=0)