sanic-api 0.3.0a6__tar.gz → 0.4.1__tar.gz

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sanic-api
-Version: 0.3.0a6
+Version: 0.4.1
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
 Project-URL: homepage, https://github.com/x-haose/sanic-api
 Project-URL: repository, https://github.com/x-haose/sanic-api
@@ -23,12 +23,10 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: hs-config==0.1.3a5
+Requires-Dist: hs-config==0.1.3
 Requires-Dist: loguru>=0.7.2
 Requires-Dist: loki-logger-handler>=0.1.4
 Requires-Dist: orjson>=3.8.6
-Requires-Dist: pydantic-settings[toml,yaml]>=2.5.2
-Requires-Dist: pydantic[dotenv]>=2.9.2
 Requires-Dist: requests>=2.32.0
 Requires-Dist: sanic-ext>=23.12.0
 Requires-Dist: sanic>=24.12.0

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/example/app.py

@@ -2,8 +2,9 @@ from pydantic import BaseModel, Field
 from sanic import Blueprint, Sanic, json
 from sanic.log import logger
 
-from sanic_api.api import BaseRespTml, Request
+from sanic_api.api import Request
 from sanic_api.app import BaseApp
+from sanic_api.config import DefaultSettings
 
 user_blueprint = Blueprint("user", "/user")
 
@@ -12,7 +13,7 @@ class UserInfoModel(BaseModel):
     user_id: int = Field(title="用户ID")
 
 
-class UserInfoResponse(BaseRespTml):
+class UserInfoResponse(BaseModel):
     user_name: str = Field(title="用户名")
 
 
@@ -33,9 +34,7 @@ async def user_info(request: Request, json_data: UserInfoModel):
     """
     logger.info(f"data: {json_data}")
     info = UserInfoResponse(user_name="张三")
-    info.temp_data.code = "0000"
-    info.temp_data.msg = "查询成功"
-    return info.resp()
+    return request.json_resp(info, server_code="0000", server_msg="查询成功")
 
 
 @user_blueprint.post("login")
@@ -59,4 +58,7 @@ class App(BaseApp):
 
 
 if __name__ == "__main__":
-    App.run()
+    settings = DefaultSettings()
+    settings.port = 9999
+    settings.logger.loki_url = "http://127.0.0.1:23100/loki/api/v1/push"
+    App.run(settings)

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sanic-api"
-version = "0.3.0a6"
+version = "0.4.1"
 keywords = ["Sanic", "异步", "Sanic扩展"]
 description = "Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发"
 authors = [
@@ -29,17 +29,13 @@ dependencies = [
     # sanic
     "sanic>=24.12.0",
     "sanic-ext>=23.12.0",
-    # pydantic 模型定义
-    "pydantic[dotenv]>=2.9.2",
-    # pydantic的设置插件
-    "pydantic-settings[yaml,toml]>=2.5.2",
     # 日志打印
     "loguru>=0.7.2",
     # json
     "ujson>=5.7.0",
     "orjson>=3.8.6",
     # 配置
-    "hs-config==0.1.3a5",
+    "hs-config==0.1.3",
     # 哨兵
     "sentry-sdk>=2.17.0",
     # loki日志推送

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/requirements-dev.lock

@@ -29,7 +29,7 @@ docutils==0.21.2
     # via readme-renderer
 filelock==3.16.1
     # via virtualenv
-hs-config==0.1.3a5
+hs-config==0.1.3
     # via sanic-api
 html5tagger==1.3.0
     # via sanic
@@ -76,15 +76,13 @@ pkginfo==1.12.0
 platformdirs==4.3.6
     # via virtualenv
 pre-commit==4.0.1
-pydantic==2.9.2
+pydantic==2.10.6
     # via hs-config
     # via pydantic-settings
-    # via sanic-api
-pydantic-core==2.23.4
+pydantic-core==2.27.2
     # via pydantic
 pydantic-settings==2.6.1
     # via hs-config
-    # via sanic-api
 pygments==2.18.0
     # via readme-renderer
     # via rich

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/requirements.lock

@@ -19,7 +19,7 @@ certifi==2024.8.30
     # via sentry-sdk
 charset-normalizer==3.4.0
     # via requests
-hs-config==0.1.3a5
+hs-config==0.1.3
     # via sanic-api
 html5tagger==1.3.0
     # via sanic
@@ -36,15 +36,13 @@ multidict==6.1.0
     # via sanic
 orjson==3.10.11
     # via sanic-api
-pydantic==2.9.2
+pydantic==2.10.6
     # via hs-config
     # via pydantic-settings
-    # via sanic-api
-pydantic-core==2.23.4
+pydantic-core==2.27.2
     # via pydantic
 pydantic-settings==2.6.1
     # via hs-config
-    # via sanic-api
 python-dotenv==1.0.1
     # via pydantic-settings
 pyyaml==6.0.2

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/src/sanic_api/__init__.py

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

sanic_api-0.4.1/src/sanic_api/api/__init__.py

@@ -0,0 +1 @@
+from sanic_api.api.request import Request

sanic_api-0.4.1/src/sanic_api/api/error.py

@@ -0,0 +1,19 @@
+from sanic.errorpages import JSONRenderer
+
+from sanic_api.config.setting import JsonRespSettings
+
+
+class ErrorJSONRenderer(JSONRenderer):
+    json_resp_setting: JsonRespSettings | None = None
+
+    def _generate_output(self, *, full: bool) -> dict:
+        data = super()._generate_output(full=full)
+        if not self.json_resp_setting or not self.json_resp_setting.use_tml:
+            return data
+
+        data = {
+            self.json_resp_setting.code_field_name: self.json_resp_setting.error_code,
+            self.json_resp_setting.msg_field_name: data["message"],
+            self.json_resp_setting.data_field_name: data,
+        }
+        return data

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/src/sanic_api/api/request.py

@@ -4,8 +4,12 @@ from typing import get_origin
 
 from pydantic import BaseModel
 from sanic import Request as SanicRequest
+from sanic.compat import Header
+from sanic.response import JSONResponse
 from sanic_ext.extensions.openapi.builders import OperationStore
 
+from sanic_api.config.setting import JsonRespSettings
+
 
 class Request(SanicRequest):
     """
