logger.py 11 KB

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