dlz-logger 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.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 daliangzai
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,100 @@
1
+ Metadata-Version: 2.4
2
+ Name: dlz-logger
3
+ Version: 0.1.0
4
+ Summary: A lightweight colorful logger with optional daily rotating file output.
5
+ Author: daliangzai
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://pypi.org/project/dlz-logger/
8
+ Keywords: logging,logger,color,console,pypi
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
19
+ Classifier: Topic :: System :: Logging
20
+ Requires-Python: >=3.9
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Dynamic: license-file
24
+
25
+ # dlz-logger
26
+
27
+ `dlz-logger` 是一个轻量级彩色日志库,支持控制台着色输出,以及按天切分的文件日志。
28
+
29
+ ## 安装
30
+
31
+ ```bash
32
+ pip install dlz-logger
33
+ ```
34
+
35
+ ## 推荐调用方式
36
+
37
+ 现在可以直接省略 `__name__`:
38
+
39
+ ```python
40
+ from datetime import datetime
41
+ from colors_logger import get_logger
42
+
43
+ LOG_LEVEL = 10
44
+
45
+ logger = get_logger(
46
+ log_level=LOG_LEVEL,
47
+ save=True,
48
+ file_name=f"收费单识别-{datetime.now():%Y%m%d_%H%M%S}",
49
+ )
50
+
51
+ logger.info("开始识别")
52
+ ```
53
+
54
+ ## 兼容旧写法
55
+
56
+ ```python
57
+ from colors_logger import LOGGER
58
+
59
+ logger = LOGGER(
60
+ log_level=10,
61
+ save=True,
62
+ file_name="demo"
63
+ ).get_logger()
64
+
65
+ logger.info("hello")
66
+ ```
67
+
68
+ 如果你仍然想显式传入模块名,也一样支持:
69
+
70
+ ```python
71
+ logger = LOGGER(__name__, log_level=10).get_logger()
72
+ ```
73
+
74
+ ## 功能特性
75
+
76
+ - 控制台彩色输出
77
+ - 按天轮转文件日志
78
+ - 自动推断调用方模块名
79
+ - 兼容类式和函数式两种调用方式
80
+
81
+ ## 本地构建
82
+
83
+ ```bash
84
+ python -m build
85
+ ```
86
+
87
+ ## 发布到 PyPI
88
+
89
+ 先配置 PyPI Token:
90
+
91
+ ```bash
92
+ set TWINE_USERNAME=__token__
93
+ set TWINE_PASSWORD=pypi-xxxxxxxxxxxxxxxxxxxx
94
+ ```
95
+
96
+ 然后执行:
97
+
98
+ ```bash
99
+ python -m twine upload dist/*
100
+ ```
@@ -0,0 +1,76 @@
1
+ # dlz-logger
2
+
3
+ `dlz-logger` 是一个轻量级彩色日志库,支持控制台着色输出,以及按天切分的文件日志。
4
+
5
+ ## 安装
6
+
7
+ ```bash
8
+ pip install dlz-logger
9
+ ```
10
+
11
+ ## 推荐调用方式
12
+
13
+ 现在可以直接省略 `__name__`:
14
+
15
+ ```python
16
+ from datetime import datetime
17
+ from colors_logger import get_logger
18
+
19
+ LOG_LEVEL = 10
20
+
21
+ logger = get_logger(
22
+ log_level=LOG_LEVEL,
23
+ save=True,
24
+ file_name=f"收费单识别-{datetime.now():%Y%m%d_%H%M%S}",
25
+ )
26
+
27
+ logger.info("开始识别")
28
+ ```
29
+
30
+ ## 兼容旧写法
31
+
32
+ ```python
33
+ from colors_logger import LOGGER
34
+
35
+ logger = LOGGER(
36
+ log_level=10,
37
+ save=True,
38
+ file_name="demo"
39
+ ).get_logger()
40
+
41
+ logger.info("hello")
42
+ ```
43
+
44
+ 如果你仍然想显式传入模块名,也一样支持:
45
+
46
+ ```python
47
+ logger = LOGGER(__name__, log_level=10).get_logger()
48
+ ```
49
+
50
+ ## 功能特性
51
+
52
+ - 控制台彩色输出
53
+ - 按天轮转文件日志
54
+ - 自动推断调用方模块名
55
+ - 兼容类式和函数式两种调用方式
56
+
57
+ ## 本地构建
58
+
59
+ ```bash
60
+ python -m build
61
+ ```
62
+
63
+ ## 发布到 PyPI
64
+
65
+ 先配置 PyPI Token:
66
+
67
+ ```bash
68
+ set TWINE_USERNAME=__token__
69
+ set TWINE_PASSWORD=pypi-xxxxxxxxxxxxxxxxxxxx
70
+ ```
71
+
72
+ 然后执行:
73
+
74
+ ```bash
75
+ python -m twine upload dist/*
76
+ ```
@@ -0,0 +1,37 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "dlz-logger"
7
+ version = "0.1.0"
8
+ description = "A lightweight colorful logger with optional daily rotating file output."
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = "MIT"
12
+ authors = [
13
+ { name = "daliangzai" }
14
+ ]
15
+ keywords = ["logging", "logger", "color", "console", "pypi"]
16
+ classifiers = [
17
+ "Development Status :: 3 - Alpha",
18
+ "Intended Audience :: Developers",
19
+ "Programming Language :: Python :: 3",
20
+ "Programming Language :: Python :: 3 :: Only",
21
+ "Programming Language :: Python :: 3.9",
22
+ "Programming Language :: Python :: 3.10",
23
+ "Programming Language :: Python :: 3.11",
24
+ "Programming Language :: Python :: 3.12",
25
+ "Programming Language :: Python :: 3.13",
26
+ "Topic :: Software Development :: Libraries :: Python Modules",
27
+ "Topic :: System :: Logging",
28
+ ]
29
+
30
+ [project.urls]
31
+ Homepage = "https://pypi.org/project/dlz-logger/"
32
+
33
+ [tool.setuptools]
34
+ package-dir = { "" = "src" }
35
+
36
+ [tool.setuptools.packages.find]
37
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,3 @@
1
+ from .logger import LOGGER, get_logger
2
+
3
+ __all__ = ["LOGGER", "get_logger"]
@@ -0,0 +1,207 @@
1
+ from __future__ import annotations
2
+
3
+ import logging
4
+ import os
5
+ import sys
6
+ from logging.handlers import TimedRotatingFileHandler
7
+ from pathlib import Path
8
+ from typing import Mapping
9
+
10
+ DEFAULT_COLORS = {
11
+ "DEBUG": "\033[94m",
12
+ "INFO": "\033[90m",
13
+ "WARNING": "\033[93m",
14
+ "ERROR": "\033[1;91m",
15
+ "CRITICAL": "\033[38;5;196m",
16
+ }
17
+ RESET_COLOR = "\033[0m"
18
+ DEFAULT_FORMAT = "%(asctime)s - %(levelname)s - %(message)s"
19
+ DEFAULT_DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
20
+
21
+
22
+ def _resolve_logger_name(name: str | None, stacklevel: int = 2) -> str:
23
+ """自动推断调用方模块名,允许外部省略 __name__。"""
24
+ if name:
25
+ return name
26
+
27
+ try:
28
+ frame = sys._getframe(stacklevel)
29
+ except ValueError:
30
+ return "__main__"
31
+
32
+ return frame.f_globals.get("__name__", "__main__")
33
+
34
+
35
+ class ColoredFormatter(logging.Formatter):
36
+ """给控制台日志添加 ANSI 颜色。"""
37
+
38
+ def __init__(
39
+ self,
40
+ colors: Mapping[str, str],
41
+ fmt: str | None = None,
42
+ datefmt: str | None = None,
43
+ ) -> None:
44
+ super().__init__(fmt=fmt, datefmt=datefmt)
45
+ self.colors = dict(colors)
46
+
47
+ def format(self, record: logging.LogRecord) -> str:
48
+ log_message = super().format(record)
49
+ color = self.colors.get(record.levelname, "")
50
+ return f"{color}{log_message}{RESET_COLOR}" if color else log_message
51
+
52
+
53
+ class LOGGER:
54
+ """彩色日志封装,支持控制台输出和按天切分文件日志。"""
55
+
56
+ def __init__(
57
+ self,
58
+ name: str | None = None,
59
+ log_level: int = logging.DEBUG,
60
+ save: bool = False,
61
+ file_name: str | None = None,
62
+ colors: Mapping[str, str] | None = None,
63
+ log_dir: str | os.PathLike[str] | None = None,
64
+ fmt: str = DEFAULT_FORMAT,
65
+ datefmt: str = DEFAULT_DATE_FORMAT,
66
+ ) -> None:
67
+ """初始化日志器。
68
+
69
+ 参数:
70
+ name: 日志器名称;不传时自动使用调用方模块名。
71
+ log_level: 日志级别。
72
+ save: 是否写入文件。
73
+ file_name: 日志文件名,不含扩展名。
74
+ colors: 自定义颜色映射。
75
+ log_dir: 日志目录,默认当前目录下的 logs。
76
+ fmt: 日志格式。
77
+ datefmt: 时间格式。
78
+ """
79
+ self.colors = dict(DEFAULT_COLORS)
80
+ if colors:
81
+ self.colors.update(colors)
82
+
83
+ resolved_name = _resolve_logger_name(name=name, stacklevel=2)
84
+ self.logger = logging.getLogger(resolved_name)
85
+ self.logger.setLevel(log_level)
86
+ self.logger.propagate = False
87
+
88
+ self._setup_console_handler(log_level=log_level, fmt=fmt, datefmt=datefmt)
89
+
90
+ if save:
91
+ self._setup_file_handler(
92
+ log_level=log_level,
93
+ file_name=file_name,
94
+ log_dir=log_dir,
95
+ fmt=fmt,
96
+ datefmt=datefmt,
97
+ )
98
+
99
+ def _find_handler(self, handler_type: str) -> logging.Handler | None:
100
+ """查找当前 logger 上由本库创建的 handler。"""
101
+ for handler in self.logger.handlers:
102
+ if getattr(handler, "_colors_logger_handler_type", None) == handler_type:
103
+ return handler
104
+ return None
105
+
106
+ def _setup_console_handler(self, log_level: int, fmt: str, datefmt: str) -> None:
107
+ """配置或复用控制台 handler,避免重复输出。"""
108
+ console_handler = self._find_handler("console")
109
+ formatter = ColoredFormatter(self.colors, fmt=fmt, datefmt=datefmt)
110
+
111
+ if console_handler is None:
112
+ console_handler = logging.StreamHandler()
113
+ console_handler._colors_logger_handler_type = "console" # type: ignore[attr-defined]
114
+ self.logger.addHandler(console_handler)
115
+
116
+ console_handler.setLevel(log_level)
117
+ console_handler.setFormatter(formatter)
118
+
119
+ def _setup_file_handler(
120
+ self,
121
+ log_level: int,
122
+ file_name: str | None,
123
+ log_dir: str | os.PathLike[str] | None,
124
+ fmt: str,
125
+ datefmt: str,
126
+ ) -> None:
127
+ """配置按天轮转的文件日志。"""
128
+ target_path = self._build_log_path(file_name=file_name, log_dir=log_dir)
129
+ file_handler = self._find_handler("file")
130
+
131
+ if (
132
+ file_handler is not None
133
+ and getattr(file_handler, "baseFilename", None) != str(target_path)
134
+ ):
135
+ # 同一个 logger 只保留一个文件 handler,后一次配置覆盖前一次。
136
+ self.logger.removeHandler(file_handler)
137
+ file_handler.close()
138
+ file_handler = None
139
+
140
+ if file_handler is None:
141
+ file_handler = TimedRotatingFileHandler(
142
+ filename=target_path,
143
+ when="midnight",
144
+ interval=1,
145
+ backupCount=0,
146
+ encoding="utf-8",
147
+ )
148
+ file_handler._colors_logger_handler_type = "file" # type: ignore[attr-defined]
149
+ file_handler.suffix = "%Y-%m-%d.log"
150
+ self.logger.addHandler(file_handler)
151
+
152
+ file_handler.setLevel(log_level)
153
+ file_handler.setFormatter(logging.Formatter(fmt=fmt, datefmt=datefmt))
154
+
155
+ @staticmethod
156
+ def _build_log_path(
157
+ file_name: str | None,
158
+ log_dir: str | os.PathLike[str] | None,
159
+ ) -> Path:
160
+ """生成日志文件完整路径。"""
161
+ resolved_file_name = file_name or "main"
162
+ resolved_log_dir = Path(log_dir) if log_dir else Path.cwd() / "logs"
163
+ resolved_log_dir.mkdir(parents=True, exist_ok=True)
164
+ return resolved_log_dir / f"{resolved_file_name}.log"
165
+
166
+ def debug(self, msg: object, *args: object, **kwargs: object) -> None:
167
+ self.logger.debug(msg, *args, **kwargs)
168
+
169
+ def info(self, msg: object, *args: object, **kwargs: object) -> None:
170
+ self.logger.info(msg, *args, **kwargs)
171
+
172
+ def warning(self, msg: object, *args: object, **kwargs: object) -> None:
173
+ self.logger.warning(msg, *args, **kwargs)
174
+
175
+ def error(self, msg: object, *args: object, **kwargs: object) -> None:
176
+ self.logger.error(msg, *args, **kwargs)
177
+
178
+ def critical(self, msg: object, *args: object, **kwargs: object) -> None:
179
+ self.logger.critical(msg, *args, **kwargs)
180
+
181
+ def get_logger(self) -> logging.Logger:
182
+ """返回原生 logging.Logger,方便无缝接入现有代码。"""
183
+ return self.logger
184
+
185
+
186
+ def get_logger(
187
+ name: str | None = None,
188
+ log_level: int = logging.DEBUG,
189
+ save: bool = False,
190
+ file_name: str | None = None,
191
+ colors: Mapping[str, str] | None = None,
192
+ log_dir: str | os.PathLike[str] | None = None,
193
+ fmt: str = DEFAULT_FORMAT,
194
+ datefmt: str = DEFAULT_DATE_FORMAT,
195
+ ) -> logging.Logger:
196
+ """函数式入口,推荐直接使用这个接口。"""
197
+ resolved_name = _resolve_logger_name(name=name, stacklevel=2)
198
+ return LOGGER(
199
+ name=resolved_name,
200
+ log_level=log_level,
201
+ save=save,
202
+ file_name=file_name,
203
+ colors=colors,
204
+ log_dir=log_dir,
205
+ fmt=fmt,
206
+ datefmt=datefmt,
207
+ ).get_logger()
@@ -0,0 +1,100 @@
1
+ Metadata-Version: 2.4
2
+ Name: dlz-logger
3
+ Version: 0.1.0
4
+ Summary: A lightweight colorful logger with optional daily rotating file output.
5
+ Author: daliangzai
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://pypi.org/project/dlz-logger/
8
+ Keywords: logging,logger,color,console,pypi
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
19
+ Classifier: Topic :: System :: Logging
20
+ Requires-Python: >=3.9
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Dynamic: license-file
24
+
25
+ # dlz-logger
26
+
27
+ `dlz-logger` 是一个轻量级彩色日志库,支持控制台着色输出,以及按天切分的文件日志。
28
+
29
+ ## 安装
30
+
31
+ ```bash
32
+ pip install dlz-logger
33
+ ```
34
+
35
+ ## 推荐调用方式
36
+
37
+ 现在可以直接省略 `__name__`:
38
+
39
+ ```python
40
+ from datetime import datetime
41
+ from colors_logger import get_logger
42
+
43
+ LOG_LEVEL = 10
44
+
45
+ logger = get_logger(
46
+ log_level=LOG_LEVEL,
47
+ save=True,
48
+ file_name=f"收费单识别-{datetime.now():%Y%m%d_%H%M%S}",
49
+ )
50
+
51
+ logger.info("开始识别")
52
+ ```
53
+
54
+ ## 兼容旧写法
55
+
56
+ ```python
57
+ from colors_logger import LOGGER
58
+
59
+ logger = LOGGER(
60
+ log_level=10,
61
+ save=True,
62
+ file_name="demo"
63
+ ).get_logger()
64
+
65
+ logger.info("hello")
66
+ ```
67
+
68
+ 如果你仍然想显式传入模块名,也一样支持:
69
+
70
+ ```python
71
+ logger = LOGGER(__name__, log_level=10).get_logger()
72
+ ```
73
+
74
+ ## 功能特性
75
+
76
+ - 控制台彩色输出
77
+ - 按天轮转文件日志
78
+ - 自动推断调用方模块名
79
+ - 兼容类式和函数式两种调用方式
80
+
81
+ ## 本地构建
82
+
83
+ ```bash
84
+ python -m build
85
+ ```
86
+
87
+ ## 发布到 PyPI
88
+
89
+ 先配置 PyPI Token:
90
+
91
+ ```bash
92
+ set TWINE_USERNAME=__token__
93
+ set TWINE_PASSWORD=pypi-xxxxxxxxxxxxxxxxxxxx
94
+ ```
95
+
96
+ 然后执行:
97
+
98
+ ```bash
99
+ python -m twine upload dist/*
100
+ ```
@@ -0,0 +1,10 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/colors_logger/__init__.py
5
+ src/colors_logger/logger.py
6
+ src/dlz_logger.egg-info/PKG-INFO
7
+ src/dlz_logger.egg-info/SOURCES.txt
8
+ src/dlz_logger.egg-info/dependency_links.txt
9
+ src/dlz_logger.egg-info/top_level.txt
10
+ tests/test_colors_logger.py
@@ -0,0 +1 @@
1
+ colors_logger
@@ -0,0 +1,52 @@
1
+ import logging
2
+ import tempfile
3
+ import unittest
4
+ from pathlib import Path
5
+
6
+ from colors_logger import LOGGER, get_logger
7
+
8
+
9
+ class TestColorsLogger(unittest.TestCase):
10
+ def test_logger_class_can_infer_module_name(self) -> None:
11
+ logger = LOGGER().get_logger()
12
+ self.assertEqual(logger.name, __name__)
13
+
14
+ def test_function_api_can_infer_module_name(self) -> None:
15
+ logger = get_logger()
16
+ self.assertEqual(logger.name, __name__)
17
+
18
+ def test_file_handler_can_be_created(self) -> None:
19
+ with tempfile.TemporaryDirectory() as temp_dir:
20
+ logger = get_logger(
21
+ name="test.file",
22
+ log_level=logging.INFO,
23
+ save=True,
24
+ file_name="sample",
25
+ log_dir=temp_dir,
26
+ )
27
+ logger.info("hello file logger")
28
+
29
+ for handler in logger.handlers:
30
+ handler.flush()
31
+
32
+ self.assertTrue((Path(temp_dir) / "sample.log").exists())
33
+
34
+ for handler in list(logger.handlers):
35
+ if getattr(handler, "_colors_logger_handler_type", None) == "file":
36
+ logger.removeHandler(handler)
37
+ handler.close()
38
+
39
+ def test_console_handler_will_not_duplicate(self) -> None:
40
+ logger = get_logger(name="test.console")
41
+ logger = get_logger(name="test.console")
42
+
43
+ console_handlers = [
44
+ handler
45
+ for handler in logger.handlers
46
+ if getattr(handler, "_colors_logger_handler_type", None) == "console"
47
+ ]
48
+ self.assertEqual(len(console_handlers), 1)
49
+
50
+
51
+ if __name__ == "__main__":
52
+ unittest.main()