py.lib

Yohn Y. 2023-01-28 Parent:log/slog_console.py@fe4a96d06243 Child:bfc3a109c06c

43:6f8bea109183 Go to Latest

py.lib/log/log_confile.py

. Наведение порядка в коде логирования

Download raw file
View source Diff to previous Annotate
History
1 # coding: utf-8
2 """ Логирование на консоль
3
4 Метки в журнале о уровне сообщения:
5 "`": Debug
6 ".": Info
7 "*": Warning
8 "!": Error
9 "#": Alert
10
11 """
12
13 from time import monotonic, ctime
14 from datetime import timedelta, date
15 from traceback import extract_tb, extract_stack
16 from sys import exc_info, stderr, stdout
17 from typing import Optional, TextIO, Any
18 from os.path import join as p_join, abspath
19 from threading import RLock
20
21
22 TIME_TO_FLUSH: int = 120 # Время по умолчанию с момента прошлого сброса лога,
23 # после которого, выполняется принудительный сброс буферов
24
25
26 class Timing(object):
27 def __init__(self, name: Optional[str] = None):
28 if name is None:
29 self.prefix = ''
30
31 else:
32 self.prefix = f'{name} :: '
33
34 self.tsAll = monotonic()
35 self.ts = self.tsAll
36
37 def get_time(self):
38 return monotonic() - self.ts
39
40 def reset(self):
41 self.ts = monotonic()
42 self.tsAll = self.ts
43
44 def __str__(self):
45 ts = monotonic()
46 return self.prefix + '%s(%.4f)' % (timedelta(seconds=(ts - self.tsAll)), ts - self.ts)
47
48 def __call__(self, msg):
49 _buf = f'{self} | {msg}'
50 self.ts = monotonic()
51 return _buf
52
53
54 class NullLog(object):
55 def __init__(self, prefix: str = 'main'):
56 self.prefix = prefix
57
58 @staticmethod
59 def _write(mark: str, msg: Any):
60 pass # cat > /dev/null
61
62 def __call__(self, msg):
63 self._write('.', msg)
64
65 def err(self, msg):
66 self._write('!', msg)
67
68 def warn(self, msg):
69 self._write('*', msg)
70
71 def alert(self, msg):
72 self._write('#', msg)
73
74 def debug(self, msg):
75 self._write('`', msg)
76
77 @staticmethod
78 def get_timing(name: Optional[str] = None):
79 return Timing(name)
80
81 def sub_log(self, name: str):
82 return self.__class__(f'{self.prefix}/{name}')
83
84 def excpt(self, msg, e_class=None, e_obj=None, e_tb=None, stack_skip=0):
85 if e_class is None:
86 e_class, e_obj, e_tb = exc_info()
87
88 tb_data_tb = list(extract_tb(e_tb))[::-1]
89 tb_data_stack = list(extract_stack())[::-1][(2 + stack_skip):]
90 self.err(msg)
91 self.err('--- EXCEPTION ---')
92 self.err(f' {e_class.__name__} ({e_obj})')
93 self.err('--- TRACEBACK ---')
94 for _tb_file, _tb_line, _tb_func, _tb_text in tb_data_tb:
95 self.err(f'File: {_tb_file}, line {_tb_line} in {_tb_func}')
96 self.err(f' {_tb_text}')
97
98 self.err('>>> Exception Handler <<<')
99 for _tb_file, _tb_line, _tb_func, _tb_text in tb_data_stack:
100 self.err(f'File: {_tb_file}, line {_tb_line} in {_tb_func}')
101 self.err(f' {_tb_text}')
102
103 self.err('--- END EXCEPTION ---')
104
105
106 class FileLog(NullLog):
107 @staticmethod
108 def _open_file(file_name: str):
109 return open(file_name, 'a', encoding='utf-8')
110
111 def __init__(self, prefix: str = 'main',
112 file_name: Optional[str] = None,
113 file_obj: Optional[TextIO] = None,
114 time_to_flush: int = TIME_TO_FLUSH
115 ):
116
117 super().__init__(prefix=prefix)
118 self.fd: Optional[TextIO] = None
119
120 self.flush_time = monotonic()
121 self.time_to_flush = time_to_flush # Время с момента прошлого сброса лога,
122 # после которого, выполняется принудительный сброс буферов
123
124 if file_name is not None:
125 self.fd = self._open_file(file_name)
126
127 else:
128 self.fd = file_obj
129
130 if self.fd is None:
131 raise ValueError(f'Не задан файл для записи журналов')
132
133 def flush(self, time_mark: float = None):
134 if time_mark is None:
135 time_mark = monotonic()
136
137 self.flush_time = time_mark
138 self.fd.flush()
139
140 def close(self):
141 self.fd.flush()
142 self.fd.close()
143 self.fd = None
144
145 def __del__(self):
146 if self.fd is not None:
147 self.fd.flush()
148 self.fd.close()
149 self.fd = None
150
151 def flush_event(self):
152 t = monotonic()
153 if t - self.flush_time >= self.time_to_flush:
154 self.flush(t)
155
156 def _write(self, mark: str, msg: Any):
157 if self.fd is None:
158 raise ValueError('Попытка использовать закрытый файл журнала')
159
160 t = ctime()
161 for l in str(msg).splitlines():
162 self.fd.write(f'{t} | {mark} {self.prefix} | {l}')
163
164 self.flush_event()
165
166 def sub_log(self, name: str):
167 if self.fd is None:
168 raise ValueError('Попытка использовать закрытый файл журнала')
169
170 return self.__class__(f'{self.prefix}/{name}', file_obj=self.fd, time_to_flush=self.time_to_flush)
171
172
173 class StderrLog(FileLog):
174 def __init__(self, prefix: str = 'main'):
175 super().__init__(prefix, file_obj=stderr)
176
177 def flush_event(self):
178 pass # нет необходимости сбрасывать буферы в консоли
179
180
181 class StdoutLog(FileLog):
182 def __init__(self, prefix: str = 'main'):
183 super().__init__(prefix, file_obj=stdout)
184
185 def flush_event(self):
186 pass # нет необходимости сбрасывать буферы в консоли
187
188
189 class LogrotateFile(FileLog):
190 def __init__(self, directory: str = '.', prefix: str = 'main', time_to_flush: int = TIME_TO_FLUSH):
191 d = date.today()
192 directory = abspath(directory)
193 file_name = p_join(directory, f'{prefix}-{d}.log')
194
195 super().__init__(prefix, file_name=file_name, time_to_flush=time_to_flush)
196 self.logrotate_base = p_join(directory, f'{prefix}')
197 self.logrotate_date = d
198
199 def flush(self, time_mark: float = None, no_rotate: bool = False):
200 if not no_rotate:
201 d = date.today()
202 if self.logrotate_date != d:
203 self.logrotate_rotate()
204 return
205
206 super().flush(time_mark=time_mark)
207
208 def logrotate_rotate(self):
209 d = date.today()
210 file_name = f'{self.logrotate_base}-{d}.log'
211 self.fd.flush()
212 self.fd = self._open_file(file_name)
213 self.logrotate_date = d
214 self.flush(no_rotate=True)
215
216
217 class ThreadSafeFileLog(FileLog):
218 def __int__(self, *a, **kwa):
219 super().__init__(*a, **kwa)
220 self.thread_safe_lock = RLock()
221
222 def _write(self, mark: str, msg: Any):
223 with self.thread_safe_lock:
224 super()._write(mark, msg)
225
226 def flush(self, time_mark: float = None):
227 with self.thread_safe_lock:
228 super().flush(time_mark)
229
230
231 class ThreadSafeLogrotateFile(LogrotateFile):
232 def __init__(self, directory: str = '.', prefix: str = 'main', time_to_flush: int = TIME_TO_FLUSH):
233 super().__init__(directory=directory, prefix=prefix, time_to_flush=time_to_flush)
234 self.thread_safe_lock = RLock()
235
236 def _write(self, mark: str, msg: Any):
237 with self.thread_safe_lock:
238 super()._write(mark, msg)
239
240 def flush(self, time_mark: float = None, no_rotate: bool = False):
241 with self.thread_safe_lock:
242 super().flush(time_mark=time_mark, no_rotate=no_rotate)
243
244 def logrotate_rotate(self):
245 with self.thread_safe_lock:
246 super().logrotate_rotate()