Difficult-Rocket/libs/utils/logger.py

1066 lines
37 KiB
Python
Raw Normal View History

2022-07-04 15:12:04 +08:00
"""
@author shenjackyuanjie
@contact 3695888@qq.com
"""
# -------------------------------
# Difficult Rocket
# Copyright © 2021-2022 by shenjackyuanjie 3695888@qq.com
# All rights reserved
# -------------------------------
2022-11-26 21:48:55 +08:00
import io
2022-08-12 21:07:36 +08:00
import os
2022-11-08 20:18:01 +08:00
import re
2022-11-11 09:33:34 +08:00
import sys
import time
2022-06-27 14:42:26 +08:00
import atexit
import inspect
2022-06-27 16:22:40 +08:00
import threading
2022-11-11 09:33:34 +08:00
import dataclasses
2022-06-27 14:42:26 +08:00
from types import FrameType
2022-11-11 09:33:34 +08:00
from logging import NOTSET, DEBUG
from typing import NamedTuple, Optional, Type, Union, Dict, Iterable, Any, List
2022-11-01 18:34:02 +08:00
2022-11-15 06:30:33 +08:00
Version = '1.0.0'
# os.system('')
color_support = True
if sys.platform == "win32":
try:
# https://stackoverflow.com/questions/36760127/...
# how-to-use-the-new-support-for-ansi-escape-sequences-in-the-windows-10-console
from ctypes import windll
kernel32 = windll.kernel32
kernel32.SetConsoleMode(kernel32.GetStdHandle(-11), 7)
except OSError: # pragma: no cover
color_support = False
2022-09-04 13:02:58 +08:00
# print(os.path.abspath(os.curdir))
2022-11-08 20:18:01 +08:00
# TODO 这个文件就是个大TODO
2022-10-02 22:24:38 +08:00
"""
如果想要直接使用 logger logging
直接调用 logger.debug() 即可
默认配置会有
----------
配置方式一
直接使用 logger.Logger()
将会创建一个空 logger
可以自行通过
配置方式二
logger = logger.get_logger(name)
直接获取一个配置好的logger
"""
2022-08-16 13:25:44 +08:00
2022-06-27 14:42:26 +08:00
color_reset_suffix = "\033[0m"
2022-07-25 18:28:42 +08:00
""" 只是用来重置颜色的后缀 """
2022-06-27 14:42:26 +08:00
re_find_color_code = r'\033\[[^\f\n\r\t\vm]*m'
re_color_code = re.compile(re_find_color_code)
2022-11-15 06:30:33 +08:00
re_find_level_code = r''
2022-10-29 19:13:00 +08:00
2022-07-04 15:12:04 +08:00
"""
2022-07-25 18:28:42 +08:00
OFF > FATAL > ERROR > WARN > INFO > FINE > FINER > DEBUG > TRACE > ALL
2022-07-04 15:12:04 +08:00
logging.py
CRITICAL = 50
FATAL = CRITICAL
ERROR = 40
WARNING = 30
WARN = WARNING
INFO = 20
DEBUG = 10
NOTSET = 0
"""
2022-08-03 20:22:36 +08:00
FINE = 7
2022-10-02 22:24:38 +08:00
TRACE = 5
ALL = NOTSET
2022-07-07 18:28:29 +08:00
2022-10-29 19:13:00 +08:00
class LoggingLevel:
2022-10-02 22:24:38 +08:00
"""定义LoggingLevel属性即是变量 """
CRITICAL = 50
FATAL = CRITICAL
ERROR = 40
WARNING = 30
WARN = WARNING
INFO = 20
DEBUG = 10
FINE = 7
TRACE = 5
NOTSET = 0
ALL = NOTSET
2022-11-01 18:34:02 +08:00
CRITICAL_t = 'CRITICAL'
FATAL_t = 'FATAL'
ERROR_t = 'ERROR'
WARNING_t = 'WARNING'
WARN_t = 'WARN'
INFO_t = 'INFO'
DEBUG_t = 'DEBUG'
FINE_t = 'FINE'
TRACE_t = 'TRACE'
NOTSET_t = 'NOTSET'
ALL_t = 'ALL'
2022-10-29 19:13:00 +08:00
@staticmethod
2022-11-01 18:34:02 +08:00
def type() -> Type:
2022-10-11 21:53:55 +08:00
return int
2022-10-29 19:13:00 +08:00
logging_level_type = int
level_name_map: Dict[logging_level_type, str] = {
2022-10-15 17:38:35 +08:00
LoggingLevel.ALL: 'ALL', # NOTSET
LoggingLevel.TRACE: 'TRACE',
LoggingLevel.FINE: 'FINE',
LoggingLevel.DEBUG: 'DEBUG',
LoggingLevel.INFO: 'INFO',
2022-10-02 22:24:38 +08:00
LoggingLevel.WARNING: 'WARNING', # WARN
2022-10-15 17:38:35 +08:00
LoggingLevel.ERROR: 'ERROR',
LoggingLevel.FATAL: 'FATAL'
2022-08-12 21:07:36 +08:00
}
2022-10-29 19:13:00 +08:00
name_level_map: Dict[str, logging_level_type] = {
2022-10-15 17:38:35 +08:00
'NOTSET': LoggingLevel.ALL,
'ALL': LoggingLevel.ALL,
'TRACE': LoggingLevel.TRACE,
'FINE': LoggingLevel.FINE,
'DEBUG': LoggingLevel.DEBUG,
'INFO': LoggingLevel.INFO,
'WARNING': LoggingLevel.WARNING,
'WARN': LoggingLevel.WARNING,
'ERROR': LoggingLevel.ERROR,
2022-10-02 22:24:38 +08:00
'CRITICAL': LoggingLevel.FATAL,
2022-10-15 17:38:35 +08:00
'FATAL': LoggingLevel.FATAL
2022-08-12 21:07:36 +08:00
}
2022-10-29 19:13:00 +08:00
def get_level_by_name(name: str) -> logging_level_type:
return name_level_map[name.upper()]
2022-11-01 18:34:02 +08:00
def get_name_by_level(level: logging_level_type) -> str:
return level_name_map[level]
2022-10-02 22:24:38 +08:00
logger_configs = {
2022-10-15 17:38:35 +08:00
'Logger': {
'root': {
2022-10-29 19:13:00 +08:00
'level': DEBUG,
'color': 'main_color',
2022-10-15 17:38:35 +08:00
'file': 'main_log_file',
},
'client': {
2022-10-29 19:13:00 +08:00
'level': TRACE,
2022-11-27 13:45:59 +08:00
'color': 'fancy_main_color',
2022-10-15 17:38:35 +08:00
'file': 'main_log_file',
},
'server': {
2022-10-29 19:13:00 +08:00
'level': TRACE,
2022-09-04 13:53:09 +08:00
'color': 'DiGua_color',
2022-10-15 17:38:35 +08:00
'file': 'main_log_file',
},
2022-11-01 18:34:02 +08:00
},
2022-10-15 17:38:35 +08:00
'Color': {
2022-10-29 19:13:00 +08:00
'main_color': {
2022-11-01 18:34:02 +08:00
'main_time': '\033[38;2;201;222;56m',
'file_name': '\033[38;2;0;255;180m',
'code_line': '\033[38;2;0;255;180m',
'info': '\033[0m',
'message': '\033[0m',
'logger': '\033[0m',
2022-11-11 09:33:34 +08:00
'marker': '\033[0m',
2022-11-01 18:34:02 +08:00
LoggingLevel.TRACE_t: {'info': '\033[38;2;138;173;244m'},
LoggingLevel.FINE_t: {'info': '\033[35;48;2;44;44;54m'},
LoggingLevel.DEBUG_t: {'info': '\033[38;2;133;138;149m'},
LoggingLevel.INFO_t: {'info': '\033[0m'},
LoggingLevel.WARNING_t: {'info': '\033[33m'},
LoggingLevel.ERROR_t: {'info': '\033[31m'},
2022-11-08 20:18:01 +08:00
LoggingLevel.FATAL_t: {'info': '\033[38;2;255;255;0;48;2;120;10;10m', 'logger': '\033[38;2;245;189;230m'}
2022-10-29 19:13:00 +08:00
},
'fancy_main_color': {
2022-11-01 18:34:02 +08:00
'main_time': '\033[38;2;201;222;56m',
'file_name': '\033[38;2;0;255;180m',
'code_line': '\033[38;2;0;255;180m',
2022-11-27 13:45:59 +08:00
'info': '\033[0m',
2022-11-01 18:34:02 +08:00
'message': '\033[0m',
2022-11-27 13:45:59 +08:00
'logger': '\033[0m',
'marker': '\033[0m',
2022-11-01 18:34:02 +08:00
LoggingLevel.TRACE_t: {'info': '\033[38;2;138;173;244m', 'message': '\033[38;2;138;173;244m'},
LoggingLevel.FINE_t: {'info': '\033[35;48;2;44;44;54m', 'message': '\033[35m'},
LoggingLevel.DEBUG_t: {'info': '\033[38;2;133;138;149m', 'message': '\033[38;2;133;138;149m'},
2022-11-27 13:45:59 +08:00
LoggingLevel.INFO_t: {'info': '\033[0m', 'message': '\033[0m'},
2022-11-01 18:34:02 +08:00
LoggingLevel.WARNING_t: {'info': '\033[33m', 'message': '\033[33m'},
LoggingLevel.ERROR_t: {'info': '\033[31m', 'message': '\033[31m'},
2022-11-01 23:22:39 +08:00
LoggingLevel.FATAL_t: {'info': '\033[38;2;255;255;0;48;2;120;10;10m',
'message': '\033[38;2;255;255;0;48;2;120;10;10m', 'logger': '\033[38;2;245;189;230m'}
2022-09-04 13:02:58 +08:00
},
2022-10-29 19:13:00 +08:00
'DiGua_color': {
2022-09-04 13:53:09 +08:00
# catppuccin Macchiato
2022-11-01 18:34:02 +08:00
'main_time': '\033[38;2;202;211;245m',
'file_name': '\033[38;2;139;213;202m',
'code_line': '\033[38;2;166;218;149m',
2022-11-27 13:45:59 +08:00
'info': '\033[0m',
2022-11-01 18:34:02 +08:00
'logger': '\033[0m',
'message': '\033[0m',
2022-11-27 13:45:59 +08:00
'marker': '\033[0m',
2022-11-01 18:34:02 +08:00
LoggingLevel.TRACE_t: {'info': '\033[38;2;138;173;244m', 'message': '\033[38;2;138;173;244m'},
LoggingLevel.FINE_t: {'info': '\033[38;2;198;160;246m', 'message': '\033[38;2;198;160;246m'},
LoggingLevel.DEBUG_t: {'info': '\033[38;2;133;138;149m', 'message': '\033[38;2;133;138;149m'},
2022-11-27 13:45:59 +08:00
LoggingLevel.INFO_t: {'info': '\033[0m', 'message': '\033[0m'},
2022-11-01 18:34:02 +08:00
LoggingLevel.WARNING_t: {'info': '\033[38;2;245;169;127m', 'message': '\033[38;2;245;169;127m'},
LoggingLevel.ERROR_t: {'info': '\033[38;2;237;135;150m', 'message': '\033[38;2;237;135;150m'},
2022-11-01 23:22:39 +08:00
LoggingLevel.FATAL_t: {'info': '\033[38;2;255;255;0;48;2;120;10;10m',
'message': '\033[38;2;255;255;0;48;2;120;10;10m', 'logger': '\033[38;2;245;189;230m'}
}
},
2022-10-15 17:38:35 +08:00
'File': {
'main_log_file': {
2022-10-15 17:38:35 +08:00
'mode': 'a',
'encoding': 'utf-8',
2022-10-29 19:13:00 +08:00
'level': TRACE,
2022-11-01 23:22:39 +08:00
'file_name': './logs/{long_time}_logs.md',
2022-10-15 17:38:35 +08:00
'cache_len': 10,
2022-09-04 13:02:58 +08:00
'cache_time': 1
},
},
'Formatter': {
2022-11-01 23:22:39 +08:00
'MESSAGE': {
2022-11-01 18:34:02 +08:00
'format': '[{long_time}] [{logger_name}] {level} | {file_name}:{code_line} | {message}'
},
2022-11-01 23:22:39 +08:00
'file_name': 'no frame',
'code_line': 'no frame',
2022-11-01 18:34:02 +08:00
'short_time': '%Y-%m-%d %H-%M-%S',
2022-11-01 23:22:39 +08:00
'long_time': '%Y-%m-%d %H-%M-%S:%%S',
}
}
2022-08-12 21:07:36 +08:00
2022-11-11 09:33:34 +08:00
@dataclasses.dataclass
2022-10-29 19:13:00 +08:00
class LogFileConf:
2022-11-11 09:33:34 +08:00
file_name: str = 'logs/log.txt'
file_mode: str = 'a'
file_encoding: str = 'utf-8'
file_level: logging_level_type = LoggingLevel.DEBUG
file_cache_len: int = 20
file_cache_time: Union[int, float] = 1
class Message_content(NamedTuple):
"""用于存储 log 信息的不可变元组"""
log_time: float
text: str
level: int
marker: Optional[str] = None
end: Optional[str] = '\n'
flush: Optional[bool] = False
frame: Optional[FrameType] = None
2022-10-29 19:13:00 +08:00
2022-11-27 13:45:59 +08:00
def __str__(self):
return f"Message Content at {self.log_time}|in level {self.level}|with marker {self.marker}|ends as {self.end}|" \
f"by frame {self.frame}|{'and will flush' if self.flush else 'and will not flush'}|" \
f"text are: {self.text}"
2022-10-29 19:13:00 +08:00
2022-09-04 13:02:58 +08:00
class ThreadLock:
"""一个用来 with 的线程锁"""
2022-09-04 13:02:58 +08:00
def __init__(self, the_lock: threading.Lock, time_out: Union[float, int] = 1 / 60) -> None:
2022-10-02 22:24:38 +08:00
"""
:param the_lock: 用于 with 的线程锁
:param time_out: with 的超时时间
"""
2022-09-04 13:02:58 +08:00
self.lock = the_lock
self.time_out = time_out
def __enter__(self):
self.lock.acquire(timeout=self.time_out)
if not self.lock.locked():
raise RuntimeError(f'Lock time Out with {self.time_out}')
return self
def __exit__(self, exc_type, exc_val, exc_tb):
if self.lock.locked():
self.lock.release()
2022-08-12 21:07:36 +08:00
class ListCache:
"""一个线程安全的列表缓存"""
def __init__(self, lock: ThreadLock):
self._cache = []
self.with_thread_lock = lock
def append(self, value: Union[str, Iterable[str]]):
with self.with_thread_lock:
if isinstance(value, str):
2022-08-12 21:07:36 +08:00
self._cache.append(value)
elif isinstance(value, Iterable):
2022-08-12 21:07:36 +08:00
self._cache.append(*value)
else:
2022-11-01 23:22:39 +08:00
raise TypeError(
f"cache must be string or Iterable. not a {type(value)}")
2022-08-12 21:07:36 +08:00
def __getitem__(self, item) -> str:
2022-08-12 21:07:36 +08:00
assert isinstance(item, int)
with self.with_thread_lock:
try:
return self._cache[item]
except IndexError as exp:
print(f'cache:{self.cache}')
2022-11-01 23:22:39 +08:00
raise IndexError(
f'there is no cache at {item}!\ncache:{self.cache}\n{exp}')
2022-08-12 21:07:36 +08:00
def __call__(self, *args, **kwargs) -> List[str]:
2022-08-12 21:07:36 +08:00
return self.cache
def __iter__(self):
self._iter_len = len(self.cache)
2022-08-12 21:07:36 +08:00
return self
def __next__(self):
if self._iter_len == -1:
del self._iter_len
raise StopIteration('there is no more cache')
returns = self.cache[-self._iter_len]
self._iter_len -= 1
2022-08-12 21:07:36 +08:00
return returns
def __bool__(self):
2022-10-02 22:24:38 +08:00
return True if len(self.cache) > 0 else False
2022-08-12 21:07:36 +08:00
@property
def cache(self):
return self._cache
def clear(self):
with self.with_thread_lock:
self.cache.clear()
2022-07-04 15:12:04 +08:00
class FormatterTemplate:
2022-11-11 09:33:34 +08:00
"""用于格式化 log 信息的模板类"""
2022-10-11 21:53:55 +08:00
2022-11-27 13:45:59 +08:00
def __init__(self, formats: dict):
2022-11-11 09:33:34 +08:00
self.formats = formats
2022-10-11 21:53:55 +08:00
def format(self, message: str) -> str:
2022-11-11 09:33:34 +08:00
raise NotImplementedError('There is a formatter that not implemented')
class StdFormatter(FormatterTemplate):
""" 一个标准的格式化类 """
2022-11-27 13:45:59 +08:00
def __init__(self, formats: dict, configs: dict):
2022-11-11 09:33:34 +08:00
super().__init__(formats=formats)
2022-11-27 13:45:59 +08:00
self.configs = configs
2022-11-11 09:33:34 +08:00
...
2022-11-27 13:45:59 +08:00
def format_time(self, input_time: Optional[float] = None) -> Dict[str, str]:
millisecond = str((input_time - int(input_time)) * 1000)
long_time = time.strftime(
self.formats['long_time'].replace('%%S', millisecond))
short_time = time.strftime(
self.formats['short_time'].replace('%%S', millisecond))
return {'long_time': long_time, 'short_time': short_time}
2022-11-11 09:33:34 +08:00
def format(self, message: Message_content) -> Message_content:
2022-11-27 13:45:59 +08:00
times = self.format_time(input_time=message.log_time)
2022-10-11 21:53:55 +08:00
...
"""
logger a
.enable = True
.level = 0
handler b -> shell
.enable = True
.level = 30
handler c -> file
.enable = True
.level = 0
a.info('abc')
b -> none
c -> [info]'abc'
"""
class StreamHandlerTemplate:
""" 一个一个一个 stream template 啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊 """
name = "handler temple"
2022-10-02 22:24:38 +08:00
2022-11-11 09:33:34 +08:00
def __init__(self, level: int, formatter: Optional[FormatterTemplate] = None):
2022-10-11 21:53:55 +08:00
"""
:param level: 处理器输出等级
:param formatter: 格式化处理器
"""
self.enable = True
self.level = level
2022-11-11 09:33:34 +08:00
self.formatter = formatter
2022-10-11 21:53:55 +08:00
2022-11-11 09:33:34 +08:00
def write(self, message: Message_content) -> bool:
2022-10-11 21:53:55 +08:00
"""
输出 文件/stdio 写入信息
2022-11-11 09:33:34 +08:00
:param message: 要写入的信息包
2022-10-11 21:53:55 +08:00
:return: 是否写入成功
"""
raise NotImplementedError("You Need to Implement the 'write' method")
def flush(self) -> bool:
"""
刷新缓冲区
:return: 是否刷新成功
"""
return True
def close(self) -> bool:
"""
:return: stream 是否关闭成功
"""
raise NotImplementedError("You Need to Implement the 'close' method")
2022-11-11 09:33:34 +08:00
def setFormatter(self, fmt: FormatterTemplate) -> None:
2022-10-11 21:53:55 +08:00
"""
用于与 logging 兼容
:param fmt: 要设置的格式化处理器
:return: None
"""
self.formatter = fmt
def __str__(self):
"""
:return: 自己的名字 等级
"""
return f"{self.name}{{level={self.level}}}"
class StdHandler(StreamHandlerTemplate):
2022-10-14 13:49:09 +08:00
""" 向标准输入输出流输出信息 """
2022-10-11 21:53:55 +08:00
name = "std handler"
2022-11-11 09:33:34 +08:00
def __init__(self, level: int, formatter: Optional[FormatterTemplate] = None):
2022-10-11 21:53:55 +08:00
"""
2022-10-14 13:49:09 +08:00
:param level: 级别
:param formatter: 格式器
2022-10-11 21:53:55 +08:00
"""
super().__init__(level=level, formatter=formatter)
2022-11-11 09:33:34 +08:00
def write(self, message: Message_content) -> bool:
print(self.formatter.format(message.text), end=message.end, flush=message.flush)
2022-10-11 21:53:55 +08:00
return True
def close(self) -> bool:
return True
def flush(self) -> bool:
print('', end='', flush=True)
return True
2022-11-26 21:48:55 +08:00
def __repr__(self):
return f'StdHandler(level={self.level}, formatter={self.formatter})'
2022-10-11 21:53:55 +08:00
2022-10-14 13:49:09 +08:00
class CachedFileHandler(StreamHandlerTemplate):
""" 缓存文件的处理器 """
name = 'cached file handler'
2022-11-11 09:33:34 +08:00
def __init__(self, level: int, formatter: Optional[FormatterTemplate] = None, file_conf: Union[dict, LogFileConf, None] = None):
2022-10-14 13:49:09 +08:00
"""
:param level:
:param formatter:
2022-10-29 19:13:00 +08:00
:param file_conf: 文件配置
2022-10-14 13:49:09 +08:00
"""
super().__init__(level=level, formatter=formatter)
2022-11-01 18:34:02 +08:00
if file_conf is not None:
2022-11-03 20:37:30 +08:00
if isinstance(file_conf, dict):
self.file_conf = LogFileConf(**file_conf)
elif isinstance(file_conf, LogFileConf):
self.file_conf = file_conf
2022-11-01 18:34:02 +08:00
else:
2022-11-03 20:37:30 +08:00
self.file_conf = LogFileConf()
# 缓存
2022-11-26 21:48:55 +08:00
self.len = 0
self.cache_stream = io.StringIO()
2022-11-03 20:37:30 +08:00
# 状态
self.started = True
2022-11-11 09:33:34 +08:00
self.thread_started = False
2022-11-26 21:48:55 +08:00
self.flushing = False
2022-11-03 20:37:30 +08:00
# 同步锁
2022-11-26 21:48:55 +08:00
self.threaded_write = threading.Timer(1, self.flush, kwargs={'by_thread': True}) # 基于 timer 的多线程
2022-11-03 20:37:30 +08:00
2022-11-11 09:33:34 +08:00
def _start_thread(self) -> bool:
"""
如果成功启动 返回 True
已经启动则返回 False
:return: 是否启动
"""
if self.thread_started:
return False
2022-11-26 21:48:55 +08:00
self.threaded_write = threading.Timer(1, self.flush, kwargs={'by_thread': True})
2022-11-11 09:33:34 +08:00
self.threaded_write.start()
self.thread_started = True
return True
def _stop_thread(self) -> bool:
"""
成功关闭 返回 True
未开启/关闭失败 返回 False
:return: 是否成功关闭
"""
if not self.threaded_write.is_alive():
self.thread_started = False
return False
self.threaded_write.cancel()
def write(self, message: Message_content) -> bool:
2022-11-26 21:48:55 +08:00
self.len += 1
self.cache_stream.write(message.text)
if message.flush or self.len >= self.file_conf.file_cache_len:
if not self.flush():
self.flush()
elif not self.thread_started:
self._start_thread()
2022-11-03 20:37:30 +08:00
return True
2022-10-14 13:49:09 +08:00
def close(self) -> bool:
2022-11-26 21:48:55 +08:00
self.cache_stream.close()
return True
def flush(self, by_thread: Optional[bool] = False) -> bool:
if by_thread:
self.threaded_write = threading.Timer(1, self.flush, kwargs={'by_thread': True})
self.threaded_write.start()
if self.flushing:
return False
self.flushing = True
if cache := self.cache_stream.getvalue():
self.flushing = True
self.cache_stream.close()
self.cache_stream = io.StringIO()
self.len = 0
with open(file=self.file_conf.file_name, mode=self.file_conf.file_mode,
encoding=self.file_conf.file_encoding) as log_file:
log_file.write(cache)
self.flushing = False
return True
2022-10-14 13:49:09 +08:00
2022-10-02 22:24:38 +08:00
2022-06-27 14:42:26 +08:00
class LogFileCache:
"""日志文件缓存"""
2022-09-04 17:20:36 +08:00
def __init__(self, file_conf: dict):
2022-07-07 18:28:29 +08:00
"""
2022-10-02 22:24:38 +08:00
:param file_conf: 日志文件配置
2022-07-07 18:28:29 +08:00
"""
2022-06-27 14:42:26 +08:00
# 配置相关
2022-11-03 20:37:30 +08:00
self._logfile_name = os.path.abspath(format_str(file_conf['file_name'])) # log 文件名称
self.level: logging_level_type = get_key_from_dict(file_conf, 'level', DEBUG)
self.file_conf = file_conf
2022-09-04 13:02:58 +08:00
self.flush_time = file_conf['cache_time'] # 缓存刷新时长
self.cache_entries_num = file_conf['cache_len']
self.started = True
self.running = False
2022-06-27 16:22:40 +08:00
# 同步锁
2022-07-16 20:20:23 +08:00
self.cache_lock = threading.Lock() # 主锁
2022-11-03 20:37:30 +08:00
self.time_limit_lock = ThreadLock(self.cache_lock, time_out=1 / 60) # 直接用于 with 的主锁
self.threaded_write = threading.Timer(1, self._log_file_time_write, kwargs={'thread': True}) # 基于 timer 的多线程
2022-08-12 21:07:36 +08:00
# 日志缓存表
self.log_cache = ListCache(self.time_limit_lock)
self.file_setup()
def file_setup(self):
cache_time = 0
file_type = self.logfile_name[self.logfile_name.rfind('.'):]
file_pure_name = self.logfile_name[:self.logfile_name.rfind('.')]
while os.path.isfile(self.logfile_name):
cache_time += 1
self.logfile_name = f'{file_pure_name}-{cache_time}{file_type}'
2022-07-04 15:12:04 +08:00
2022-07-16 20:20:23 +08:00
def end_thread(self) -> None:
2022-07-07 18:28:29 +08:00
"""结束日志写入进程,顺手把目前的缓存写入"""
2022-07-16 20:20:23 +08:00
self.cache_lock.acquire(blocking=True)
2022-09-04 13:02:58 +08:00
if self.running:
self.threaded_write.cancel()
self.running = False
2022-08-12 21:07:36 +08:00
self.started = False
2022-07-16 20:20:23 +08:00
self._log_file_time_write()
2022-08-12 21:07:36 +08:00
atexit.unregister(self.end_thread)
2022-07-04 15:12:04 +08:00
2022-07-16 20:20:23 +08:00
def start_thread(self) -> None:
2022-07-04 15:12:04 +08:00
self.threaded_write.start()
2022-08-12 21:07:36 +08:00
self.started = True
2022-09-04 13:02:58 +08:00
self.running = True
2022-07-04 15:12:04 +08:00
atexit.register(self.end_thread)
2022-06-27 16:51:14 +08:00
@property
2022-09-04 13:02:58 +08:00
def logfile_name(self) -> str:
self._logfile_name: str
2022-06-27 16:51:14 +08:00
return self._logfile_name
2022-06-27 14:42:26 +08:00
2022-06-27 16:51:14 +08:00
@logfile_name.setter
2022-09-04 13:02:58 +08:00
def logfile_name(self, value: str) -> None:
with self.time_limit_lock:
2022-07-04 15:12:04 +08:00
self._logfile_name = value
2022-06-27 14:42:26 +08:00
2022-09-04 13:02:58 +08:00
def _log_file_time_write(self, thread: bool = False) -> None:
2022-06-27 14:42:26 +08:00
"""使用 threading.Timer 调用的定时写入日志文件的函数"""
2022-08-12 21:07:36 +08:00
if self.log_cache:
with self.time_limit_lock:
2022-08-12 21:07:36 +08:00
if self.log_cache:
with open(file=self.logfile_name,
2022-11-01 23:22:39 +08:00
encoding=get_key_from_dict(
self.file_conf, 'encoding', 'utf-8'),
mode=get_key_from_dict(self.file_conf, 'mode', 'a')) as log_file:
log_file.writelines(self.log_cache.cache.copy())
self.log_cache.clear()
2022-09-04 13:02:58 +08:00
if thread:
self.running = False
def write_logs(self, string: str, flush: bool = False) -> None:
self.log_cache.append(string)
if len(self.log_cache.cache) >= 10:
self._log_file_time_write()
return None
if flush:
self._log_file_time_write()
2022-09-04 13:02:58 +08:00
if self.started and not self.running:
2022-11-01 23:22:39 +08:00
self.threaded_write = threading.Timer(1, self._log_file_time_write, kwargs={
'thread': True}) # 基于 timer 的多线程
2022-09-04 13:02:58 +08:00
self.threaded_write.start()
self.running = True
2022-06-27 14:42:26 +08:00
class Logger:
2022-10-29 19:13:00 +08:00
"""shenjackのlogger"""
2022-06-27 14:42:26 +08:00
2022-09-04 13:02:58 +08:00
def __init__(self,
name: str = 'root',
level: int = DEBUG,
2022-11-01 18:34:02 +08:00
file_conf: Optional[List[LogFileCache]] = None,
2022-11-01 23:22:39 +08:00
colors: Optional[Dict[Union[int, str],
Dict[str, str]]] = None,
2022-09-04 13:02:58 +08:00
formats=None) -> None:
2022-07-16 20:20:23 +08:00
"""
配置模式: 使用 kwargs 配置
2022-10-02 22:24:38 +08:00
:param name: logger 名称 默认为 root
:param level: logging 输出等级 默认为 DEBUG(10)
:param file_conf: logger 的文件处理配置
:param colors: dict 颜色配置
:param formats: 格式化配置
2022-07-16 20:20:23 +08:00
"""
2022-10-11 21:53:55 +08:00
self.enable = True
self.name = name
self.level = level
2022-11-27 13:45:59 +08:00
self.min_level = self.level
self.colors = colors or logger_configs['Color']['main_color']
2022-09-04 13:02:58 +08:00
self.formats = formats or logger_configs['Formatter'].copy()
2022-10-11 21:53:55 +08:00
self.streams = [] # type: List[StreamHandlerTemplate]
2022-11-11 09:33:34 +08:00
self.handler = []
if file_conf:
2022-09-04 17:20:36 +08:00
self.file_cache = file_conf
2022-11-01 23:22:39 +08:00
self.min_level = min(
*[file.level for file in file_conf], self.level)
2022-06-27 14:42:26 +08:00
else:
2022-09-04 17:20:36 +08:00
self.file_cache = []
2022-07-16 20:20:23 +08:00
self.warn = self.warning
2022-11-01 23:22:39 +08:00
def format_formats(self) -> None:
if 'long_time' not in self.formats:
self.formats['long_time'] = '%Y-%m-%d %H-%M-%S:%%S'
if 'short_time' not in self.formats:
self.formats['short_time'] = '%Y-%m-%d %H-%M-%S'
2022-07-16 20:20:23 +08:00
2022-10-11 21:53:55 +08:00
def add_stream(self, stream: StreamHandlerTemplate) -> bool:
"""
logger 添加一个输出方法 (stream handler)
:param stream: 将要添加的 stream handler
:return: 是否添加成功 如果 stream 已经存在则返回 False
"""
if stream in self.streams:
return False
self.streams.append(stream)
return True
2022-11-01 18:34:02 +08:00
def enabled_for(self, level: logging_level_type) -> bool:
2022-10-11 21:53:55 +08:00
if not self.enable:
return False
2022-11-27 13:45:59 +08:00
if level < self.min_level:
return False
2022-11-01 18:34:02 +08:00
return True
2022-11-01 23:22:39 +08:00
2022-11-27 13:45:59 +08:00
# def format_time(self, input_time: Optional[float] = None) -> Dict[str, str]:
# # 毫秒
# get_time: float = input_time or time.time()
# millisecond = str((get_time - int(get_time)) * 1000)
# long_time = time.strftime(
# self.formats['long_time'].replace('%%S', millisecond))
# short_time = time.strftime(
# self.formats['short_time'].replace('%%S', millisecond))
# return {'long_time': long_time, 'short_time': short_time}
2022-09-04 17:20:36 +08:00
2022-10-11 21:53:55 +08:00
# def filter_and_make_log(): make_log(formatted_string)
2022-07-16 20:20:23 +08:00
def make_log(self, *values: object,
level: int,
2022-10-11 21:53:55 +08:00
marker: Optional[str] = None,
2022-07-04 15:12:04 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
if frame is None:
if (frame := inspect.currentframe()) is not None:
frame = frame if frame.f_back is None else frame.f_back if frame.f_back.f_back is None else frame.f_back.f_back
2022-11-11 09:33:34 +08:00
message = Message_content(log_time=time.time(),
text=sep.join(i if type(i) is str else str(i) for i in values),
level=level, marker=marker, end=end, flush=flush, frame=frame)
2022-11-27 13:45:59 +08:00
# 调用 steams
for stream in self.streams:
stream.write(message)
2022-11-01 23:22:39 +08:00
message_color = self.colors[get_name_by_level(
level)]['message'] if 'message' in self.colors[get_name_by_level(level)] else self.colors['message']
2022-10-29 19:13:00 +08:00
text = f"{message_color}{sep.join(i if type(i) is str else str(i) for i in values)}{color_reset_suffix}"
2022-10-11 21:53:55 +08:00
# print('abc', 'abc', marker='123')
print_text = self.format_text(level=level, text=text, frame=frame)
if level >= self.level:
print(print_text, end=end)
2022-09-04 17:20:36 +08:00
for file in self.file_cache:
file: LogFileCache
if level < file.level:
continue
2022-11-01 23:22:39 +08:00
file.write_logs(
f"{re.sub(re_find_color_code, '', print_text)}{end}", flush=flush)
2022-10-02 22:24:38 +08:00
return print_text
def format_text(self, level: int, text: str, frame: Optional[FrameType]) -> str:
2022-11-01 18:34:02 +08:00
level_with_color = f"[{get_key_from_dict(self.colors[get_name_by_level(level)], 'info')}{get_name_by_level(level)}{color_reset_suffix}]"
level_with_color = f"{level_with_color}{' ' * (9 - len_without_color_maker(level_with_color))}"
formats = self.formats.copy()
2022-09-04 13:02:58 +08:00
if frame is not None:
2022-11-01 18:34:02 +08:00
formats['file_name'] = f"{get_key_from_dict(self.colors[get_name_by_level(level)], 'file_name', self.colors['file_name'])}{os.path.split(frame.f_code.co_filename)[-1]}{color_reset_suffix}"
formats['code_line'] = f"{get_key_from_dict(self.colors[get_name_by_level(level)], 'code_line', self.colors['code_line'])}{frame.f_lineno}{color_reset_suffix}"
formats['logger_name'] = f'{get_key_from_dict(self.colors[get_name_by_level(level)], "logger", self.colors["logger"])}{self.name}{color_reset_suffix}'
now_time = str(time.time())
for key, value in formats.items():
if isinstance(value, dict):
if 'strftime' in value:
value['strftime']: str
2022-11-26 21:48:55 +08:00
formats[key] = f"{get_key_from_dict(self.colors[get_name_by_level(level)], key, self.colors[key])}{time.strftime(value['strftime'].replace('%%S', now_time[now_time.find('.') + 1:now_time.find('.') + 5]))}{color_reset_suffix}"
print_text = self.formats['MESSAGE']['format'].format(level_with_color=level_with_color,
level=level_with_color, message=text,
**formats)
return print_text
2022-06-27 14:42:26 +08:00
2022-08-03 20:22:36 +08:00
def trace(self, *values: object,
2022-10-11 21:53:55 +08:00
marker: Optional[str] = None,
2022-08-03 20:22:36 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
2022-10-11 21:53:55 +08:00
return self.make_log(*values, level=LoggingLevel.TRACE, marker=marker, sep=sep, end=end, flush=flush, frame=frame)
2022-08-03 20:22:36 +08:00
def fine(self, *values: object,
2022-10-11 21:53:55 +08:00
marker: Optional[str] = None,
2022-08-03 20:22:36 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
2022-10-11 21:53:55 +08:00
return self.make_log(*values, level=LoggingLevel.FINE, marker=marker, sep=sep, end=end, flush=flush, frame=frame)
2022-07-04 15:12:04 +08:00
2022-10-11 21:53:55 +08:00
def debug(self, *values: object,
marker: Optional[str] = None,
2022-07-04 15:12:04 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
2022-10-11 21:53:55 +08:00
return self.make_log(*values, level=LoggingLevel.DEBUG, marker=marker, sep=sep, end=end, flush=flush, frame=frame)
2022-06-27 14:42:26 +08:00
2022-10-11 21:53:55 +08:00
def info(self, *values: object,
marker: Optional[str] = None,
2022-07-04 15:12:04 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
2022-10-11 21:53:55 +08:00
return self.make_log(*values, level=LoggingLevel.INFO, marker=marker, sep=sep, end=end, flush=flush, frame=frame)
2022-06-27 14:42:26 +08:00
2022-10-11 21:53:55 +08:00
def warning(self, *values: object,
marker: Optional[str] = None,
2022-07-04 15:12:04 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
2022-10-11 21:53:55 +08:00
return self.make_log(*values, level=LoggingLevel.WARNING, marker=marker, sep=sep, end=end, flush=flush, frame=frame)
2022-07-04 15:12:04 +08:00
2022-10-11 21:53:55 +08:00
def error(self, *values: object,
marker: Optional[str] = None,
2022-07-04 15:12:04 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
2022-10-11 21:53:55 +08:00
return self.make_log(*values, level=LoggingLevel.ERROR, marker=marker, sep=sep, end=end, flush=flush, frame=frame)
2022-07-04 15:12:04 +08:00
2022-10-11 21:53:55 +08:00
def fatal(self, *values: object,
marker: Optional[str] = None,
2022-07-04 15:12:04 +08:00
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
2022-10-02 22:24:38 +08:00
frame: Optional[FrameType] = None) -> Optional[str]:
2022-10-11 21:53:55 +08:00
return self.make_log(*values, level=LoggingLevel.FATAL, marker=marker, sep=sep, end=end, flush=flush, frame=frame)
2022-06-27 14:42:26 +08:00
2022-06-29 13:45:25 +08:00
2022-10-29 19:13:00 +08:00
_logger_class = Logger
2022-10-15 17:38:35 +08:00
class RootLogger(Logger):
""" 默认的 logger """
2022-10-29 19:13:00 +08:00
2022-10-15 17:38:35 +08:00
def __init__(self, level: int = LoggingLevel.WARNING, *args, **kwargs):
super().__init__(level=level, *args, **kwargs)
root_logger = RootLogger()
2022-10-29 19:13:00 +08:00
def basic_config() -> None:
...
2022-10-15 17:38:35 +08:00
def trace(*values: object,
marker: Optional[str] = None,
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
frame: Optional[FrameType] = None) -> Optional[str]:
...
def fine(*values: object,
marker: Optional[str] = None,
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
frame: Optional[FrameType] = None) -> Optional[str]:
...
def debug(*values: object,
marker: Optional[str] = None,
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
frame: Optional[FrameType] = None) -> Optional[str]:
...
def info(*values: object,
marker: Optional[str] = None,
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
frame: Optional[FrameType] = None) -> Optional[str]:
...
def warning(*values: object,
marker: Optional[str] = None,
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
frame: Optional[FrameType] = None) -> Optional[str]:
...
def error(*values: object,
marker: Optional[str] = None,
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
frame: Optional[FrameType] = None) -> Optional[str]:
...
def fatal(*values: object,
marker: Optional[str] = None,
sep: Optional[str] = ' ',
end: Optional[str] = '\n',
flush: Optional[bool] = False,
frame: Optional[FrameType] = None) -> Optional[str]:
...
def get_key_from_dict(a_dict: Dict, key: Any, default: Any = None) -> Optional[Any]:
2022-09-04 13:53:09 +08:00
if default is None:
return a_dict[key]
try:
return a_dict[key]
except KeyError:
return default
def format_str(text: str) -> str:
formats = logger_configs['Formatter'].copy()
now_time = str(time.time())
for key, value in formats.items():
if isinstance(value, dict):
if 'strftime' in value:
value['strftime']: str
2022-11-26 21:48:55 +08:00
formats[key] = time.strftime(value['strftime'].replace(
2022-11-01 23:22:39 +08:00
'%%S', now_time[now_time.find('.') + 1:now_time.find('.') + 5]))
return text.format(**formats)
def len_without_color_maker(text: str) -> int:
with_out_text = re.sub(re_find_color_code, '', text)
return len(with_out_text)
2022-09-04 13:02:58 +08:00
def gen_file_conf(file_name: str,
file_level: int = DEBUG,
file_mode: str = 'a',
file_encoding: str = 'utf-8',
file_cache_len: int = 10,
file_cache_time: Union[int, float] = 1) -> dict:
"""
生成一个文件配置
2022-10-02 22:24:38 +08:00
:param file_name: 日志文件名
:param file_level: 日志文件记录级别
:param file_mode: 文件模式
:param file_encoding: 文件编码
:param file_cache_len: 文件缓存长度
:param file_cache_time: 文件缓存时间
:return: 生成的配置
"""
2022-10-15 17:38:35 +08:00
return {'file_name': file_name,
'level': file_level,
'mode': file_mode,
'encoding': file_encoding,
'cache_len': file_cache_len,
2022-09-04 13:02:58 +08:00
'cache_time': file_cache_time}
2022-11-01 18:34:02 +08:00
def gen_color_conf(color_name: Optional[str] = None, **colors) -> dict:
2022-11-01 23:22:39 +08:00
default_color = logger_configs['Color']['main_color' if color_name is None else color_name].copy(
)
2022-09-04 13:02:58 +08:00
default_color.update(colors)
return default_color
def logger_with_default_settings(name: str,
level: int = DEBUG,
2022-11-01 18:34:02 +08:00
file_conf: Optional[dict] = None,
colors: Optional[dict] = None,
formats: Optional[dict] = None) -> Logger:
2022-09-04 13:02:58 +08:00
return Logger(name=name,
level=level,
2022-09-04 17:20:36 +08:00
file_conf=[LogFileCache(gen_file_conf(**file_conf))],
2022-09-04 13:02:58 +08:00
colors=gen_color_conf(**colors),
formats=logger_configs['Formatter'].copy().update(formats))
2022-07-07 18:28:29 +08:00
def add_file_config(conf_name: str,
file_name: str,
file_level: int = DEBUG,
file_mode: str = 'a',
file_encoding: str = 'utf-8',
file_cache_len: int = 10,
file_cache_time: Union[int, float] = 1) -> None:
"""
logger config 里添加一个文件配置
2022-10-02 22:24:38 +08:00
:param conf_name: 文件配置名称
:param file_name: 日志文件名
:param file_level: 日志文件记录级别
:param file_mode: 文件模式
:param file_encoding: 文件编码
:param file_cache_len: 文件缓存长度
:param file_cache_time: 文件缓存时间
:return: None
"""
2022-10-15 17:38:35 +08:00
logger_configs['File'][conf_name] = {'file_name': file_name,
'level': file_level,
'mode': file_mode,
'encoding': file_encoding,
'cache_len': file_cache_len,
'cache_time': file_cache_time}
def get_logger(name: str = 'root') -> Logger:
2022-07-16 20:20:23 +08:00
"""
此函数用于从 global_config 中取出对应的配置建立一个相应的 logger
2022-10-02 22:24:38 +08:00
:param name: logger的名称 默认为 root
:return: 创建好的 logger
2022-07-16 20:20:23 +08:00
"""
if name in logger_configs['Logger']:
the_config = logger_configs['Logger'][name]
else:
the_config = logger_configs['Logger']['root']
2022-09-04 17:20:36 +08:00
file_handler = None
if 'file' in the_config:
2022-11-01 23:22:39 +08:00
file_handler = [LogFileCache(
logger_configs['File'][the_config['file']])]
2022-10-29 19:13:00 +08:00
color = the_config['color'] if 'color' in the_config else 'main_color'
2022-09-04 13:02:58 +08:00
return Logger(name=name,
level=the_config['level'],
2022-09-04 17:20:36 +08:00
file_conf=file_handler,
2022-10-29 19:13:00 +08:00
colors=logger_configs['Color'][color],
2022-09-04 13:53:09 +08:00
formats=logger_configs['Formatter'].copy())
2022-09-04 13:02:58 +08:00
def test_logger(the_logger: Logger):
the_logger.trace('tracing')
2022-11-27 13:45:59 +08:00
the_logger.trace('tracing')
the_logger.trace('tracing')
the_logger.fine('some fine!')
2022-09-04 13:02:58 +08:00
the_logger.fine('some fine!')
2022-11-27 13:45:59 +08:00
the_logger.fine('some fine!')
the_logger.debug('debugging')
the_logger.debug('debugging')
2022-09-04 13:02:58 +08:00
the_logger.debug('debugging')
the_logger.info("Hello World!!")
2022-11-27 13:45:59 +08:00
the_logger.info("Hello World!!")
the_logger.info("Hello World!!")
the_logger.info("Hello World!!")
the_logger.info("Hello World!!")
2022-09-04 13:02:58 +08:00
the_logger.warn('warning')
2022-11-27 13:45:59 +08:00
the_logger.warn('warning')
the_logger.error('error haaaa')
2022-09-04 13:02:58 +08:00
the_logger.error('error haaaa')
the_logger.fatal('oh no')
2022-07-16 20:20:23 +08:00
if __name__ == "__main__":
os.chdir('../../')
2022-09-04 13:53:09 +08:00
logger = get_logger('server')
2022-09-04 13:02:58 +08:00
logger.info('my name is:', logger.name)
a_logger = get_logger('client')
2022-09-04 13:53:09 +08:00
a_logger.trace('tracing')
a_logger.fine('some fine!')
a_logger.debug('debugging')
a_logger.info("Hello World!!")
a_logger.warn('warning')
a_logger.error('error haaaa')
a_logger.fatal('oh no')
2022-09-04 13:02:58 +08:00
logger.info('my name is:', logger.name)
for x in range(5):
2022-09-04 13:02:58 +08:00
test_logger(logger)
test_logger(a_logger)
2022-11-11 09:33:34 +08:00
import rtoml
parse_config = rtoml.dumps(logger_configs, pretty=True)
import pprint
2022-11-01 18:34:02 +08:00
2022-11-11 09:33:34 +08:00
sys.stdout.write(rtoml.dumps(logger_configs, pretty=True))
print('-----------------')
sys.stdout.write(rtoml.dumps(logger_configs, pretty=False))
print('-----------------')
pprint.pprint(rtoml.loads(parse_config))
2022-11-27 13:45:59 +08:00
print(Message_content(log_time=time.time(), text='aaa', level=4, marker='abc', end='abc', flush=False, frame=inspect.currentframe()))