📝 添加使用文档和修正部分注释

This commit is contained in:
Nanaloveyuki
2025-07-28 00:01:15 +08:00
parent cd1a77876d
commit d788b27b1c
2 changed files with 28 additions and 6 deletions

22
README.md Normal file
View File

@ -0,0 +1,22 @@
## 安装
暂无安装包, 请使用release发布版或直接clone代码到本地
## 文档
暂无文档, 请查看代码注释
## 示例
```python
# 导入
from pliblog import Logger
# 或 import pliblog(不推荐)
# 实例化
logger = Logger()
#使用功能
logger.info("这是一条信息日志")
logger.warn("这是一条带有前缀的警告日志", prefix="114514")
logger.critical("这是一条带有前缀并且日志等级不同的严重错误日志", prefix="114514", level=55)
```

View File

@ -72,13 +72,13 @@ class Logger:
return fmt_console(level, fmt_message(message, no_placeholder=True), prefix)
@staticmethod
def warn(message: Any, prefix: str | None = None, level: int = 30) -> Optional[str]:
def warn(message: Any, prefix: str | None = None, level: int = 31) -> Optional[str]:
"""
警告日志
Warn log
:param message: 消息内容 Message content
:param prefix: 前缀 Prefix
:param level: 日志级别 Log level(30~40)
:param level: 日志级别 Log level(31~40)
"""
if level < 30 or level > 40:
return None
@ -90,13 +90,13 @@ class Logger:
return fmt_console(level, fmt_message(message, no_placeholder=True), prefix)
@staticmethod
def error(message: Any, prefix: str | None = None, level: int = 40) -> Optional[str]:
def error(message: Any, prefix: str | None = None, level: int = 41) -> Optional[str]:
"""
错误日志
Error log
:param message: 消息内容 Message content
:param prefix: 前缀 Prefix
:param level: 日志级别 Log level(40~50)
:param level: 日志级别 Log level(41~50)
"""
if level < 40 or level > 50:
return None
@ -108,13 +108,13 @@ class Logger:
return fmt_console(level, fmt_message(message, no_placeholder=True), prefix)
@staticmethod
def critical(message: Any, prefix: str | None = None, level: int = 50) -> Optional[str]:
def critical(message: Any, prefix: str | None = None, level: int = 51) -> Optional[str]:
"""
严重错误日志
Critical error log
:param message: 消息内容 Message content
:param prefix: 前缀 Prefix
:param level: 日志级别 Log level(50~60)
:param level: 日志级别 Log level(51~60)
"""
if level < 50 or level > 60:
return None