nonebot2/nonebot/log.py
yanyongyu 80c0ac5456 ✏️ fix typo
2021-12-29 23:06:47 +08:00

100 lines
2.3 KiB
Python

"""
日志
====
NoneBot 使用 `loguru`_ 来记录日志信息。
自定义 logger 请参考 `loguru`_ 文档。
.. _loguru:
https://github.com/Delgan/loguru
"""
import sys
import logging
from typing import TYPE_CHECKING, Union
import loguru
if TYPE_CHECKING:
# avoid sphinx autodoc resolve annotation failed
# because loguru module do not have `Logger` class actually
from loguru import Logger
# logger = logging.getLogger("nonebot")
logger: "Logger" = loguru.logger
"""
:说明:
NoneBot 日志记录器对象。
:默认信息:
* 格式: ``[%(asctime)s %(name)s] %(levelname)s: %(message)s``
* 等级: ``INFO`` ,根据 ``config.log_level`` 配置改变
* 输出: 输出至 stdout
:用法:
.. code-block:: python
from nonebot.log import logger
"""
# default_handler = logging.StreamHandler(sys.stdout)
# default_handler.setFormatter(
# logging.Formatter("[%(asctime)s %(name)s] %(levelname)s: %(message)s"))
# logger.addHandler(default_handler)
class Filter:
def __init__(self) -> None:
self.level: Union[int, str] = "INFO"
def __call__(self, record):
module_name: str = record["name"]
module = sys.modules.get(module_name)
if module:
module_name = getattr(module, "__module_name__", module_name)
record["name"] = module_name.split(".")[0]
levelno = (
logger.level(self.level).no if isinstance(self.level, str) else self.level
)
return record["level"].no >= levelno
class LoguruHandler(logging.Handler): # pragma: no cover
def emit(self, record):
try:
level = logger.level(record.levelname).name
except ValueError:
level = record.levelno
frame, depth = logging.currentframe(), 2
while frame and frame.f_code.co_filename == logging.__file__:
frame = frame.f_back
depth += 1
logger.opt(depth=depth, exception=record.exc_info).log(
level, record.getMessage()
)
logger.remove()
default_filter = Filter()
default_format = (
"<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,
colorize=True,
diagnose=False,
filter=default_filter,
format=default_format,
)