sanic-api 0.3.0a4__tar.gz → 0.3.0a5__tar.gz

{sanic_api-0.3.0a4 → sanic_api-0.3.0a5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sanic-api
-Version: 0.3.0a4
+Version: 0.3.0a5
 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 → sanic_api-0.3.0a5}/example/app.py

@@ -17,6 +17,12 @@ class UserInfoResponse(BaseRespTml):
 
 
 class UseLoginRequest(Request):
+    """
+    用户登录
+    用户登录描述
+    这也是描述
+    """
+
     form_data: UserInfoModel
 
 

{sanic_api-0.3.0a4 → sanic_api-0.3.0a5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sanic-api"
-version = "0.3.0a4"
+version = "0.3.0a5"
 keywords = ["Sanic", "异步", "Sanic扩展"]
 description = "Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发"
 authors = [
@@ -27,7 +27,7 @@ requires-python = ">= 3.10"
 
 dependencies = [
     # sanic
-    "sanic>=23.12.0",
+    "sanic>=24.12.0",
     "sanic-ext>=23.12.0",
     # pydantic 模型定义
     "pydantic[dotenv]>=2.9.2",
@@ -44,7 +44,7 @@ dependencies = [
     "sentry-sdk>=2.17.0",
     # loki日志推送
     "loki-logger-handler>=0.1.4",
-    "requests>=2.31.0,<2.32.dev0",
+    "requests>=2.32.0",
 ]
 
 [project.urls]
@@ -72,10 +72,6 @@ allow-direct-references = true
 [tool.hatch.build.targets.wheel]
 packages = ["src/sanic_api"]
 
-[[tool.rye.sources]]
-name = "default"
-url = "https://pypi.tuna.tsinghua.edu.cn/simple"
-
 [tool.bandit]
 skips = [
     "B501",

{sanic_api-0.3.0a4 → sanic_api-0.3.0a5}/requirements-dev.lock

@@ -96,7 +96,7 @@ pyyaml==6.0.2
     # via sanic-ext
 readme-renderer==44.0
     # via twine
-requests==2.31.0
+requests==2.32.3
     # via requests-toolbelt
     # via sanic-api
     # via twine
@@ -106,7 +106,7 @@ rfc3986==2.0.0
     # via twine
 rich==13.9.4
     # via twine
-sanic==24.6.0
+sanic==24.12.0
     # via sanic-api
 sanic-ext==23.12.0
     # via sanic-api

{sanic_api-0.3.0a4 → sanic_api-0.3.0a5}/requirements.lock

@@ -50,9 +50,9 @@ python-dotenv==1.0.1
 pyyaml==6.0.2
     # via pydantic-settings
     # via sanic-ext
-requests==2.31.0
+requests==2.32.3
     # via sanic-api
-sanic==24.6.0
+sanic==24.12.0
     # via sanic-api
 sanic-ext==23.12.0
     # via sanic-api

{sanic_api-0.3.0a4 → sanic_api-0.3.0a5}/src/sanic_api/__init__.py

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

{sanic_api-0.3.0a4 → sanic_api-0.3.0a5}/src/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-0.3.0a4 → sanic_api-0.3.0a5}/src/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):
         """
         设置跨域: 开发模式下允许所有跨域，生产模式下使用配置中的跨域列表

sanic_api-0.3.0a4/src/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")
-
-
-
-"""