logger.py 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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. # Ensure running in Alas root folder
  22. os.chdir(os.path.join(os.path.dirname(__file__), '../'))
  23. # cnocr will set root logger in cnocr.utils
  24. # Delete logging.basicConfig to avoid logging the same message twice.
  25. logging.basicConfig = empty_function
  26. logging.raiseExceptions = True # Set True if wanna see encode errors on console
  27. # Remove HTTP keywords (GET, POST etc.)
  28. # RichHandler.KEYWORDS = []
  29. # def show_handlers(handlers):
  30. # # 获取并打印日志记录器中处理器的信息
  31. # for handler in logger.handlers:
  32. # # 获取处理器的类名
  33. # handler_class = handler.__class__.__name__
  34. # print(f"Handler class: {handler_class}")
  35. #
  36. # # 获取处理器的级别
  37. # handler_level = logging.getLevelName(handler.level)
  38. # print(f"Handler level: {handler_level}")
  39. #
  40. # # 获取处理器的格式化器
  41. # formatter = handler.formatter
  42. # if formatter is not None:
  43. # formatter_class = formatter.__class__.__name__
  44. # print(f"Formatter class: {formatter_class}")
  45. #
  46. # # 其他处理器的属性和方法,根据需要进行获取和打印
  47. # print() # 打印空行,用于分隔处理器的信息
  48. # Logger init
  49. logger_debug = False
  50. logger = logging.getLogger('oas')
  51. logger.setLevel(logging.DEBUG if logger_debug else logging.INFO)
  52. file_formatter = logging.Formatter(
  53. fmt='%(asctime)s.%(msecs)03d | %(filename)s:%(lineno)d | %(levelname)8s | %(message)s', datefmt='%Y-%m-%d %H:%M:%S')
  54. console_formatter = logging.Formatter(
  55. fmt='%(asctime)s.%(msecs)03d │ %(message)s', datefmt='%Y-%m-%d %H:%M:%S')
  56. flutter_formatter = logging.Formatter(
  57. fmt='| %(asctime)s.%(msecs)03d | %(message)08s', datefmt='%H:%M:%S')
  58. # ======================================================================================================================
  59. # Set console logger
  60. # ======================================================================================================================
  61. console_hdlr = RichHandler(
  62. console=Console(
  63. width=160
  64. ),
  65. show_path=False,
  66. show_time=False,
  67. rich_tracebacks=True,
  68. tracebacks_show_locals=True,
  69. tracebacks_extra_lines=3,
  70. tracebacks_width=160
  71. )
  72. console_hdlr.setFormatter(console_formatter)
  73. logger.addHandler(console_hdlr)
  74. # ======================================================================================================================
  75. # Set file
  76. # ======================================================================================================================
  77. class RichFileHandler(RichHandler):
  78. # Rename
  79. pass
  80. # Add file logger
  81. pyw_name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
  82. def set_file_logger(name=pyw_name):
  83. if '_' in name:
  84. name = name.split('_', 1)[0]
  85. log_file = f'./log/{datetime.date.today()}_{name}.txt'
  86. try:
  87. file = open(log_file, mode='a', encoding='utf-8')
  88. except FileNotFoundError:
  89. os.mkdir('./log')
  90. file = open(log_file, mode='a', encoding='utf-8')
  91. file_console = Console(
  92. file=file,
  93. no_color=True,
  94. highlight=False,
  95. width=160,
  96. )
  97. hdlr = RichFileHandler(
  98. console=file_console,
  99. show_path=False,
  100. show_time=False,
  101. show_level=False,
  102. rich_tracebacks=True,
  103. tracebacks_show_locals=True,
  104. tracebacks_extra_lines=3,
  105. tracebacks_width=160,
  106. highlighter=NullHighlighter(),
  107. )
  108. hdlr.setFormatter(file_formatter)
  109. logger.handlers = [h for h in logger.handlers if not isinstance(
  110. h, (logging.FileHandler, RichFileHandler))]
  111. logger.addHandler(hdlr)
  112. logger.log_file = log_file
  113. # ======================================================================================================================
  114. # Set flutter
  115. # ======================================================================================================================
  116. class FlutterHandler(RichHandler):
  117. # Rename
  118. pass
  119. class FlutterConsole(Console):
  120. """
  121. Force full feature console
  122. but not working lol :(
  123. """
  124. @property
  125. def options(self) -> ConsoleOptions:
  126. return ConsoleOptions(
  127. max_height=self.size.height,
  128. size=self.size,
  129. legacy_windows=False,
  130. min_width=1,
  131. max_width=self.width,
  132. encoding='utf-8',
  133. is_terminal=False,
  134. )
  135. class FlutterLogStream(TextIOBase):
  136. def __init__(self, *args, func: Callable[[ConsoleRenderable], None] = None, **kwargs):
  137. super().__init__(*args, **kwargs)
  138. self._func = func
  139. def write(self, msg: str) -> int:
  140. if isinstance(msg, bytes):
  141. msg = msg.decode("utf-8")
  142. self._func(msg)
  143. return len(msg)
  144. def set_func_logger(func):
  145. stream = FlutterLogStream(func=func)
  146. stream_console = Console(
  147. file=stream,
  148. force_terminal=False,
  149. force_interactive=False,
  150. no_color=True,
  151. highlight=False,
  152. width=80,
  153. )
  154. hdlr = FlutterHandler(
  155. console=stream_console,
  156. show_path=False,
  157. show_time=False,
  158. show_level=True,
  159. rich_tracebacks=True,
  160. tracebacks_show_locals=True,
  161. tracebacks_extra_lines=3,
  162. highlighter=NullHighlighter(),
  163. )
  164. hdlr.setFormatter(flutter_formatter)
  165. logger.addHandler(hdlr)
  166. # ======================================================================================================================
  167. # Set print format
  168. # ======================================================================================================================
  169. def _get_renderables(
  170. self: Console, *objects, sep=" ", end="\n", justify=None, emoji=None, markup=None, highlight=None,
  171. ) -> List[ConsoleRenderable]:
  172. """
  173. Refer to rich.console.Console.print()
  174. """
  175. if not objects:
  176. objects = (NewLine(),)
  177. render_hooks = self._render_hooks[:]
  178. with self:
  179. renderables = self._collect_renderables(
  180. objects,
  181. sep,
  182. end,
  183. justify=justify,
  184. emoji=emoji,
  185. markup=markup,
  186. highlight=highlight,
  187. )
  188. for hook in render_hooks:
  189. renderables = hook.process_renderables(renderables)
  190. return renderables
  191. def print(*objects: ConsoleRenderable, **kwargs):
  192. for hdlr in logger.handlers:
  193. if isinstance(hdlr, FlutterHandler):
  194. for renderable in _get_renderables(hdlr.console, *objects, **kwargs):
  195. hdlr.console.file._func(str(renderable))
  196. elif isinstance(hdlr, RichHandler):
  197. hdlr.console.print(*objects)
  198. class GuiRule(Rule):
  199. def __rich_console__(
  200. self, console: Console, options: ConsoleOptions
  201. ) -> RenderResult:
  202. options.max_width = 80
  203. return super().__rich_console__(console, options)
  204. def __str__(self):
  205. total_width = 80
  206. cell_len = len(self.title) + 2
  207. aside_len = (total_width - cell_len) // 2
  208. left = self.characters * aside_len
  209. right = self.characters * (total_width - cell_len - aside_len)
  210. if self.title:
  211. space = ' '
  212. else:
  213. space = self.characters
  214. return f"{left}{space}{self.title}{space}{right}\n"
  215. def __repr__(self):
  216. return self.__str__()
  217. def rule(title="", *, characters="─", style="rule.line", end="\n", align="center"):
  218. rule = GuiRule(title=title, characters=characters,
  219. style=style, end=end)
  220. print(rule)
  221. def hr(title, level=3):
  222. title = str(title).upper()
  223. if level == 1:
  224. logger.rule(title, characters='═')
  225. logger.info(title)
  226. if level == 2:
  227. logger.rule(title, characters='─')
  228. logger.info(title)
  229. if level == 3:
  230. logger.info(f"[bold]<<< {title} >>>[/bold]", extra={"markup": True})
  231. if level == 0:
  232. logger.rule(characters='═')
  233. logger.rule(title, characters='─')
  234. logger.rule(characters='═')
  235. def attr(name, text):
  236. logger.info('[%s] %s' % (str(name), str(text)))
  237. def attr_align(name, text, front='', align=22):
  238. name = str(name).rjust(align)
  239. if front:
  240. name = front + name[len(front):]
  241. logger.info('%s: %s' % (name, str(text)))
  242. def show():
  243. logger.info('INFO')
  244. logger.warning('WARNING')
  245. logger.debug('DEBUG')
  246. logger.error('ERROR')
  247. logger.critical('CRITICAL')
  248. logger.hr('hr0', 0)
  249. logger.hr('hr1', 1)
  250. logger.hr('hr2', 2)
  251. logger.hr('hr3', 3)
  252. logger.info(r'Brace { [ ( ) ] }')
  253. logger.info(r'True, False, None')
  254. logger.info(r'E:/path\\to/alas/alas.exe, /root/alas/, ./relative/path/log.txt')
  255. logger.info('Tests very long strings. Tests very long strings. Tests very long strings. Tests very long strings. Tests very long strings.')
  256. local_var1 = 'This is local variable'
  257. # Line before exception
  258. raise Exception("Exception")
  259. # Line below exception
  260. def error_convert(func):
  261. def error_wrapper(msg, *args, **kwargs):
  262. if isinstance(msg, Exception):
  263. msg = f'{type(msg).__name__}: {msg}'
  264. return func(msg, *args, **kwargs)
  265. return error_wrapper
  266. logger.error = error_convert(logger.error)
  267. logger.hr = hr
  268. logger.attr = attr
  269. logger.attr_align = attr_align
  270. logger.set_file_logger = set_file_logger
  271. logger.set_func_logger = set_func_logger
  272. logger.rule = rule
  273. logger.print = print
  274. logger.log_file: str
  275. logger.set_file_logger()
  276. logger.hr('Start', level=0)