py.lib.aw_log

Yohn Y. 2024-10-30 Parent:41b53fd5637e Child:9155a66edb31

5:1e93862d5063 Go to Latest

py.lib.aw_log/src/aw_log/file.py

.. 1.202410.1 . Изменение структуры проекта под новые вызовы SDK Python . Убраны версии с отдельный файлов, они кажутся избыточними. * Изменено формирование записей о исключении, для большего соответствия логике журналирования - Перенос `NullLog` на уровень модуля и повышение его универсальности для замены других классов.

Download raw file
View source Diff to previous Annotate
History
1 # coding: utf-8
2 # devel.a0fs.ru -- aw_log.file -- v0.r202402.1
3
4 from typing import Any
5 from time import monotonic, ctime
6 from datetime import date
7 from typing import TextIO, Optional
8 from threading import RLock
9 from os.path import join as p_join, abspath, split as p_split
10
11 from . import AbstractLogBase
12
13 TIME_TO_FLUSH: int = 120 # Время по умолчанию с момента прошлого сброса лога,
14 # после которого, выполняется принудительный сброс буферов
15
16
17 class NullLog(AbstractLogBase):
18 def _write(self, mark: str, msg: Any):
19 pass
20
21
22 class AbstractFileLog(AbstractLogBase):
23 def __init__(self, prefix: str = 'main'):
24 super().__init__(prefix)
25 self.fd: Optional[TextIO] = None
26 self.lock = RLock()
27
28 def _write(self, mark: str, msg: Any):
29 if self.fd is None:
30 raise ValueError(f'Не определён файл логирования')
31
32 self.lock.acquire()
33 try:
34
35 tm = ctime()
36 for l in super()._write_helper(mark, msg):
37 self.fd.write(f'{tm} | {l}')
38
39 finally:
40 self.lock.release()
41
42
43 class FileLog(AbstractFileLog):
44 @staticmethod
45 def _open_file(file_name: str):
46 return open(file_name, 'a', encoding='utf-8')
47
48 def __init__(self, prefix: str = 'main',
49 file_name: Optional[str] = None,
50 file_obj: Optional[TextIO] = None,
51 time_to_flush: int = TIME_TO_FLUSH
52 ):
53
54 super().__init__(prefix=prefix)
55 self.fd: Optional[TextIO] = None
56
57 self.flush_time = monotonic()
58 self.time_to_flush = time_to_flush # Время с момента прошлого сброса лога,
59 # после которого, выполняется принудительный сброс буферов
60
61 if file_name is not None:
62 self.fd = self._open_file(file_name)
63
64 else:
65 self.fd = file_obj
66
67 if self.fd is None:
68 raise ValueError('Не задан файл для записи журналов')
69
70 def flush(self, time_mark: float = None):
71 if time_mark is None:
72 time_mark = monotonic()
73
74 self.flush_time = time_mark
75 self.fd.flush()
76
77 def close(self):
78 self.fd.flush()
79 self.fd.close()
80 self.fd = None
81
82 def __del__(self):
83 if self.fd is not None:
84 self.fd.flush()
85 self.fd.close()
86 self.fd = None
87
88 def _flush_event(self):
89 t = monotonic()
90 if t - self.flush_time >= self.time_to_flush:
91 self.flush(t)
92
93 def _write(self, mark: str, msg: Any):
94 super()._write(mark=mark, msg=msg)
95
96 self._flush_event()
97
98 def sub_log(self, name: str):
99 if self.fd is None:
100 raise ValueError('Попытка использовать закрытый файл журнала')
101
102 return self.__class__(f'{self.prefix}/{name}', file_obj=self.fd, time_to_flush=self.time_to_flush)
103
104
105 class LogrotateFile(FileLog):
106 def __init__(self,
107 file_base: str,
108 prefix: str = 'main',
109 file_obj: Optional[TextIO] = None,
110 time_to_flush: int = TIME_TO_FLUSH):
111
112 d = date.today()
113 if file_obj is None:
114 super().__init__(prefix=prefix, file_name=f'{file_base}-{d}.log', time_to_flush=time_to_flush)
115 else:
116 super().__init__(prefix=prefix, file_obj=file_obj, time_to_flush=time_to_flush)
117
118 self.logrotate_base = file_base
119 self.logrotate_date = d
120
121 @classmethod
122 def make(cls, directory: str = '.', prefix: str = 'main', time_to_flush: int = TIME_TO_FLUSH):
123 if len(p_split(prefix)) > 1:
124 raise ValueError(f'Префикс журналирования не должен быть похож '
125 f'на пусть файловой системы, убери знак разделения директорий: {prefix}')
126
127 directory = abspath(directory)
128 file_base = p_join(directory, prefix)
129 return cls(prefix=prefix, file_base=file_base, time_to_flush=time_to_flush)
130
131 def flush(self, time_mark: float = None, no_rotate: bool = False):
132 if not no_rotate:
133 d = date.today()
134 if self.logrotate_date != d:
135 self.logrotate_rotate()
136 return
137
138 super().flush(time_mark=time_mark)
139
140 def logrotate_rotate(self):
141 d = date.today()
142 file_name = f'{self.logrotate_base}-{d}.log'
143 self.fd.flush()
144 self.fd = self._open_file(file_name)
145 self.logrotate_date = d
146 self.flush(no_rotate=True)
147
148 def sub_log(self, name: str):
149 return self.__class__(
150 file_base=self.logrotate_base,
151 file_obj=self.fd, prefix=f'{self.prefix}/{name}',
152 time_to_flush=self.time_to_flush
153 )