@@ -13,6 +17,8 @@ class Request(SanicRequest):
     加入便于接口参数获取校验的方法
     """
 
+    json_resp_setting: JsonRespSettings
+
     json_data: BaseModel
     form_data: BaseModel
     query_data: BaseModel
@@ -22,8 +28,38 @@ class Request(SanicRequest):
     _form_data_type: type[BaseModel] | None
     _query_data_type: type[BaseModel] | None
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+    def json_resp(
+        self,
+        data: BaseModel | dict | str | int | float | list,
+        server_code: str | int = "",
+        server_msg: str = "",
+        status: int = 200,
+        headers: Header | dict[str, str] | None = None,
+    ) -> JSONResponse:
+        """
+        自定义返回 JSONResponse 的方法
+        如果使用了模板模式则返回模板模式的数据
+        不使用模版情况下：如果data是dict、list直接返回，否则返回{"data": data}
+        Args:
+            data: 内容
+            server_code: 接口服务码
+            server_msg: 接口服务消息
+            status: 状态码
+            headers: 请求头
+
+        Returns:
+
+        """
+        data = data.model_dump(mode="json") if isinstance(data, BaseModel) else data
+        if self.json_resp_setting.use_tml:
+            data = {
+                self.json_resp_setting.code_field_name: server_code,
+                self.json_resp_setting.msg_field_name: server_msg,
+                self.json_resp_setting.data_field_name: data,
+            }
+        else:
+            data = {"data": data} if type(data) not in (dict, list) else data
+        return JSONResponse(data, status=status, headers=headers)
 
     async def receive_body(self):
         """
@@ -35,7 +71,6 @@ class Request(SanicRequest):
         await super().receive_body()
         self._get_data_type()
         self._load_data()
