/
rab_logging.py
266 lines (247 loc) · 6.86 KB
/
rab_logging.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
#!/usr/bin/env python
# -*- coding:UTF-8 -*-
#
# @AUTHOR: Rabbir
# @FILE: /root/GitHub/rab_python_packages/rab_logging.py
# @DATE: 2020/12/16 Wed
# @TIME: 16:50:21
#
# @DESCRIPTION: 共通包 日志记录模块
import os
import sys
import logging
from datetime import datetime
from singleton_decorator import singleton
sys.path.append("..") if (".." not in sys.path) else True
from rab_python_packages import rab_config
"""
@description: logger 初始化配置
-------
@param:
-------
@return:
"""
def build_logger():
# 默认打印和记录日志等级为：info
logging.basicConfig(filemode="a",
format="%(asctime)s %(name)s:%(levelname)s:%(message)s",
datefmt="%Y/%m/%d %H:%M:%S",
level=logging.INFO)
logger = logging.getLogger("RAB_LOGGER")
# 在 rab_python_packages 同级目录下创建 rab_logs 日志存放用文件夹
path = rab_config.find_rab_python_packages_path()
# 判断是否存在现有的 rab_logs 日志存放用文件夹
if (path):
rab_logs_path = path + "rab_logs"
else:
rab_logs_path = "rab_logs"
if (not os.path.exists(rab_logs_path)):
os.makedirs(rab_logs_path)
# 以天为单位存储日志
fh = logging.FileHandler(
(rab_logs_path+"/{:%Y%m%d}.log").format(datetime.now()))
# 日志存储格式
formatter = logging.Formatter("%(asctime)s | %(levelname)-8s | %(message)s")
fh.setFormatter(formatter)
logger.addHandler(fh)
return logger
"""
@description: 获取 logging 的等级对象
-------
@param:
-------
@return:
"""
def get_logging_level(level):
if (level.lower() == "debug"):
return logging.DEBUG
elif(level.lower() == "info"):
return logging.INFO
elif(level.lower() == "warn"):
return logging.WARN
elif(level.lower() == "error"):
return logging.ERROR
elif(level.lower() == "critical"):
return logging.CRITICAL
"""
@description: log 等级比较
-------
@param:
-------
@return:
"""
def get_weight(level):
if (level):
level_weight = {
"debug": 1,
"info": 2,
"warn": 3,
"error": 4,
"critical": 5
}
return level_weight[level]
else:
return 0
"""
@description: 用以定位实际调用日志记录方法位置的装饰器
-------
@param:
-------
@return:
"""
def findcaller(func):
def wrapper(*args):
# 获取调用该函数的文件名、函数名及行号
filename = sys._getframe(1).f_code.co_filename
funcname = sys._getframe(1).f_code.co_name
lineno = sys._getframe(1).f_lineno
# 将原本的入参转变为列表，再把调用者的信息添加到入参列表中
args = list(args)
args.append(
f" {os.path.basename(filename)} | {funcname} | 行：{lineno} | ")
func(*args)
return wrapper
"""
@description: r_logger 类
-------
@param:
-------
@return:
"""
# 单例模式
@singleton
class r_logger():
"""
@description: 初始化
-------
@param:
-------
@return:
"""
def __init__(self,
level="info",
logger=build_logger(),
telegarm_notice_level=rab_config.load_package_config(
"rab_config.ini", "rab_logging", "level").lower(),
qq_notice_level=None):
# logger 对象
self.logger = logger
# 修改 logger 对象的日志记录等级
self.logger.setLevel(get_logging_level(level))
# Telegram 机器人通知等级（大于等于这个等级的都进行通知，None 为不通知）
self.telegarm_notice_level = telegarm_notice_level
# QQ 机器人通知等级
self.qq_notice_level = qq_notice_level
"""
@description: 机器人通知
-------
@param:
-------
@return:
"""
def send_log(self, log_level, log):
# 加上日志等级
log = "| {log_level} | {log}".format(
log_level=log_level.upper().ljust(8, " "), log=log)
# Telegram 机器人通知
if (get_weight(log_level) >= get_weight(self.telegarm_notice_level)):
pass
# QQ 机器人通知
if (get_weight(log_level) >= get_weight(self.qq_notice_level)):
pass
"""
@description: debug 日志等级方法重写
-------
@param:
-------
@return:
"""
@findcaller
def debug(self, log, caller=None):
log = caller + log
self.send_log("debug", log)
self.logger.debug(log)
"""
@description: info 日志等级方法重写
-------
@param:
-------
@return:
"""
@findcaller
def info(self, log, caller=None):
log = caller + log
self.send_log("info", log)
self.logger.info(log)
"""
@description: warn 日志等级方法重写
-------
@param:
-------
@return:
"""
@findcaller
def warn(self, log, caller=None):
log = caller + log
self.send_log("warn", log)
self.logger.warning(log)
"""
@description: error 日志等级方法重写
-------
@param:
-------
@return:
"""
@findcaller
def error(self, log, caller=None):
# 单纯的消息直接记录
if (type(log) == str):
pass
# 如果是错误类
else:
error = log
# 获取错误行号
error_no = str(error.__traceback__.tb_lineno)
# 获取出错的文件
error_file = str(error.__traceback__.tb_frame.f_globals["__file__"])
# 错误信息
error_msg = str(error).strip()
# 具体日志
log = "出错！文件 {error_file} 第 {error_no} 行，报错：{error_msg}" \
.format(error_file=error_file, error_no=error_no, \
error_msg=error_msg)
log = caller + log
self.send_log("error", log)
self.logger.error(log)
"""
@description: critical 日志等级方法重写
-------
@param:
-------
@return:
"""
@findcaller
def critical(self, log, caller=None):
log = caller + log
self.send_log("critical", log)
self.logger.critical(log)
"""
@description: 单体测试
-------
@param:
-------
@return:
"""
if __name__ == "__main__":
r_logger = r_logger("warn")
r_logger.debug("debug")
r_logger.info("info")
r_logger.warn("warn")
r_logger.error("error")
try:
a = 123
b = 456
import aaa
except Exception as e:
r_logger.error(e)
r_logger.critical("critical")