logger.py 11 KB

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