sanic-api 0.3.0a4__py3-none-any.whl → 0.3.0a6__py3-none-any.whl

sanic_api/__init__.py

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

sanic_api/api/request.py

@@ -4,6 +4,7 @@ from typing import get_origin
 
 from pydantic import BaseModel
 from sanic import Request as SanicRequest
+from sanic_ext.extensions.openapi.builders import OperationStore
 
 
 class Request(SanicRequest):
@@ -34,6 +35,7 @@ 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):
         """
@@ -136,3 +138,20 @@ class Request(SanicRequest):
             query_data = _proc_param_data(query_data, self._query_data_type)
             self.query_data = self._query_data_type(**query_data)
             _set_arg("query_data", self.query_data)
+
+    def _set_openapi(self):
+        """
+        注入 OpenAPI 信息
+        """
+
+        func = self.route.handler
+
+        # 设置接口的概括和描述
+        api_doc = self._request_type.__doc__ if self._request_type else func.__doc__
+
+        if api_doc:
+            api_doc = api_doc.strip()
+            summary = api_doc.split("\n")[0]
+            description = "\n".join(api_doc.split("\n")[1:])
+
+            OperationStore()[func].describe(summary=summary, description=description)

sanic_api/app.py

@@ -59,6 +59,7 @@ class BaseApp:
 
         self._setup_logger(app)
         self._setup_config(app)
+        self._setup_openai(app)
 
         app.main_process_stop(self._main_process_stop)
         app.main_process_start(self._main_process_start)
@@ -155,6 +156,8 @@ class BaseApp:
         app.config.LOGGING = True
         self._setup_cors(app)
 
+    def _setup_openai(self, app: Sanic): ...
+
     def _setup_cors(self, app: Sanic):
         """
         设置跨域: 开发模式下允许所有跨域，生产模式下使用配置中的跨域列表
@@ -164,8 +167,9 @@ class BaseApp:
         Returns:
 
         """
+        cors = ",".join(self.settings.cors_origins)
         if self.settings.mode == RunModeEnum.DEBNUG:
-            app.config.CORS_ORIGINS = "*"
+            app.config.CORS_ORIGINS = cors or "*"
             app.config.CORS_SEND_WILDCARD = True
         else:
             app.config.CORS_ORIGINS = ",".join(self.settings.cors_origins)

sanic_api/logger/extension.py

@@ -7,7 +7,8 @@ from loguru import logger
 
 # noinspection PyProtectedMember
 from loguru._defaults import env
-from loki_logger_handler.loki_logger_handler import LoguruFormatter, LokiLoggerHandler
+from loki_logger_handler.formatters.loguru_formatter import LoguruFormatter
+from loki_logger_handler.loki_logger_handler import LokiLoggerHandler
 from sanic import Sanic
 from sanic.application.constants import Mode
 from sanic_ext import Extension

sanic_api/openapi/extension.py

@@ -1,41 +0,0 @@
-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.0a4.dist-info → sanic_api-0.3.0a6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sanic-api
-Version: 0.3.0a4
+Version: 0.3.0a6
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
 Project-URL: homepage, https://github.com/x-haose/sanic-api
 Project-URL: repository, https://github.com/x-haose/sanic-api
@@ -29,9 +29,9 @@ 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.dev0,>=2.31.0
+Requires-Dist: requests>=2.32.0
 Requires-Dist: sanic-ext>=23.12.0
-Requires-Dist: sanic>=23.12.0
+Requires-Dist: sanic>=24.12.0
 Requires-Dist: sentry-sdk>=2.17.0
 Requires-Dist: ujson>=5.7.0
 Description-Content-Type: text/markdown

{sanic_api-0.3.0a4.dist-info → sanic_api-0.3.0a6.dist-info}/RECORD

@@ -1,19 +1,19 @@
-sanic_api/__init__.py,sha256=D_j_mz9nG5NAtMdIB0yUoWzB3yL1qr_On0f3TFCxGjY,77
-sanic_api/app.py,sha256=RQOuE5JcbfteNzmbLyRf_CchbQ9QJHP4ivV_FtoKiRk,7746
+sanic_api/__init__.py,sha256=M5gj0GspFvurRNBBFwqA31zf1DUcjnHyfbSGQUHune4,77
+sanic_api/app.py,sha256=t54MJ6fFtvjStpRQZaiFiSJcE_KLQZnDe8k9BJjjGCs,7884
 sanic_api/api/__init__.py,sha256=tlfFmLNwI_Y5uQD4EN6h-XRr1YmoAktqEsjlo48kvX0,383
 sanic_api/api/model.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sanic_api/api/request.py,sha256=i5WD0DvsOlAHRFMUWM96aZoErBObsVhm67lchP2jzls,5145
+sanic_api/api/request.py,sha256=PN6_PEQRfM_-SkndTmAqNHawzPph8uN3QpkM5Mdegvs,5735
 sanic_api/api/response.py,sha256=stQ6sVF_YiWM8cp4vr79w4HSD81zCHUxV8xAcx5Sk2o,1303
 sanic_api/config/__init__.py,sha256=DVqXHMXANl_xUwBsLVYisr7ZPdX2ubA2_WH3GUZC-Bs,80
 sanic_api/config/setting.py,sha256=qW8xp5alLmDcrZ3rXxQCVE8dsLFeLLfGvYJMM34uXiU,2183
 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=ErGmOIiZfT05qb4zc01hd6M1QxG4roTxxFJAqpX6wEw,4049
+sanic_api/logger/extension.py,sha256=xj8DjGW3jN2M7MTu4mk65H1Qs-j5VwvgO0LGahoeQRU,4108
 sanic_api/openapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sanic_api/openapi/extension.py,sha256=HCrcEgrj63FXOhx6TJyJDaee6mDuVnuSMA5EtdYUVjc,1009
+sanic_api/openapi/extension.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sanic_api/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sanic_api/utils/enum.py,sha256=JGFh8o8kovcR4LF3ekuWJIiZINQspfeYrvVhmFvYK-I,1240
-sanic_api-0.3.0a4.dist-info/METADATA,sha256=r-FBI3CJIChAA41eJt6Wnt02HPElPVhD16CNtSZjfIs,4390
-sanic_api-0.3.0a4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sanic_api-0.3.0a4.dist-info/licenses/LICENSE.txt,sha256=T20w-F8AfuFO9CHy2mSk_An6T9eV4X4rGA01i-gp4M4,1090
-sanic_api-0.3.0a4.dist-info/RECORD,,
+sanic_api-0.3.0a6.dist-info/METADATA,sha256=LacrqyuBdn3vdZBxqVhzNyFNLRjSCuGeF6JCisI26qc,4379
+sanic_api-0.3.0a6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sanic_api-0.3.0a6.dist-info/licenses/LICENSE.txt,sha256=T20w-F8AfuFO9CHy2mSk_An6T9eV4X4rGA01i-gp4M4,1090
+sanic_api-0.3.0a6.dist-info/RECORD,,