zlogger-mp 0.1.0__tar.gz
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.
- zlogger_mp-0.1.0/LICENSE +21 -0
- zlogger_mp-0.1.0/PKG-INFO +59 -0
- zlogger_mp-0.1.0/README.md +40 -0
- zlogger_mp-0.1.0/pyproject.toml +27 -0
- zlogger_mp-0.1.0/setup.cfg +4 -0
- zlogger_mp-0.1.0/zlogger.py +150 -0
- zlogger_mp-0.1.0/zlogger_mp.egg-info/PKG-INFO +59 -0
- zlogger_mp-0.1.0/zlogger_mp.egg-info/SOURCES.txt +8 -0
- zlogger_mp-0.1.0/zlogger_mp.egg-info/dependency_links.txt +1 -0
- zlogger_mp-0.1.0/zlogger_mp.egg-info/top_level.txt +1 -0
zlogger_mp-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Zhiyuan
|
|
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,59 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: zlogger-mp
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: 多进程安全的时间轮转日志封装:多进程共享同一日志文件时轮转不丢历史日志
|
|
5
|
+
Author: wzy-777
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/wzy-777/zlogger
|
|
8
|
+
Keywords: logging,rotating,multiprocess,TimedRotatingFileHandler
|
|
9
|
+
Classifier: Development Status :: 4 - Beta
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Topic :: System :: Logging
|
|
15
|
+
Requires-Python: >=3.8
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Dynamic: license-file
|
|
19
|
+
|
|
20
|
+
# zlogger
|
|
21
|
+
|
|
22
|
+
多进程安全的时间轮转日志记录器,基于标准库 `logging` 封装。
|
|
23
|
+
|
|
24
|
+
## 特点
|
|
25
|
+
|
|
26
|
+
- `SafeTimedRotatingFileHandler`:原子 rename 轮转,多个进程共享同一日志文件时不丢历史日志,已有备份绝不删除/覆盖
|
|
27
|
+
- 控制台 + 文件双输出,文件按天(午夜)轮转,默认保留 7 天
|
|
28
|
+
- 开箱即用,无需配置
|
|
29
|
+
|
|
30
|
+
## 安装
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pip install zlogger-mp
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## 使用
|
|
37
|
+
|
|
38
|
+
```python
|
|
39
|
+
from zlogger import Logger
|
|
40
|
+
|
|
41
|
+
log = Logger(name="test", log_file="test.log", log_dir="log").get_logger()
|
|
42
|
+
log.debug("调试信息(仅控制台输出)")
|
|
43
|
+
log.info("普通信息(控制台 + 文件)")
|
|
44
|
+
log.warning("警告信息(控制台 + 文件)")
|
|
45
|
+
log.error("错误信息(控制台 + 文件)")
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
单例方式(全局共享一个 logger):
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
from zlogger import LoggerSingleton
|
|
52
|
+
|
|
53
|
+
log = LoggerSingleton.get_logger(name="myapp", log_file="myapp.log")
|
|
54
|
+
log.info("hello")
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# zlogger
|
|
2
|
+
|
|
3
|
+
多进程安全的时间轮转日志记录器,基于标准库 `logging` 封装。
|
|
4
|
+
|
|
5
|
+
## 特点
|
|
6
|
+
|
|
7
|
+
- `SafeTimedRotatingFileHandler`:原子 rename 轮转,多个进程共享同一日志文件时不丢历史日志,已有备份绝不删除/覆盖
|
|
8
|
+
- 控制台 + 文件双输出,文件按天(午夜)轮转,默认保留 7 天
|
|
9
|
+
- 开箱即用,无需配置
|
|
10
|
+
|
|
11
|
+
## 安装
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pip install zlogger-mp
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## 使用
|
|
18
|
+
|
|
19
|
+
```python
|
|
20
|
+
from zlogger import Logger
|
|
21
|
+
|
|
22
|
+
log = Logger(name="test", log_file="test.log", log_dir="log").get_logger()
|
|
23
|
+
log.debug("调试信息(仅控制台输出)")
|
|
24
|
+
log.info("普通信息(控制台 + 文件)")
|
|
25
|
+
log.warning("警告信息(控制台 + 文件)")
|
|
26
|
+
log.error("错误信息(控制台 + 文件)")
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
单例方式(全局共享一个 logger):
|
|
30
|
+
|
|
31
|
+
```python
|
|
32
|
+
from zlogger import LoggerSingleton
|
|
33
|
+
|
|
34
|
+
log = LoggerSingleton.get_logger(name="myapp", log_file="myapp.log")
|
|
35
|
+
log.info("hello")
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
MIT
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=61"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "zlogger-mp"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "多进程安全的时间轮转日志封装:多进程共享同一日志文件时轮转不丢历史日志"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.8"
|
|
11
|
+
license = { text = "MIT" }
|
|
12
|
+
authors = [{ name = "wzy-777" }]
|
|
13
|
+
keywords = ["logging", "rotating", "multiprocess", "TimedRotatingFileHandler"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Development Status :: 4 - Beta",
|
|
16
|
+
"Intended Audience :: Developers",
|
|
17
|
+
"License :: OSI Approved :: MIT License",
|
|
18
|
+
"Operating System :: OS Independent",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Topic :: System :: Logging",
|
|
21
|
+
]
|
|
22
|
+
|
|
23
|
+
[project.urls]
|
|
24
|
+
Homepage = "https://github.com/wzy-777/zlogger"
|
|
25
|
+
|
|
26
|
+
[tool.setuptools]
|
|
27
|
+
py-modules = ["zlogger"]
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import logging
|
|
2
|
+
from logging.handlers import TimedRotatingFileHandler
|
|
3
|
+
import os
|
|
4
|
+
import time
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
class SafeTimedRotatingFileHandler(TimedRotatingFileHandler):
|
|
8
|
+
"""
|
|
9
|
+
多进程安全的时间轮转文件处理器:
|
|
10
|
+
原子 rename 轮转 + 已有备份绝不删除/覆盖,多个进程共享同一日志文件时不丢历史日志
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
def doRollover(self):
|
|
14
|
+
"""
|
|
15
|
+
重写doRollover方法,处理Windows文件权限问题
|
|
16
|
+
"""
|
|
17
|
+
if self.stream:
|
|
18
|
+
self.stream.close()
|
|
19
|
+
self.stream = None
|
|
20
|
+
|
|
21
|
+
# 获取当前时间
|
|
22
|
+
currentTime = int(time.time())
|
|
23
|
+
dstNow = time.localtime(currentTime)[-1]
|
|
24
|
+
t = self.rolloverAt - self.interval
|
|
25
|
+
if self.utc:
|
|
26
|
+
timeTuple = time.gmtime(t)
|
|
27
|
+
else:
|
|
28
|
+
timeTuple = time.localtime(t)
|
|
29
|
+
dstThen = timeTuple[-1]
|
|
30
|
+
if dstNow != dstThen:
|
|
31
|
+
if dstNow:
|
|
32
|
+
addend = 3600
|
|
33
|
+
else:
|
|
34
|
+
addend = -3600
|
|
35
|
+
timeTuple = time.localtime(t + addend)
|
|
36
|
+
|
|
37
|
+
dfn = self.rotation_filename(self.baseFilename + "." + time.strftime(self.suffix, timeTuple))
|
|
38
|
+
|
|
39
|
+
# 原子 rename 备份,不用 copy+truncate:
|
|
40
|
+
# 多进程/多 handler 共享同一日志文件时,由第一个轮转的进程完成备份;
|
|
41
|
+
# 备份已存在说明其他进程已轮转过,直接跳过 —— 任何情况下都不删除、不覆盖已有备份
|
|
42
|
+
if os.path.exists(dfn):
|
|
43
|
+
pass
|
|
44
|
+
elif os.path.exists(self.baseFilename):
|
|
45
|
+
try:
|
|
46
|
+
os.rename(self.baseFilename, dfn)
|
|
47
|
+
except FileNotFoundError:
|
|
48
|
+
# base 刚被其他进程轮转走,无需再处理
|
|
49
|
+
pass
|
|
50
|
+
except OSError as e:
|
|
51
|
+
# 轮转失败仅告警,不影响后续写日志
|
|
52
|
+
print(f"日志轮转失败: {e}")
|
|
53
|
+
|
|
54
|
+
# 删除旧的备份文件
|
|
55
|
+
if self.backupCount > 0:
|
|
56
|
+
for s in self.getFilesToDelete():
|
|
57
|
+
try:
|
|
58
|
+
os.remove(s)
|
|
59
|
+
except Exception:
|
|
60
|
+
pass
|
|
61
|
+
|
|
62
|
+
# 重新计算下次轮转时间
|
|
63
|
+
if not self.delay:
|
|
64
|
+
self.stream = self._open()
|
|
65
|
+
|
|
66
|
+
newRolloverAt = self.computeRollover(currentTime)
|
|
67
|
+
while newRolloverAt <= currentTime:
|
|
68
|
+
newRolloverAt = newRolloverAt + self.interval
|
|
69
|
+
|
|
70
|
+
if (self.when == 'MIDNIGHT' or self.when.startswith('W')) and not self.utc:
|
|
71
|
+
dstAtRollover = time.localtime(newRolloverAt)[-1]
|
|
72
|
+
if dstNow != dstAtRollover:
|
|
73
|
+
if not dstNow:
|
|
74
|
+
addend = -3600
|
|
75
|
+
else:
|
|
76
|
+
addend = 3600
|
|
77
|
+
newRolloverAt += addend
|
|
78
|
+
self.rolloverAt = newRolloverAt
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
class Logger:
|
|
82
|
+
def __init__(self, name: str, log_file: str = "app.log", log_dir: str = "log"):
|
|
83
|
+
"""
|
|
84
|
+
创建一个日志记录器
|
|
85
|
+
:param name: 记录器名称
|
|
86
|
+
:param log_file: 日志文件名
|
|
87
|
+
:param log_dir: 日志文件保存目录
|
|
88
|
+
"""
|
|
89
|
+
self.logger = logging.getLogger(name)
|
|
90
|
+
self.logger.setLevel(logging.DEBUG)
|
|
91
|
+
self.logger.propagate = False
|
|
92
|
+
# 确保日志目录存在
|
|
93
|
+
if not os.path.exists(log_dir):
|
|
94
|
+
os.makedirs(log_dir)
|
|
95
|
+
|
|
96
|
+
log_path = os.path.join(log_dir, log_file)
|
|
97
|
+
|
|
98
|
+
# 日志格式
|
|
99
|
+
formatter = logging.Formatter(
|
|
100
|
+
fmt="%(asctime)s [%(name)s] [%(filename)s:%(lineno)d] [%(levelname)s] %(message)s",
|
|
101
|
+
datefmt="%Y-%m-%d %H:%M:%S"
|
|
102
|
+
)
|
|
103
|
+
|
|
104
|
+
# 控制台 Handler
|
|
105
|
+
console_handler = logging.StreamHandler()
|
|
106
|
+
console_handler.setLevel(logging.DEBUG)
|
|
107
|
+
console_handler.setFormatter(formatter)
|
|
108
|
+
|
|
109
|
+
# 文件 Handler(使用改进的TimedRotatingFileHandler)
|
|
110
|
+
file_handler = SafeTimedRotatingFileHandler(
|
|
111
|
+
filename=log_path,
|
|
112
|
+
when="midnight",
|
|
113
|
+
interval=1,
|
|
114
|
+
backupCount=7,
|
|
115
|
+
encoding="utf-8",
|
|
116
|
+
delay=True
|
|
117
|
+
)
|
|
118
|
+
file_handler.setLevel(logging.INFO)
|
|
119
|
+
file_handler.setFormatter(formatter)
|
|
120
|
+
|
|
121
|
+
# 先清空已存在的handlers
|
|
122
|
+
if self.logger.hasHandlers():
|
|
123
|
+
self.logger.handlers.clear()
|
|
124
|
+
|
|
125
|
+
# 绑定 Handler
|
|
126
|
+
self.logger.addHandler(console_handler)
|
|
127
|
+
self.logger.addHandler(file_handler)
|
|
128
|
+
|
|
129
|
+
def get_logger(self) -> logging.Logger:
|
|
130
|
+
"""返回 logger 对象"""
|
|
131
|
+
return self.logger
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
class LoggerSingleton:
|
|
135
|
+
_logger = None
|
|
136
|
+
|
|
137
|
+
@classmethod
|
|
138
|
+
def get_logger(cls, name="websocket", log_file="websocket.log", log_dir="log"):
|
|
139
|
+
if cls._logger is None:
|
|
140
|
+
cls._logger = Logger(name, log_file, log_dir).get_logger()
|
|
141
|
+
return cls._logger
|
|
142
|
+
|
|
143
|
+
# 使用示例
|
|
144
|
+
if __name__ == "__main__":
|
|
145
|
+
log = Logger(name="test", log_file="test.log", log_dir="log").get_logger()
|
|
146
|
+
log.debug("调试信息(仅控制台输出)")
|
|
147
|
+
log.info("普通信息(控制台 + 文件)")
|
|
148
|
+
log.warning("警告信息(控制台 + 文件)")
|
|
149
|
+
log.error("错误信息(控制台 + 文件)")
|
|
150
|
+
log.critical("严重错误(控制台 + 文件)")
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: zlogger-mp
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: 多进程安全的时间轮转日志封装:多进程共享同一日志文件时轮转不丢历史日志
|
|
5
|
+
Author: wzy-777
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/wzy-777/zlogger
|
|
8
|
+
Keywords: logging,rotating,multiprocess,TimedRotatingFileHandler
|
|
9
|
+
Classifier: Development Status :: 4 - Beta
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Topic :: System :: Logging
|
|
15
|
+
Requires-Python: >=3.8
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
Dynamic: license-file
|
|
19
|
+
|
|
20
|
+
# zlogger
|
|
21
|
+
|
|
22
|
+
多进程安全的时间轮转日志记录器,基于标准库 `logging` 封装。
|
|
23
|
+
|
|
24
|
+
## 特点
|
|
25
|
+
|
|
26
|
+
- `SafeTimedRotatingFileHandler`:原子 rename 轮转,多个进程共享同一日志文件时不丢历史日志,已有备份绝不删除/覆盖
|
|
27
|
+
- 控制台 + 文件双输出,文件按天(午夜)轮转,默认保留 7 天
|
|
28
|
+
- 开箱即用,无需配置
|
|
29
|
+
|
|
30
|
+
## 安装
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pip install zlogger-mp
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## 使用
|
|
37
|
+
|
|
38
|
+
```python
|
|
39
|
+
from zlogger import Logger
|
|
40
|
+
|
|
41
|
+
log = Logger(name="test", log_file="test.log", log_dir="log").get_logger()
|
|
42
|
+
log.debug("调试信息(仅控制台输出)")
|
|
43
|
+
log.info("普通信息(控制台 + 文件)")
|
|
44
|
+
log.warning("警告信息(控制台 + 文件)")
|
|
45
|
+
log.error("错误信息(控制台 + 文件)")
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
单例方式(全局共享一个 logger):
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
from zlogger import LoggerSingleton
|
|
52
|
+
|
|
53
|
+
log = LoggerSingleton.get_logger(name="myapp", log_file="myapp.log")
|
|
54
|
+
log.info("hello")
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
zlogger
|