sanic-api 0.4.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

sanic_api/__init__.py

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

sanic_api/app.py

@@ -43,7 +43,7 @@ class BaseApp:
         # 默认启用sanic_ext里面的后台日志记录器
         motd_display = {"envornment": settings.envornment}
         config = {"access_log": settings.access_log, "motd_display": motd_display}
-        if settings.mode == RunModeEnum.DEBNUG:
+        if settings.mode == RunModeEnum.DEBUG:
             config.update({"auto_reload": settings.auto_reload, "workers": 1, "debug": True})
         else:
             config.update({"fast": True, "auto_reload": False})
@@ -158,6 +158,7 @@ class BaseApp:
 
         """
         # app.config.LOGGING = True
+        app.config.INSPECTOR = True
         app.config.FALLBACK_ERROR_FORMAT = "json"
         self._setup_cors(app)
 
@@ -185,7 +186,7 @@ class BaseApp:
 
         """
         cors = ",".join(self.settings.cors.origins)
-        if self.settings.mode == RunModeEnum.DEBNUG:
+        if self.settings.mode == RunModeEnum.DEBUG:
             app.config.CORS_SEND_WILDCARD = True
             app.config.CORS_SUPPORTS_CREDENTIALS = self.settings.cors.supports_credentials
             app.config.CORS_ORIGINS = cors or "*"
@@ -221,7 +222,11 @@ class BaseApp:
             retention=log_config.retention,
             compression=log_config.compression,
             loki_url=log_config.loki_url,
-            loki_labels={"application": self.name, "envornment": self.settings.envornment},
+            loki_labels={
+                "application": self.name,
+                "envornment": self.settings.env,
+            },
+            log_in_json=log_config.log_in_json,
         )
         Extend.register(log_ext)
 

sanic_api/config/setting.py

@@ -9,7 +9,7 @@ class RunModeEnum(EnumBase):
     运行模式
     """
 
-    DEBNUG = EnumField("debug", desc="开发模式")
+    DEBUG = EnumField("debug", desc="开发模式")
     PRODUCTION = EnumField("prod", desc="生产模式")
 
 
@@ -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):
     """
@@ -83,11 +86,11 @@ class DefaultSettings(SettingsBase):
     port: int = Field(default=6969)
 
     # 运行模式
-    mode: RunModeEnum = Field(default=RunModeEnum.DEBNUG)
+    mode: RunModeEnum = Field(default=RunModeEnum.DEBUG)
 
     # 运行环境，仅作为环境标识。
     # 尽量不要使用这个字段去做逻辑判断。请使用mode去进行判断，因为测试环境、预发布环境、生产环境都应属于生产模式模式
-    envornment: str = Field(default="dev")
+    env: str = Field(default="dev")
 
     # 自动重载。生产模式强制关闭
     auto_reload: bool = Field(default=False)

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(
                 {

{sanic_api-0.4.1.dist-info → sanic_api-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sanic-api
-Version: 0.4.1
+Version: 0.5.0
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
 Project-URL: homepage, https://github.com/x-haose/sanic-api
 Project-URL: repository, https://github.com/x-haose/sanic-api
@@ -19,6 +19,7 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{sanic_api-0.4.1.dist-info → sanic_api-0.5.0.dist-info}/RECORD

@@ -1,19 +1,20 @@
-sanic_api/__init__.py,sha256=jI6nwCtKn23CKvA7suU2Ll4RF7h006ERknDzKbr5rnA,75
-sanic_api/app.py,sha256=bFQMGBuwWqmUTi_3YJLRgzwg2TWoI8_PNvn_ExBLHkQ,8513
+sanic_api/__init__.py,sha256=JdFcZ2ts1lbEsx67hEsbSn7g3gorqIo3ORMXTuERNcc,75
+sanic_api/app.py,sha256=dUJUdoM962wLxq5ZHqD-z-UhcBSmxgkEL_RzabY_eac,8635
 sanic_api/api/__init__.py,sha256=MxQ7A-ALJOwznJviVt6zjhcIikhEJCKoOF-7c75qtpk,42
 sanic_api/api/error.py,sha256=RikYhTFe_z0tv4nfksH4G6lzcwp5fWjNBC36xhFj-R4,661
 sanic_api/api/model.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sanic_api/api/request.py,sha256=CzltvJ8NE4UmnUTqGXJmJ7oRtBBT5GRcDADEnf7dkUE,7017
 sanic_api/config/__init__.py,sha256=DVqXHMXANl_xUwBsLVYisr7ZPdX2ubA2_WH3GUZC-Bs,80
-sanic_api/config/setting.py,sha256=K4Z9oUHe4BN0tzJltmlRF5myPDHcIq8fQ0xgK19s3iw,3156
+sanic_api/config/setting.py,sha256=AckX9cpJiIGVEN95mm2hdN_btsUxaidcvhWcoRno5jY,3237
 sanic_api/logger/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sanic_api/logger/config.py,sha256=5C-kYrE13_cgw7vNxBwBLi4F8BijHakOKs6YSzxsEMA,3031
-sanic_api/logger/extension.py,sha256=xj8DjGW3jN2M7MTu4mk65H1Qs-j5VwvgO0LGahoeQRU,4108
+sanic_api/logger/extension.py,sha256=A6h3YijlB5VtMshiNJnOLs1nZ7bp6qt1dk31D-QVIfM,4371
 sanic_api/openapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sanic_api/openapi/extension.py,sha256=HCrcEgrj63FXOhx6TJyJDaee6mDuVnuSMA5EtdYUVjc,1009
 sanic_api/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sanic_api/utils/enum.py,sha256=JGFh8o8kovcR4LF3ekuWJIiZINQspfeYrvVhmFvYK-I,1240
-sanic_api-0.4.1.dist-info/METADATA,sha256=U96UbCypOmruuQ_fwmn-lzxFl9RQrciTQD4eiLqfSYs,4285
-sanic_api-0.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sanic_api-0.4.1.dist-info/licenses/LICENSE.txt,sha256=T20w-F8AfuFO9CHy2mSk_An6T9eV4X4rGA01i-gp4M4,1090
-sanic_api-0.4.1.dist-info/RECORD,,
+sanic_api-0.5.0.dist-info/METADATA,sha256=EeHsjvNDerWRYynvpNurN0EN2E3VWDRHLh7exk0tcuo,4336
+sanic_api-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sanic_api-0.5.0.dist-info/entry_points.txt,sha256=PZcvOIZEHPvUeySs8R78X0mAxDM_EQGfpdqExppTiIM,45
+sanic_api-0.5.0.dist-info/licenses/LICENSE.txt,sha256=T20w-F8AfuFO9CHy2mSk_An6T9eV4X4rGA01i-gp4M4,1090
+sanic_api-0.5.0.dist-info/RECORD,,

sanic_api-0.5.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sanic-api = sanic_api:main