586 lines
21 KiB
Python
586 lines
21 KiB
Python
"""
|
|
@author shenjackyuanjie
|
|
@contact 3695888@qq.com
|
|
"""
|
|
# -------------------------------
|
|
# Difficult Rocket
|
|
# Copyright © 2021-2022 by shenjackyuanjie 3695888@qq.com
|
|
# All rights reserved
|
|
# -------------------------------
|
|
import re
|
|
import os
|
|
import time
|
|
import atexit
|
|
import inspect
|
|
import threading
|
|
|
|
from objprint import op
|
|
from time import strftime
|
|
from logging import NOTSET, DEBUG, INFO, WARNING, ERROR, FATAL
|
|
from types import FrameType
|
|
from typing import Optional, Union, Dict, Iterable, Tuple, Any, List
|
|
|
|
os.system('')
|
|
# print(os.path.abspath(os.curdir))
|
|
|
|
# 如果想要直接使用 logger 来 logging
|
|
# 直接调用 logger.debug() 即可
|
|
# 默认配置会有
|
|
# ----------
|
|
# 配置方式一
|
|
# 直接使用 logger.Logger()
|
|
# 将会创建一个空 logger
|
|
# 可以自行通过
|
|
# 配置方式二
|
|
|
|
|
|
color_reset_suffix = "\033[0m"
|
|
""" 只是用来重置颜色的后缀 """
|
|
|
|
re_find_color_code = r'\033\[[^\f\n\r\t\vm]*m'
|
|
re_color_code = re.compile(re_find_color_code)
|
|
|
|
"""
|
|
OFF > FATAL > ERROR > WARN > INFO > FINE > FINER > DEBUG > TRACE > ALL
|
|
logging.py
|
|
CRITICAL = 50
|
|
FATAL = CRITICAL
|
|
ERROR = 40
|
|
WARNING = 30
|
|
WARN = WARNING
|
|
INFO = 20
|
|
DEBUG = 10
|
|
NOTSET = 0
|
|
"""
|
|
ALL = NOTSET
|
|
TRACE = 5
|
|
FINE = 7
|
|
|
|
level_name_map = {
|
|
ALL: 'ALL', # NOTSET
|
|
TRACE: 'TRACE',
|
|
FINE: 'FINE',
|
|
DEBUG: 'DEBUG',
|
|
INFO: 'INFO',
|
|
WARNING: 'WARNING', # WARN
|
|
ERROR: 'ERROR',
|
|
FATAL: 'FATAL'
|
|
}
|
|
|
|
name_level_map = {
|
|
'NOTSET': ALL,
|
|
'ALL': ALL,
|
|
'TRACE': TRACE,
|
|
'FINE': FINE,
|
|
'DEBUG': DEBUG,
|
|
'INFO': INFO,
|
|
'WARNING': WARNING,
|
|
'WARN': WARNING,
|
|
'ERROR': ERROR,
|
|
'CRITICAL': FATAL,
|
|
'FATAL': FATAL
|
|
}
|
|
|
|
logger_configs = {
|
|
'Logger': {
|
|
'root': {
|
|
'level': TRACE,
|
|
'color': 'main_color',
|
|
'file': 'main_log_file',
|
|
},
|
|
'client': {
|
|
'level': TRACE,
|
|
'color': 'main_color',
|
|
# 'file': 'main_log_file',
|
|
},
|
|
'server': {
|
|
'level': TRACE,
|
|
'color': 'DiGua_color',
|
|
'file': 'main_log_file',
|
|
},
|
|
},
|
|
'Color': {
|
|
'main_color': {
|
|
'file_time': '\033[38;2;201;222;56m',
|
|
'main_time': '\033[38;2;201;222;56m',
|
|
'file_name': '\033[38;2;0;255;180m',
|
|
'code_line': '\033[38;2;0;255;180m',
|
|
'logger': '\033[0m',
|
|
TRACE: {'info': '\033[38;2;138;173;244m', 'message': '\033[38;2;138;173;244m'},
|
|
FINE: {'info': '\033[35;48;2;44;44;54m', 'message': '\033[35m'},
|
|
DEBUG: {'info': '\033[38;2;133;138;149m', 'message': '\033[38;2;133;138;149m'},
|
|
INFO: {'info': '\033[0m', 'message': '\033[0m'},
|
|
WARNING: {'info': '\033[33m', 'message': '\033[33m'},
|
|
ERROR: {'info': '\033[31m', 'message': '\033[31m'},
|
|
FATAL: {'info': '\033[38;2;255;255;0;48;2;120;10;10m', 'message': '\033[38;2;255;255;0;48;2;120;10;10m'}
|
|
},
|
|
'DiGua_color': {
|
|
# catppuccin Macchiato
|
|
'file_time': '\033[38;2;238;212;159m',
|
|
'main_time': '\033[38;2;202;211;245m',
|
|
'file_name': '\033[38;2;139;213;202m',
|
|
'code_line': '\033[38;2;166;218;149m',
|
|
'logger': '\033[0m',
|
|
TRACE: {'info': '\033[38;2;138;173;244m', 'message': '\033[38;2;138;173;244m'},
|
|
FINE: {'info': '\033[38;2;198;160;246m', 'message': '\033[38;2;198;160;246m'},
|
|
DEBUG: {'info': '\033[38;2;133;138;149m', 'message': '\033[38;2;133;138;149m'},
|
|
INFO: {'info': '\033[0m', 'message': '\033[0m'},
|
|
WARNING: {'info': '\033[38;2;245;169;127m', 'message': '\033[38;2;245;169;127m'},
|
|
ERROR: {'info': '\033[38;2;237;135;150m', 'message': '\033[38;2;237;135;150m'},
|
|
FATAL: {'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'}
|
|
}
|
|
},
|
|
'File': {
|
|
'main_log_file': {
|
|
'mode': 'a',
|
|
'encoding': 'utf-8',
|
|
'level': TRACE,
|
|
'file_name': './logs/{file_time}_logs.md',
|
|
'cache_len': 10,
|
|
'cache_time': 1
|
|
},
|
|
},
|
|
'Formatter': {
|
|
'MESSAGE': {
|
|
'format': '[{main_time}] [{logger_name}] {level} | {file_name}:{code_line} | {message}'
|
|
},
|
|
'file_name': 'no frame',
|
|
'code_line': 'no frame',
|
|
'file_time': {'strftime': '%Y-%m-%d %H-%M'},
|
|
'main_time': {'strftime': '%Y-%m-%d %H-%M-%S:%%S'}, # %%S 三位毫秒
|
|
...: ...
|
|
}
|
|
}
|
|
|
|
|
|
class ThreadLock:
|
|
"""一个用来 with 的线程锁"""
|
|
|
|
def __init__(self, the_lock: threading.Lock, time_out: Union[float, int] = 1 / 60) -> None:
|
|
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()
|
|
|
|
|
|
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):
|
|
self._cache.append(value)
|
|
elif isinstance(value, Iterable):
|
|
self._cache.append(*value)
|
|
else:
|
|
raise TypeError(f"cache must be string or Iterable. not a {type(value)}")
|
|
|
|
def __getitem__(self, item) -> str:
|
|
assert isinstance(item, int)
|
|
with self.with_thread_lock:
|
|
try:
|
|
return self._cache[item]
|
|
except IndexError as exp:
|
|
print(f'cache:{self.cache}')
|
|
raise IndexError(f'there is no cache at {item}!\ncache:{self.cache}\n{exp}')
|
|
|
|
def __call__(self, *args, **kwargs) -> List[str]:
|
|
return self.cache
|
|
|
|
def __iter__(self):
|
|
self._iter_len = len(self.cache)
|
|
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
|
|
return returns
|
|
|
|
def __bool__(self):
|
|
with self.with_thread_lock:
|
|
return True if len(self.cache) > 0 else False
|
|
|
|
@property
|
|
def cache(self):
|
|
return self._cache
|
|
|
|
def clear(self):
|
|
with self.with_thread_lock:
|
|
self.cache.clear()
|
|
|
|
|
|
class LogFileCache:
|
|
"""日志文件缓存"""
|
|
|
|
def __init__(self, file_conf: dict):
|
|
"""
|
|
|
|
@param file_conf: 日志文件配置
|
|
"""
|
|
# 配置相关
|
|
self._logfile_name = os.path.abspath(format_str(file_conf['file_name'])) # log 文件名称
|
|
self.level = get_key_from_dict(file_conf, 'level', DEBUG)
|
|
self.file_conf = file_conf
|
|
self.flush_time = file_conf['cache_time'] # 缓存刷新时长
|
|
self.cache_entries_num = file_conf['cache_len']
|
|
self.started = True
|
|
self.running = False
|
|
# 同步锁
|
|
self.cache_lock = threading.Lock() # 主锁
|
|
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 的多线程
|
|
# 日志缓存表
|
|
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}'
|
|
|
|
def end_thread(self) -> None:
|
|
"""结束日志写入进程，顺手把目前的缓存写入"""
|
|
self.cache_lock.acquire(blocking=True)
|
|
if self.running:
|
|
self.threaded_write.cancel()
|
|
self.running = False
|
|
self.started = False
|
|
self._log_file_time_write()
|
|
atexit.unregister(self.end_thread)
|
|
|
|
def start_thread(self) -> None:
|
|
self.threaded_write.start()
|
|
self.started = True
|
|
self.running = True
|
|
atexit.register(self.end_thread)
|
|
|
|
@property
|
|
def logfile_name(self) -> str:
|
|
self._logfile_name: str
|
|
return self._logfile_name
|
|
|
|
@logfile_name.setter
|
|
def logfile_name(self, value: str) -> None:
|
|
with self.time_limit_lock:
|
|
self._logfile_name = value
|
|
|
|
def _log_file_time_write(self, thread: bool = False) -> None:
|
|
"""使用 threading.Timer 调用的定时写入日志文件的函数"""
|
|
if self.log_cache:
|
|
with self.time_limit_lock:
|
|
if self.log_cache:
|
|
with open(file=self.logfile_name,
|
|
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()
|
|
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()
|
|
if self.started and not self.running:
|
|
self.threaded_write = threading.Timer(1, self._log_file_time_write, kwargs={'thread': True}) # 基于 timer 的多线程
|
|
self.threaded_write.start()
|
|
self.running = True
|
|
|
|
|
|
class Logger:
|
|
"""shenjack logger"""
|
|
|
|
def __init__(self,
|
|
name: str = 'root',
|
|
level: int = DEBUG,
|
|
file_conf: List[LogFileCache] = None,
|
|
colors: Dict[Union[int, str], Dict[str, str]] = None,
|
|
formats=None) -> None:
|
|
"""
|
|
配置模式: 使用 kwargs 配置
|
|
@param name: logger 名称 默认为 root
|
|
@param level: logging 输出等级 默认为 DEBUG(10)
|
|
@param file_conf: logger 的文件处理配置
|
|
@param colors: dict 颜色配置
|
|
@param formats: 格式化配置
|
|
"""
|
|
self.name = name
|
|
self.level = level
|
|
self.colors = colors or logger_configs['Color']['main_color']
|
|
self.formats = formats or logger_configs['Formatter'].copy()
|
|
self.min_level = self.level
|
|
if file_conf:
|
|
self.file_cache = file_conf
|
|
self.min_level = min(*[file.level for file in file_conf], self.level)
|
|
else:
|
|
self.file_cache = []
|
|
self.warn = self.warning
|
|
|
|
def add_file(self, handler: LogFileCache):
|
|
self.file_cache.append(handler)
|
|
self.min_level = min(*[file.level for file in self.file_cache], self.level)
|
|
|
|
def remove_file(self, handler: LogFileCache):
|
|
self.file_cache.pop(self.file_cache.index(handler))
|
|
self.min_level = min(*[file.level for file in self.file_cache], self.level)
|
|
|
|
def make_log(self, *values: object,
|
|
level: int,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
if level < self.min_level:
|
|
return None
|
|
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
|
|
# text = sep.join(i if type(i) is str else str(i) for i in values)
|
|
text = f"{self.colors[level]['message']}{sep.join(i if type(i) is str else str(i) for i in values)}{color_reset_suffix}"
|
|
print_text = self.format_text(level=level, text=text, frame=frame)
|
|
if level >= self.level:
|
|
print(print_text, end=end)
|
|
for file in self.file_cache:
|
|
file: LogFileCache
|
|
if level < file.level:
|
|
continue
|
|
file.write_logs(f"{re.sub(re_find_color_code, '', print_text)}{end}", flush=flush)
|
|
return None
|
|
|
|
def format_text(self, level: int, text: str, frame: Optional[FrameType]) -> str:
|
|
level_with_color = f"[{get_key_from_dict(self.colors[level], 'info')}{level_name_map[level]}{color_reset_suffix}]"
|
|
level_with_color = f"{level_with_color}{' ' * (9 - len_without_color_maker(level_with_color))}"
|
|
formats = self.formats.copy()
|
|
if frame is not None:
|
|
formats['file_name'] = f"{get_key_from_dict(self.colors[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[level], 'code_line', self.colors['code_line'])}{frame.f_lineno}{color_reset_suffix}"
|
|
formats['logger_name'] = f'{get_key_from_dict(self.colors[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
|
|
formats[key] = f"{get_key_from_dict(self.colors[level], key, self.colors[key])}{strftime(value['strftime'].replace('%%S', now_time[now_time.find('.') + 1:now_time.find('.') + 4]))}{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
|
|
|
|
def trace(self, *values: object,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
return self.make_log(*values, level=TRACE, sep=sep, end=end, flush=flush, frame=frame)
|
|
|
|
def fine(self, *values: object,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
return self.make_log(*values, level=FINE, sep=sep, end=end, flush=flush, frame=frame)
|
|
|
|
def debug(self,
|
|
*values: object,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
return self.make_log(*values, level=DEBUG, sep=sep, end=end, flush=flush, frame=frame)
|
|
|
|
def info(self,
|
|
*values: object,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
return self.make_log(*values, level=INFO, sep=sep, end=end, flush=flush, frame=frame)
|
|
|
|
def warning(self,
|
|
*values: object,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
return self.make_log(*values, level=WARNING, sep=sep, end=end, flush=flush, frame=frame)
|
|
|
|
def error(self,
|
|
*values: object,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
return self.make_log(*values, level=ERROR, sep=sep, end=end, flush=flush, frame=frame)
|
|
|
|
def fatal(self,
|
|
*values: object,
|
|
sep: Optional[str] = ' ',
|
|
end: Optional[str] = '\n',
|
|
flush: Optional[bool] = False,
|
|
frame: Optional[FrameType] = None) -> None:
|
|
return self.make_log(*values, level=FATAL, sep=sep, end=end, flush=flush, frame=frame)
|
|
|
|
|
|
def get_key_from_dict(a_dict: Dict, key: Any, default: Any = None) -> Optional[Any]:
|
|
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
|
|
formats[key] = strftime(value['strftime'].replace('%%S', now_time[now_time.find('.') + 1:now_time.find('.') + 4]))
|
|
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)
|
|
|
|
|
|
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:
|
|
"""
|
|
生成一个文件配置
|
|
@param file_name: 日志文件名
|
|
@param file_level: 日志文件记录级别
|
|
@param file_mode: 文件模式
|
|
@param file_encoding: 文件编码
|
|
@param file_cache_len: 文件缓存长度
|
|
@param file_cache_time: 文件缓存时间
|
|
@return: 生成的配置
|
|
"""
|
|
return {'file_name': file_name,
|
|
'level': file_level,
|
|
'mode': file_mode,
|
|
'encoding': file_encoding,
|
|
'cache_len': file_cache_len,
|
|
'cache_time': file_cache_time}
|
|
|
|
|
|
def gen_color_conf(color_name: str = None, **colors) -> dict:
|
|
default_color = logger_configs['Color']['main_color' if color_name is None else color_name].copy()
|
|
default_color.update(colors)
|
|
return default_color
|
|
|
|
|
|
def logger_with_default_settings(name: str,
|
|
level: int = DEBUG,
|
|
file_conf: dict = None,
|
|
colors: dict = None,
|
|
formats: dict = None) -> Logger:
|
|
return Logger(name=name,
|
|
level=level,
|
|
file_conf=[LogFileCache(gen_file_conf(**file_conf))],
|
|
colors=gen_color_conf(**colors),
|
|
formats=logger_configs['Formatter'].copy().update(formats))
|
|
|
|
|
|
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 里添加一个文件配置
|
|
@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
|
|
"""
|
|
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:
|
|
"""
|
|
此函数用于从 global_config 中取出对应的配置建立一个相应的 logger
|
|
@param name: logger的名称 默认为 root
|
|
@return: 创建好的 logger
|
|
"""
|
|
if name in logger_configs['Logger']:
|
|
the_config = logger_configs['Logger'][name]
|
|
else:
|
|
the_config = logger_configs['Logger']['root']
|
|
file_handler = None
|
|
if 'file' in the_config:
|
|
file_handler = [LogFileCache(logger_configs['File'][the_config['file']])]
|
|
return Logger(name=name,
|
|
level=the_config['level'],
|
|
file_conf=file_handler,
|
|
colors=logger_configs['Color'][get_key_from_dict(the_config, 'color', 'main_color')],
|
|
formats=logger_configs['Formatter'].copy())
|
|
|
|
|
|
def test_logger(the_logger: Logger):
|
|
the_logger.trace('tracing')
|
|
the_logger.fine('some fine!')
|
|
the_logger.debug('debugging')
|
|
the_logger.info("Hello World!!")
|
|
the_logger.warn('warning')
|
|
the_logger.error('error haaaa')
|
|
the_logger.fatal('oh no')
|
|
|
|
|
|
if __name__ == "__main__":
|
|
os.chdir('../../')
|
|
logger = get_logger('server')
|
|
|
|
logger.info('my name is:', logger.name)
|
|
a_logger = get_logger('client')
|
|
|
|
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')
|
|
logger.info('my name is:', logger.name)
|
|
for x in range(5):
|
|
test_logger(logger)
|
|
test_logger(a_logger)
|