-        self._set_openapi()
 
     def _get_type(self, name: str, base_type: type):
         """

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/src/sanic_api/app.py

@@ -1,5 +1,6 @@
 import sentry_sdk
 from sanic import Sanic, text
+from sanic.errorpages import RENDERERS_BY_CONTENT_TYPE
 from sanic.log import logger
 from sanic.worker.loader import AppLoader
 from sanic_ext import Extend
@@ -7,6 +8,7 @@ from sentry_sdk.integrations.asyncio import AsyncioIntegration
 
 from sanic_api import LoggerExtend
 from sanic_api.api import Request
+from sanic_api.api.error import ErrorJSONRenderer
 from sanic_api.config import DefaultSettings, RunModeEnum
 
 
@@ -55,11 +57,13 @@ class BaseApp:
         Returns:
 
         """
+        Request.json_resp_setting = self.settings.json_resp
         app = Sanic(self.name, configure_logging=False, request_class=Request)
 
         self._setup_logger(app)
         self._setup_config(app)
         self._setup_openai(app)
+        self._setup_error_handler(app)
 
         app.main_process_stop(self._main_process_stop)
         app.main_process_start(self._main_process_start)
@@ -153,11 +157,24 @@ class BaseApp:
         Returns:
 
         """
-        app.config.LOGGING = True
+        # app.config.LOGGING = True
+        app.config.FALLBACK_ERROR_FORMAT = "json"
         self._setup_cors(app)
 
     def _setup_openai(self, app: Sanic): ...
 
+    def _setup_error_handler(self, _app: Sanic):
+        """
+        设置错误处理器
+        Args:
+            _app: Sanic App
+
+        Returns:
+
+        """
+        ErrorJSONRenderer.json_resp_setting = self.settings.json_resp
+        RENDERERS_BY_CONTENT_TYPE["application/json"] = ErrorJSONRenderer
+
     def _setup_cors(self, app: Sanic):
         """
         设置跨域: 开发模式下允许所有跨域，生产模式下使用配置中的跨域列表
@@ -167,12 +184,13 @@ class BaseApp:
         Returns:
 
         """
-        cors = ",".join(self.settings.cors_origins)
+        cors = ",".join(self.settings.cors.origins)
         if self.settings.mode == RunModeEnum.DEBNUG:
-            app.config.CORS_ORIGINS = cors or "*"
             app.config.CORS_SEND_WILDCARD = True
+            app.config.CORS_SUPPORTS_CREDENTIALS = self.settings.cors.supports_credentials
+            app.config.CORS_ORIGINS = cors or "*"
         else:
-            app.config.CORS_ORIGINS = ",".join(self.settings.cors_origins)
+            app.config.CORS_ORIGINS = cors
 
     async def _setup_route(self, app: Sanic):
         """
@@ -203,7 +221,7 @@ 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.envornment},
         )
         Extend.register(log_ext)
 
