EOF-413-LLS 1.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
LLS/__init__.py
ADDED
LLS/logger.py
ADDED
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Модуль для настройки и использования многоуровневого логирования.
|
|
3
|
+
Логи разделяются по категориям (critical, errors, warnings, info, debug)
|
|
4
|
+
и сохраняются в отдельные файлы, а также в общий лог-файл.
|
|
5
|
+
Автоматически удаляются старые файлы, остаются последние `keep` штук.
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from os import (
|
|
9
|
+
path,
|
|
10
|
+
remove,
|
|
11
|
+
listdir,
|
|
12
|
+
getcwd,
|
|
13
|
+
makedirs
|
|
14
|
+
)
|
|
15
|
+
|
|
16
|
+
from logging import (
|
|
17
|
+
Filter,
|
|
18
|
+
LogRecord,
|
|
19
|
+
Formatter,
|
|
20
|
+
getLogger,
|
|
21
|
+
DEBUG,
|
|
22
|
+
INFO,
|
|
23
|
+
WARNING,
|
|
24
|
+
ERROR,
|
|
25
|
+
CRITICAL
|
|
26
|
+
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
from logging.handlers import RotatingFileHandler
|
|
30
|
+
|
|
31
|
+
from datetime import datetime
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class LevelFilter(Filter):
|
|
35
|
+
"""
|
|
36
|
+
Фильтр, пропускающий записи только с указанными уровнями логирования.
|
|
37
|
+
"""
|
|
38
|
+
|
|
39
|
+
def __init__(self, levels):
|
|
40
|
+
self.levels = levels
|
|
41
|
+
super().__init__()
|
|
42
|
+
|
|
43
|
+
def filter(self, record):
|
|
44
|
+
return record.levelno in self.levels
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
class LoggerSystem():
|
|
48
|
+
"""
|
|
49
|
+
Синглтон-класс для управления логгером в заданной папке.
|
|
50
|
+
Для каждой папки (folder) создаётся отдельный экземпляр.
|
|
51
|
+
"""
|
|
52
|
+
|
|
53
|
+
_inst = {}
|
|
54
|
+
_global_st = datetime.now()
|
|
55
|
+
|
|
56
|
+
def __new__(cls, folder, max_folders=5):
|
|
57
|
+
if folder not in cls._inst:
|
|
58
|
+
instance = super().__new__(cls)
|
|
59
|
+
instance._initialized = False
|
|
60
|
+
cls._inst[folder] = instance
|
|
61
|
+
return cls._inst[folder]
|
|
62
|
+
|
|
63
|
+
def __init__(self, folder="default", max_folders=5):
|
|
64
|
+
"""
|
|
65
|
+
Инициализация экземпляра. Выполняется только один раз для каждой папки.
|
|
66
|
+
:param folder: имя папки для хранения логов (подпапка в logs/)
|
|
67
|
+
:param max_folders: количество последних файлов, которые сохраняются в каждой категории
|
|
68
|
+
"""
|
|
69
|
+
if self._initialized:
|
|
70
|
+
return
|
|
71
|
+
|
|
72
|
+
self.folder = folder
|
|
73
|
+
self.max_folders = max_folders
|
|
74
|
+
|
|
75
|
+
self.logger = None
|
|
76
|
+
self._all_file = None
|
|
77
|
+
self.start_time = LoggerSystem._global_st
|
|
78
|
+
|
|
79
|
+
def _clear(self, dir):
|
|
80
|
+
"""
|
|
81
|
+
Удаляет старые .log-файлы в директории, оставляя только последние self.keep штук.
|
|
82
|
+
Сортировка по имени файла (предполагается, что имена содержат временную метку).
|
|
83
|
+
"""
|
|
84
|
+
|
|
85
|
+
if not path.exists(dir):
|
|
86
|
+
return
|
|
87
|
+
|
|
88
|
+
files = [f for f in listdir(dir) if f.endswith('.log')]
|
|
89
|
+
|
|
90
|
+
if len(files) <= self.max_folders:
|
|
91
|
+
return
|
|
92
|
+
|
|
93
|
+
files.sort()
|
|
94
|
+
for old in files[:-self.max_folders]:
|
|
95
|
+
try:
|
|
96
|
+
remove(path.join(dir, old))
|
|
97
|
+
except OSError:
|
|
98
|
+
pass
|
|
99
|
+
|
|
100
|
+
@staticmethod
|
|
101
|
+
def _format(level, msg):
|
|
102
|
+
"""
|
|
103
|
+
Форматирует запись для ручной записи в лог-файл (используется при инициализации).
|
|
104
|
+
"""
|
|
105
|
+
|
|
106
|
+
formatter = Formatter(
|
|
107
|
+
'[%(asctime)s] [%(levelname)s] [%(filename)s] '
|
|
108
|
+
'[%(funcName)s] [%(lineno)d] -> %(message)s',
|
|
109
|
+
datefmt='%d.%m.%Y %H:%M:%S'
|
|
110
|
+
)
|
|
111
|
+
|
|
112
|
+
record = LogRecord(
|
|
113
|
+
name='logger.py',
|
|
114
|
+
level=level,
|
|
115
|
+
pathname='logger.py',
|
|
116
|
+
lineno=0,
|
|
117
|
+
msg=msg,
|
|
118
|
+
args=(),
|
|
119
|
+
exc_info=None,
|
|
120
|
+
func='<module>'
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
record.asctime = datetime.now().strftime('%d.%m.%Y %H:%M:%S')
|
|
124
|
+
return formatter.format(record)
|
|
125
|
+
|
|
126
|
+
def _write(self, log_file):
|
|
127
|
+
"""
|
|
128
|
+
Записывает в новый лог-файл сообщение об инициализации для данной папки.
|
|
129
|
+
"""
|
|
130
|
+
|
|
131
|
+
msg = (f"Логирование инициализировано для [{self.folder}]: {self.start_time.strftime('%H:%M:%S %d.%m.%Y')}.")
|
|
132
|
+
|
|
133
|
+
with open(log_file, 'a', encoding='utf-8') as f:
|
|
134
|
+
f.write(self._format(INFO, msg) + '\n')
|
|
135
|
+
|
|
136
|
+
def _path(self, category):
|
|
137
|
+
"""
|
|
138
|
+
Создаёт директорию для категории и возвращает путь к файлу лога.
|
|
139
|
+
Если файл не существует, записывает начальное сообщение.
|
|
140
|
+
После создания выполняет очистку старых файлов.
|
|
141
|
+
"""
|
|
142
|
+
|
|
143
|
+
logs_dir = path.join(getcwd(), "logs", self.folder)
|
|
144
|
+
|
|
145
|
+
category_dir = path.join(logs_dir, category)
|
|
146
|
+
|
|
147
|
+
makedirs(category_dir, exist_ok=True)
|
|
148
|
+
|
|
149
|
+
time_str = self.start_time.strftime("%H.%M.%S_%d.%m.%Y")
|
|
150
|
+
|
|
151
|
+
log_file = path.join(category_dir, f"{time_str}.log")
|
|
152
|
+
|
|
153
|
+
if not path.exists(log_file):
|
|
154
|
+
self._write(log_file)
|
|
155
|
+
|
|
156
|
+
self._clear(category_dir)
|
|
157
|
+
return log_file
|
|
158
|
+
|
|
159
|
+
def _all(self):
|
|
160
|
+
"""
|
|
161
|
+
Создаёт директорию 'all' и возвращает путь к глобальному лог-файлу.
|
|
162
|
+
При первом создании записывает сообщение о глобальной инициализации.
|
|
163
|
+
"""
|
|
164
|
+
|
|
165
|
+
all_dir = path.join(getcwd(), "logs", "all")
|
|
166
|
+
|
|
167
|
+
makedirs(all_dir, exist_ok=True)
|
|
168
|
+
|
|
169
|
+
time_str = self.start_time.strftime("%H.%M.%S_%d.%m.%Y")
|
|
170
|
+
|
|
171
|
+
log_file = path.join(all_dir, f"{time_str}.log")
|
|
172
|
+
|
|
173
|
+
self._all_file = log_file
|
|
174
|
+
|
|
175
|
+
if not path.exists(log_file):
|
|
176
|
+
msg = (f"Глобальное логирование инициализировано: {self.start_time.strftime('%H:%M:%S %d.%m.%Y')}.")
|
|
177
|
+
|
|
178
|
+
with open(log_file, 'a', encoding='utf-8') as f:
|
|
179
|
+
f.write(self._format(INFO, msg) + '\n')
|
|
180
|
+
|
|
181
|
+
self._clear(all_dir)
|
|
182
|
+
return log_file
|
|
183
|
+
|
|
184
|
+
def setup(self):
|
|
185
|
+
"""
|
|
186
|
+
Настраивает логгер: создаёт обработчики для каждой категории и глобальный обработчик.
|
|
187
|
+
Вызывается автоматически при первом обращении к логгеру.
|
|
188
|
+
"""
|
|
189
|
+
|
|
190
|
+
if self._initialized:
|
|
191
|
+
return self.logger
|
|
192
|
+
|
|
193
|
+
self.logger = getLogger(self.folder)
|
|
194
|
+
self.logger.setLevel(DEBUG)
|
|
195
|
+
self.logger.propagate = False
|
|
196
|
+
|
|
197
|
+
categories = {
|
|
198
|
+
"critical": LevelFilter([CRITICAL]),
|
|
199
|
+
"errors": LevelFilter([ERROR]),
|
|
200
|
+
"warnings": LevelFilter([WARNING]),
|
|
201
|
+
"info": LevelFilter([INFO]),
|
|
202
|
+
"debug": LevelFilter([DEBUG]),
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
formatter = Formatter(
|
|
206
|
+
'[%(asctime)s] [%(levelname)s] [%(filename)s] '
|
|
207
|
+
'[%(funcName)s] [%(lineno)d] -> %(message)s',
|
|
208
|
+
datefmt='%d.%m.%Y %H:%M:%S'
|
|
209
|
+
)
|
|
210
|
+
|
|
211
|
+
for category_name, level_filter in categories.items():
|
|
212
|
+
log_path = self._path(category_name)
|
|
213
|
+
handler = RotatingFileHandler(
|
|
214
|
+
log_path,
|
|
215
|
+
maxBytes=10 * 1024 * 1024,
|
|
216
|
+
backupCount=0,
|
|
217
|
+
encoding='utf-8'
|
|
218
|
+
)
|
|
219
|
+
handler.setLevel(DEBUG)
|
|
220
|
+
handler.addFilter(level_filter)
|
|
221
|
+
handler.setFormatter(formatter)
|
|
222
|
+
self.logger.addHandler(handler)
|
|
223
|
+
|
|
224
|
+
all_log_path = self._all()
|
|
225
|
+
all_handler = RotatingFileHandler(
|
|
226
|
+
all_log_path,
|
|
227
|
+
maxBytes=10 * 1024 * 1024,
|
|
228
|
+
backupCount=0,
|
|
229
|
+
encoding='utf-8'
|
|
230
|
+
)
|
|
231
|
+
all_handler.setLevel(DEBUG)
|
|
232
|
+
all_handler.setFormatter(formatter)
|
|
233
|
+
self.logger.addHandler(all_handler)
|
|
234
|
+
|
|
235
|
+
self._initialized = True
|
|
236
|
+
return self.logger
|
|
237
|
+
|
|
238
|
+
def __getattr__(self, name):
|
|
239
|
+
"""
|
|
240
|
+
Позволяет обращаться к методам логирования через сокращения:
|
|
241
|
+
d -> debug, i -> info, w -> warning, e -> error, c -> critical.
|
|
242
|
+
Также поддерживаются полные имена.
|
|
243
|
+
"""
|
|
244
|
+
if not self._initialized:
|
|
245
|
+
self.setup()
|
|
246
|
+
|
|
247
|
+
short_names = {
|
|
248
|
+
'd': 'debug',
|
|
249
|
+
'i': 'info',
|
|
250
|
+
'w': 'warning',
|
|
251
|
+
'e': 'error',
|
|
252
|
+
'c': 'critical'
|
|
253
|
+
}
|
|
254
|
+
if name in short_names:
|
|
255
|
+
return getattr(self.logger, short_names[name])
|
|
256
|
+
if name in ['debug', 'info', 'warning', 'error', 'critical']:
|
|
257
|
+
return getattr(self.logger, name)
|
|
258
|
+
raise AttributeError(f"'LoggerSystem' object has no attribute '{name}'")
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
_log = {}
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
def log_init(folder="default", max_folders=5):
|
|
265
|
+
"""
|
|
266
|
+
Фабричная функция для получения экземпляра LoggerSystem для заданной папки.
|
|
267
|
+
При первом вызове для папки автоматически выполняется настройка.
|
|
268
|
+
:param folder: имя папки для хранения логов
|
|
269
|
+
:param max_folders: количество последних файлов, которые сохраняются в каждой категории
|
|
270
|
+
"""
|
|
271
|
+
|
|
272
|
+
if folder not in _log:
|
|
273
|
+
_log[folder] = LoggerSystem(folder, max_folders)
|
|
274
|
+
_log[folder].setup()
|
|
275
|
+
return _log[folder]
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: EOF_413_LLS
|
|
3
|
+
Version: 1.1.0
|
|
4
|
+
Summary: Простой многоуровневый логгер с ротацией
|
|
5
|
+
Home-page: https://github.com/EOF-413/LibraryLogSystem
|
|
6
|
+
Author: EOF-413
|
|
7
|
+
Author-email: org.animea@mail.com
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Operating System :: OS Independent
|
|
10
|
+
Requires-Python: >=3.6
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Dynamic: author
|
|
14
|
+
Dynamic: author-email
|
|
15
|
+
Dynamic: classifier
|
|
16
|
+
Dynamic: description
|
|
17
|
+
Dynamic: description-content-type
|
|
18
|
+
Dynamic: home-page
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
Dynamic: requires-python
|
|
21
|
+
Dynamic: summary
|
|
22
|
+
|
|
23
|
+
# LibraryLogSystem (LLS)
|
|
24
|
+
|
|
25
|
+
**LLS** - это универсальная система логирования для Python приложений.
|
|
26
|
+
Позволяет разделять логи по категориям (debug, info, warning, error, critical) и создавать отдельные директории для разных модулей.
|
|
27
|
+
|
|
28
|
+
## Особенности
|
|
29
|
+
|
|
30
|
+
- Разделение логов по уровням: debug, info, warning, error, critical
|
|
31
|
+
- Автоматическое создание папок для каждого модуля
|
|
32
|
+
- Общая папка all/ со всеми логами без сортировки
|
|
33
|
+
- Автоматическая очистка старых логов (хранится 5 последних файлов)
|
|
34
|
+
- Singleton паттерн для каждого логгера
|
|
35
|
+
- Поддержка коротких имен методов: d(), i(), w(), e(), c()
|
|
36
|
+
|
|
37
|
+
## Установка
|
|
38
|
+
|
|
39
|
+
```python
|
|
40
|
+
from LLS import log_init
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Использование
|
|
44
|
+
|
|
45
|
+
### Базовое использование
|
|
46
|
+
|
|
47
|
+
```python
|
|
48
|
+
from LLS import log_init
|
|
49
|
+
|
|
50
|
+
# Создание логгера для конкретного модуля
|
|
51
|
+
log = log_init('main')
|
|
52
|
+
|
|
53
|
+
# Запись логов
|
|
54
|
+
log.debug("Отладочное сообщение")
|
|
55
|
+
log.info("Информационное сообщение")
|
|
56
|
+
log.warning("Предупреждение")
|
|
57
|
+
log.error("Ошибка")
|
|
58
|
+
log.critical("Критическая ошибка")
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Короткие имена методов
|
|
62
|
+
|
|
63
|
+
```python
|
|
64
|
+
from LLS import log_init
|
|
65
|
+
|
|
66
|
+
log = log_init('main')
|
|
67
|
+
|
|
68
|
+
log.d("debug") # debug
|
|
69
|
+
log.i("info") # info
|
|
70
|
+
log.w("warning") # warning
|
|
71
|
+
log.e("error") # error
|
|
72
|
+
log.c("critical") # critical
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Использование в разных модулях
|
|
76
|
+
|
|
77
|
+
```python
|
|
78
|
+
# http/client.py
|
|
79
|
+
from LLS import log_init
|
|
80
|
+
|
|
81
|
+
log = log_init('http')
|
|
82
|
+
|
|
83
|
+
log.info("HTTP запрос отправлен")
|
|
84
|
+
|
|
85
|
+
# github/repository.py
|
|
86
|
+
from LLS import log_init
|
|
87
|
+
|
|
88
|
+
log = log_init('GitHub')
|
|
89
|
+
|
|
90
|
+
log.info("Поиск репозиториев")
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Структура логов
|
|
94
|
+
|
|
95
|
+
```text
|
|
96
|
+
logs/
|
|
97
|
+
├── all/
|
|
98
|
+
│ └── 21.59.18_25.07.2026.log
|
|
99
|
+
├── main/
|
|
100
|
+
│ ├── debug/
|
|
101
|
+
│ ├── info/
|
|
102
|
+
│ ├── warnings/
|
|
103
|
+
│ ├── errors/
|
|
104
|
+
│ └── critical/
|
|
105
|
+
├── http/
|
|
106
|
+
│ ├── debug/
|
|
107
|
+
│ ├── info/
|
|
108
|
+
│ ├── warnings/
|
|
109
|
+
│ ├── errors/
|
|
110
|
+
│ └── critical/
|
|
111
|
+
└── GitHub/
|
|
112
|
+
├── debug/
|
|
113
|
+
├── info/
|
|
114
|
+
├── warnings/
|
|
115
|
+
├── errors/
|
|
116
|
+
└── critical/
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Формат логов
|
|
120
|
+
|
|
121
|
+
```log
|
|
122
|
+
[25.07.2026 21:59:18] [INFO] [main.py] [<module>] [5] -> Сообщение
|
|
123
|
+
[25.07.2026 21:59:18] [ERROR] [client.py] [get] [25] -> Ошибка запроса
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## API
|
|
127
|
+
|
|
128
|
+
### log_init(folder: str) -> LoggerSystem
|
|
129
|
+
|
|
130
|
+
Создает или возвращает экземпляр логгера для указанной папки.
|
|
131
|
+
|
|
132
|
+
Параметры:
|
|
133
|
+
- folder (str): Имя папки для хранения логов (например, "main", "http", "GitHub")
|
|
134
|
+
|
|
135
|
+
Возвращает:
|
|
136
|
+
- LoggerSystem: Экземпляр логгера
|
|
137
|
+
|
|
138
|
+
### Методы логгера
|
|
139
|
+
|
|
140
|
+
| Метод | Короткий | Описание |
|
|
141
|
+
|-------|----------|----------|
|
|
142
|
+
| debug(msg) | d(msg) | Запись отладочного сообщения |
|
|
143
|
+
| info(msg) | i(msg) | Запись информационного сообщения |
|
|
144
|
+
| warning(msg) | w(msg) | Запись предупреждения |
|
|
145
|
+
| error(msg) | e(msg) | Запись ошибки |
|
|
146
|
+
| critical(msg) | c(msg) | Запись критической ошибки |
|
|
147
|
+
|
|
148
|
+
## Очистка логов
|
|
149
|
+
|
|
150
|
+
Система автоматически хранит только 5 последних лог-файлов для каждой категории. Старые файлы удаляются автоматически.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
LLS/__init__.py,sha256=yLykTMVQnzPraZ67QJJryHe4JBppy9fmtqKyhWbXquE,64
|
|
2
|
+
LLS/logger.py,sha256=fOZRUvpmWUPBDOrWMfgjahnbxy9VNdm7Klt9oJYs5Zc,9702
|
|
3
|
+
eof_413_lls-1.1.0.dist-info/licenses/LICENSE,sha256=0qyiMtrdwoUCfQWtP6Kz6kH7ws2xU_yXRVlmtzdEqzw,1085
|
|
4
|
+
eof_413_lls-1.1.0.dist-info/METADATA,sha256=j6NHCWTdTHTMzDjdFkbuJedyRlMisHadkOvggCkAbr0,4633
|
|
5
|
+
eof_413_lls-1.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
|
|
6
|
+
eof_413_lls-1.1.0.dist-info/top_level.txt,sha256=8TWtPNTp3uBGf1jYSutUeeZyZQv8lYjq8kSQZt5jVdo,4
|
|
7
|
+
eof_413_lls-1.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 EOF-413
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
LLS
|