From a524a869d32c9a76027220c26411eebbb3f6429e Mon Sep 17 00:00:00 2001
From: Karako <karakohear@gmail.com>
Date: Sat, 10 Sep 2022 23:30:13 +0800
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20=E6=96=B0=E5=A2=9E=20`logger`=20?=
 =?UTF-8?q?=E7=9A=84=E9=85=8D=E7=BD=AE=E9=80=89=E9=A1=B9=201.=20`LOGGER=5F?=
 =?UTF-8?q?WIDTH`:=20`logger`=20=E7=9A=84=E5=AE=BD=E5=BA=A6=202.=20`LOGGER?=
 =?UTF-8?q?=5FLOG=5FPATH`:=20=E6=97=A5=E5=BF=97=E6=89=80=E4=BF=9D=E5=AD=98?=
 =?UTF-8?q?=E7=9A=84=E4=BD=8D=E7=BD=AE=203.=20`LOGGER=5FTIME=5FFORMAT`:=20?=
 =?UTF-8?q?=E6=97=A5=E5=BF=97=E7=9A=84=E6=97=B6=E9=97=B4=E6=A0=BC=E5=BC=8F?=
 =?UTF-8?q?=204.=20`LOGGER=5FTRACEBACK=5FMAX=5FFRAMES`:=20`logger`=20?=
 =?UTF-8?q?=E5=9B=9E=E6=BA=AF=20`traceback`=20=E7=9A=84=E6=9C=80=E5=A4=A7?=
 =?UTF-8?q?=E5=B8=A7=E6=95=B0=205.=20`LOGGER=5FRENDER=5FKEYWORDS`:=20?=
 =?UTF-8?q?=E9=9C=80=E8=A6=81=20'logger'=20=E9=AB=98=E4=BA=AE=E7=9A=84?=
 =?UTF-8?q?=E5=85=B3=E9=94=AE=E5=AD=97?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .env.example         |  7 +++++++
 core/config.py       | 27 +++++++++++++++++++++++++++
 utils/log/_logger.py | 17 +++++++++--------
 3 files changed, 43 insertions(+), 8 deletions(-)

diff --git a/.env.example b/.env.example
index 2a8f07f8..ba2dfeb6 100644
--- a/.env.example
+++ b/.env.example
@@ -27,3 +27,10 @@ ADMINS=[{ "username": "", "user_id": -1 }]
 
 # 群验证功能
 VERIFY_GROUPS=[]
+
+# logger 配置
+LOGGER_WIDTH=180
+LOGGER_LOG_PATH="logs"
+LOGGER_TIME_FORMAT="[%Y-%m-%d %X]"
+LOGGER_TRACEBACK_MAX_FRAMES=20
+LOGGER_RENDER_KEYWORDS=["BOT"]
\ No newline at end of file
diff --git a/core/config.py b/core/config.py
index 5eec427e..b791043c 100644
--- a/core/config.py
+++ b/core/config.py
@@ -1,3 +1,4 @@
+from pathlib import Path
 from typing import (
     List,
     Optional,
@@ -13,6 +14,8 @@ from pydantic import (
 
 __all__ = ['BotConfig', 'config']
 
+from utils.const import PROJECT_ROOT
+
 dotenv.load_dotenv()
 
 
@@ -36,6 +39,12 @@ class BotConfig(BaseSettings):
     admins: List['ConfigUser'] = []
     verify_groups: List[Union[int, str]] = []
 
+    logger_width: int = 180
+    logger_log_path: str = './logs'
+    logger_time_format: str = "[%Y-%m-%d %X]"
+    logger_traceback_max_frames: int = 20
+    logger_render_keywords: List[str] = ['BOT']
+
     class Config:
         case_sensitive = False
         json_loads = json.loads
@@ -59,6 +68,16 @@ class BotConfig(BaseSettings):
             database=self.redis_db,
         )
 
+    @property
+    def logger(self) -> "LoggerConfig":
+        return LoggerConfig(
+            width=self.logger_width,
+            traceback_max_frames=self.logger_traceback_max_frames,
+            path=PROJECT_ROOT.joinpath(self.logger_log_path).resolve(),
+            time_format=self.logger_time_format,
+            render_keywords=self.logger_render_keywords,
+        )
+
 
 class ConfigChannel(BaseModel):
     name: str
@@ -84,5 +103,13 @@ class RedisConfig(BaseModel):
     database: int = 0
 
 
+class LoggerConfig(BaseModel):
+    width: int = 180
+    time_format: str = "[%Y-%m-%d %X]"
+    traceback_max_frames: int = 20
+    path: Path = PROJECT_ROOT / 'logs'
+    render_keywords: List[str] = ['BOT']
+
+
 BotConfig.update_forward_refs()
 config = BotConfig()
diff --git a/utils/log/_logger.py b/utils/log/_logger.py
index 7dcbf339..c353ff4a 100644
--- a/utils/log/_logger.py
+++ b/utils/log/_logger.py
@@ -71,14 +71,13 @@ else:
     color_system = 'truecolor'
 # noinspection SpellCheckingInspection
 log_console = Console(
-    color_system=color_system, theme=Theme(DEFAULT_STYLE),
-    width=180 if "PYCHARM_HOSTED" in os.environ else None  # 针对 Pycharm
+    color_system=color_system, theme=Theme(DEFAULT_STYLE), width=config.logger.width
 )
 
 
 class Traceback(BaseTraceback):
     def __init__(self, *args, **kwargs):
-        kwargs.update({'show_locals': True, 'max_frames': 20})
+        kwargs.update({'show_locals': True, 'max_frames': config.logger.traceback_max_frames})
         super(Traceback, self).__init__(*args, **kwargs)
         self.theme = PygmentsSyntaxTheme(MonokaiProStyle)
 
@@ -213,7 +212,7 @@ class LogRender(DefaultLogRender):
     def __init__(self, *args, **kwargs):
         super(LogRender, self).__init__(*args, **kwargs)
         self.show_level = True
-        self.time_format = "[%Y-%m-%d %X]"
+        self.time_format = config.logger.time_format
 
     def __call__(
             self,
@@ -279,7 +278,7 @@ class Handler(DefaultRichHandler):
         self.console = log_console
         self.rich_tracebacks = True
         self.tracebacks_show_locals = True
-        self.keywords = [*self.KEYWORDS, 'BOT']
+        self.keywords = self.KEYWORDS + config.logger.render_keywords
 
     def render(
             self,
@@ -455,11 +454,13 @@ class Logger(logging.Logger):
 
 with _lock:
     if not __initialized__:
+        if "PYCHARM_HOSTED" in os.environ:
+            print()  # 针对 pycharm 的控制台 bug
         logging.captureWarnings(True)
         handler, debug_handler, error_handler = (
-            Handler(locals_max_length=4, locals_max_string=10),
-            FileHandler(level=10, path=PROJECT_ROOT.joinpath("logs/debug/debug.log")),
-            FileHandler(level=40, path=PROJECT_ROOT.joinpath("logs/error/error.log"))
+            Handler(locals_max_length=4),
+            FileHandler(level=10, path=config.logger.path.joinpath("debug/debug.log")),
+            FileHandler(level=40, path=config.logger.path.joinpath("error/error.log"))
         )
 
         level_ = 10 if config.debug else 20