@@ -220,7 +238,7 @@ class BaseApp:
             return
 
         sentry_sdk.init(
-            dsn=self.settings.sentry_dsn,
+            dsn=str(self.settings.sentry_dsn),
             # Set traces_sample_rate to 1.0 to capture 100%
             # of transactions for tracing.
             traces_sample_rate=1.0,

{sanic_api-0.3.0a6 → sanic_api-0.4.1}/src/sanic_api/config/setting.py

@@ -37,6 +37,40 @@ class LoggerSettings(BaseModel):
     loki_url: HttpUrl | None = Field(default=None)
 
 
+class JsonRespSettings(BaseModel):
+    """
+    json 响应配置类
+    """
+
+    # 是否使用 {"code": "0", "msg": "success", "data": {}} 的格式
+    use_tml: bool = Field(default=True)
+
+    error_code: str | int = Field(default="ERROR-1")
+
+    # code 字段的名字
+    code_field_name: str = Field(default="code")
+
+    # msg 字段的名字
+    msg_field_name: str = Field(default="msg")
+
+    # data 字段的名字
+    data_field_name: str = Field(default="data")
+
+
+class CrosSettings(BaseModel):
+    """
+    跨域设置
+    """
+
+    # 地址、地址列表、*
+    # 当 credentials等于 'include' 时，origins必须是具体是地址不能是 “*”
+    origins: list[str] | None = Field(default_factory=list)
+
+    # 支持凭证。
+    # 当前端启用了withCredentials 后端需要设置这个值为True
+    supports_credentials: bool = Field(default=False)
+
+
 class DefaultSettings(SettingsBase):
     """
     配置类
@@ -62,10 +96,13 @@ class DefaultSettings(SettingsBase):
     access_log: bool = Field(default=True)
 
     # 跨域设置
-    cors_origins: list[str] | None = Field(default_factory=list)
+    cors: CrosSettings = Field(default_factory=CrosSettings)
 
     # 哨兵连接dsn，如果存在则会把错误信息推送给哨兵
     sentry_dsn: HttpUrl | None = Field(default=None)
 
     # 日志配置
     logger: LoggerSettings = Field(default_factory=LoggerSettings)
+
+    # json 响应配置
+    json_resp: JsonRespSettings = Field(default_factory=JsonRespSettings)

sanic_api-0.4.1/src/sanic_api/openapi/extension.py

@@ -0,0 +1,41 @@
+from typing import TYPE_CHECKING
+
+from sanic import Blueprint
+from sanic_ext.extensions.openapi.blueprint import blueprint_factory
+from sanic_ext.extensions.openapi.builders import SpecificationBuilder
+from sanic_ext.extensions.openapi.extension import OpenAPIExtension as BaseExtension
+
+if TYPE_CHECKING:
+    from sanic_ext import Extend
+
+
+class OpenAPIExtension(BaseExtension):
+    name = "openapi"
+    bp: Blueprint
+
+    def startup(self, bootstrap: Extend) -> None:
+        if self.app.config.OAS:
+            self.bp = blueprint_factory(self.app.config)
+            self.app.blueprint(self.bp)
+            bootstrap._openapi = SpecificationBuilder()
+
+
+"""
+import inspect
+import ast
+
+def build_spec(app, loop):
+    ...
+
+source_code = inspect.getsource(blueprint_factory)
+ast_tree = ast.parse(source_code)
+
+my_source_code = inspect.getsource(build_spec)
+my_func_ast = ast.parse(my_source_code)
+
+ast_tree.body[0].body[6] = my_func_ast
+modified_code = compile(ast_tree, filename="<ast>", mode="exec")
+
+
+
+"""

sanic_api-0.3.0a6/src/sanic_api/api/__init__.py

@@ -1,17 +0,0 @@
-from sanic_api.api.request import Request
-from sanic_api.api.response import BaseResp, BaseRespTml, TempModel
-
-"""
-class BaseResponseModel(BaseModel):
-    "直接返回str、int、float、bool等类型"
-    ...
-
-class JsonResponseModel(BaseModel):
-    "返回JSON的Pydantic结构"
-    ...
-
-class ListResponseModel(BaseModel):
-    "返回JSON的Pydantic结构的列表"
-    ...
-
-"""

sanic_api-0.3.0a6/src/sanic_api/api/response.py

@@ -1,34 +0,0 @@
-from typing import Any, ClassVar
-
-from pydantic import BaseModel, Field, PrivateAttr
-from sanic.compat import Header
-from sanic.response import JSONResponse
-
-
-class TempModel(BaseModel):
-    _data_field: str = PrivateAttr(default="data")
-    data: Any = Field(default=None, title="数据")
-    code: str = Field(default_factory=str, title="业务状态码")
-    msg: str = Field(default_factory=str, title="消息")
-
-    def get_data_field_name(self) -> str:
-        return self._data_field
-
-
-class BaseResp(BaseModel):
-    temp_data: ClassVar = Ellipsis
-
-    def resp(self, status: int = 200, headers: Header | dict[str, str] | None = None) -> JSONResponse:
-        data = self.model_dump(mode="json")
-        return JSONResponse(data, status=status, headers=headers)
-
-
-class BaseRespTml(BaseModel):
-    temp_data: TempModel | None = Field(default_factory=TempModel)
-
-    def resp(self, status: int = 200, headers: Header | dict[str, str] | None = None) -> JSONResponse:
-        tmp_data_field_name = self.temp_data.get_data_field_name()
-        self_data = self.model_dump(mode="json", exclude={"temp_data"})
-        setattr(self.temp_data, tmp_data_field_name, self_data)
-        tml_data = self.temp_data.model_dump(mode="json")
-        return JSONResponse(tml_data, status=status, headers=headers)