💡 add log, exception, consts docstring

This commit is contained in:
yanyongyu
2022-01-18 16:12:12 +08:00
parent 27b1ded9a1
commit 608cf859c8
3 changed files with 110 additions and 72 deletions

View File

@ -3,7 +3,8 @@
NoneBot 使用 [`loguru`][loguru] 来记录日志信息。
自定义 logger 请参考 [`loguru`][loguru] 文档。
自定义 logger 请参考 [自定义日志](https://v2.nonebot.dev/docs/tutorial/custom-logger)
以及 [`loguru`][loguru] 文档。
[loguru]: https://github.com/Delgan/loguru
@ -27,8 +28,7 @@ if TYPE_CHECKING:
# logger = logging.getLogger("nonebot")
logger: "Logger" = loguru.logger
"""
NoneBot 日志记录器对象。
"""NoneBot 日志记录器对象。
默认信息:
@ -84,14 +84,16 @@ class LoguruHandler(logging.Handler): # pragma: no cover
logger.remove()
default_filter = Filter()
default_format = (
default_filter: Filter = Filter()
"""默认日志等级过滤器"""
default_format: str = (
"<g>{time:MM-DD HH:mm:ss}</g> "
"[<lvl>{level}</lvl>] "
"<c><u>{name}</u></c> | "
# "<c>{function}:{line}</c>| "
"{message}"
)
"""默认日志格式"""
logger_id = logger.add(
sys.stdout,
level=0,
@ -100,3 +102,5 @@ logger_id = logger.add(
filter=default_filter,
format=default_format,
)
__autodoc__ = {"Filter": False, "LoguruHandler": False}