logger.py 12 KB

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