sanic-api 0.4.2__tar.gz → 0.5.1__tar.gz

{sanic_api-0.4.2 → sanic_api-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sanic-api
-Version: 0.4.2
+Version: 0.5.1
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
 Project-URL: homepage, https://github.com/x-haose/sanic-api
 Project-URL: repository, https://github.com/x-haose/sanic-api

{sanic_api-0.4.2 → sanic_api-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sanic-api"
-version = "0.4.2"
+version = "0.5.1"
 keywords = ["Sanic", "异步", "Sanic扩展"]
 description = "Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发"
 readme = "README.md"

{sanic_api-0.4.2 → sanic_api-0.5.1}/src/sanic_api/__init__.py

@@ -1,3 +1,3 @@
 from sanic_api.logger.extension import LoggerExtend
 
-__version__ = "0.4.2"
+__version__ = "0.5.1"

{sanic_api-0.4.2 → sanic_api-0.5.1}/src/sanic_api/app.py

@@ -41,7 +41,7 @@ class BaseApp:
         # 开发模式下workers指定为1，自动重载根据配置决定，默认关闭，跨域设置为允许所有跨域
         # 生产模式下使用fast模型，自动指定最多的workers，自定重载强制关闭，跨域使用配置中的跨域列表
         # 默认启用sanic_ext里面的后台日志记录器
-        motd_display = {"envornment": settings.envornment}
+        motd_display = {"envornment": settings.env}
         config = {"access_log": settings.access_log, "motd_display": motd_display}
         if settings.mode == RunModeEnum.DEBUG:
             config.update({"auto_reload": settings.auto_reload, "workers": 1, "debug": True})
@@ -224,8 +224,9 @@ class BaseApp:
             loki_url=log_config.loki_url,
             loki_labels={
                 "application": self.name,
-                "envornment": self.settings.envornment,
+                "envornment": self.settings.env,
             },
+            log_in_json=log_config.log_in_json,
         )
         Extend.register(log_ext)
 

{sanic_api-0.4.2 → sanic_api-0.5.1}/src/sanic_api/config/setting.py

@@ -36,6 +36,9 @@ class LoggerSettings(BaseModel):
     # loji的地址。如果存在，则会把日志推送给logki
     loki_url: HttpUrl | None = Field(default=None)
 
+    # 日志是否以json形式打印
+    log_in_json: bool | None = Field(default=None)
+
 
 class JsonRespSettings(BaseModel):
     """
@@ -87,7 +90,7 @@ class DefaultSettings(SettingsBase):
 
     # 运行环境，仅作为环境标识。
     # 尽量不要使用这个字段去做逻辑判断。请使用mode去进行判断，因为测试环境、预发布环境、生产环境都应属于生产模式模式
-    envornment: str = Field(default="dev")
+    env: str = Field(default="dev")
 
     # 自动重载。生产模式强制关闭
     auto_reload: bool = Field(default=False)

{sanic_api-0.4.2 → sanic_api-0.5.1}/src/sanic_api/logger/extension.py

@@ -33,6 +33,7 @@ class LoggerExtend(Extension):
         compression: str | None = None,
         loki_url: str | None = None,
         loki_labels: dict[str, str] | None = None,
+        log_in_json: bool = False,
     ):
         """
         Args:
@@ -43,6 +44,7 @@ class LoggerExtend(Extension):
             compression: 日志文件压缩格式： "gz", "bz2", "xz", "lzma", "tar", "tar.gz", "tar.bz2", "tar.xz", "zip"
             loki_url: 推送loki的url
             loki_labels：loki推送时的标签
+            log_in_json: 日志是否以json形式打印
 
         """
         self.app = app
@@ -52,6 +54,7 @@ class LoggerExtend(Extension):
         self.compression = compression
         self.loki_url = loki_url
         self.loki_labels = loki_labels
+        self.log_in_json: bool = log_in_json
         self.setup()
 
     def startup(self, bootstrap) -> None:
@@ -84,9 +87,12 @@ class LoggerExtend(Extension):
         )
 
         # 基本的控制台输出
-        log_handlers = [
-            {"sink": sys.stdout, "format": log_format, "colorize": True},
-        ]
+        if self.log_in_json:
+            log_handlers = [{"sink": sys.stdout, "serialize": True}]
+        else:
+            log_handlers = [
+                {"sink": sys.stdout, "format": log_format, "colorize": True},
+            ]
 
         # 日志文件输出
         if self.log_file:
@@ -109,9 +115,9 @@ class LoggerExtend(Extension):
             loki_handler = LokiLoggerHandler(
                 url=self.loki_url,
                 labels=self.loki_labels or {},
-                labelKeys={},
+                label_keys={},
                 timeout=10,
-                defaultFormatter=LoguruFormatter(),
+                default_formatter=LoguruFormatter(),
             )
             log_handlers.append(
                 {