sanic-api 0.2.5__tar.gz → 0.2.7__tar.gz

{sanic-api-0.2.5 → sanic-api-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sanic-api
-Version: 0.2.5
+Version: 0.2.7
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
 License: MIT
 Author-email: 昊色居士 <xhrtxh@gmail.com>

{sanic-api-0.2.5 → sanic-api-0.2.7}/README.MD

@@ -1,79 +1,79 @@
-![logo](https://images.haose.pro/2022/12/19/logo_17%3A34%3A07_qkt9yi4d7u.png)
-
-[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
-[![Python](https://img.shields.io/badge/Python-3.8+-yellow.svg?logo=python)]()
-[![Sanic](https://img.shields.io/badge/framework-Sanic-Server.svg)](http://www.gnu.org/licenses/agpl-3.0)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-# Sanic-API
-
-让您的sanic服务程序更好的支持API文档、参数校验、日志打印、响应规范等
-
-## 特性
-
-- 无需任何多余改动，全自动生成openapi文档，使用更加方便
-
-- 基于`pydantic`的参数校验器，让接口的请求及响应更符合你的预期
-
-- 使用`loguru`库代替官方`logging`日志库，并对访问日志进行扩展，支持打印接口耗时、接口参数
-
-- 使用`{code: 0, data: null, msg: ""}`样式的接口返回
-
-- 对接口中的异常进行拦截，及自定义错误码
-
-- 接口返回样式可自定义配置
-
-## 截图
-
-## 路线图
-
-- 增加一键生成预设项目cli命令
-
-- 编写详细文档
-
-- API接口增加请求头、URL路径参数收集和校验:
-
-## 安装
-
-使用 pip 安装 sanic-api
-
-```bash
-  pip install sanic-api
-```
-
-## 使用方法/示例
-
-```python
-from sanic import Sanic, text
-from sanic_api import init_api
-
-app = Sanic("Sanic-API")
-
-
-@app.get('/')
-async def index(request):
-    return text("Sanic-API Example")
-
-
-def main():
-    init_api(app)
-    app.run(access_log=True)
-
-
-if __name__ == '__main__':
-    main()
-
-```
-
-## 开发
-
-要部署这个项目，请运行
-
-```bash
-  pip install pdm
-  pdm sync
-```
-
-## 文档
-
-[文档](https://linktodocumentation)
+![logo](https://images.haose.pro/2022/12/19/logo_17%3A34%3A07_qkt9yi4d7u.png)
+
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+[![Python](https://img.shields.io/badge/Python-3.8+-yellow.svg?logo=python)]()
+[![Sanic](https://img.shields.io/badge/framework-Sanic-Server.svg)](http://www.gnu.org/licenses/agpl-3.0)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+# Sanic-API
+
+让您的sanic服务程序更好的支持API文档、参数校验、日志打印、响应规范等
+
+## 特性
+
+- 无需任何多余改动，全自动生成openapi文档，使用更加方便
+
+- 基于`pydantic`的参数校验器，让接口的请求及响应更符合你的预期
+
+- 使用`loguru`库代替官方`logging`日志库，并对访问日志进行扩展，支持打印接口耗时、接口参数
+
+- 使用`{code: 0, data: null, msg: ""}`样式的接口返回
+
+- 对接口中的异常进行拦截，及自定义错误码
+
+- 接口返回样式可自定义配置
+
+## 截图
+
+## 路线图
+
+- 增加一键生成预设项目cli命令
+
+- 编写详细文档
+
+- API接口增加请求头、URL路径参数收集和校验:
+
+## 安装
+
+使用 pip 安装 sanic-api
+
+```bash
+  pip install sanic-api
+```
+
+## 使用方法/示例
+
+```python
+from sanic import Sanic, text
+from sanic_api import init_api
+
+app = Sanic("Sanic-API")
+
+
+@app.get('/')
+async def index(request):
+    return text("Sanic-API Example")
+
+
+def main():
+    init_api(app)
+    app.run(access_log=True)
+
+
+if __name__ == '__main__':
+    main()
+
+```
+
+## 开发
+
+要部署这个项目，请运行
+
+```bash
+  pip install pdm
+  pdm sync
+```
+
+## 文档
+
+[文档](https://linktodocumentation)

{sanic-api-0.2.5 → sanic-api-0.2.7}/example/__main__.py

@@ -1,19 +1,19 @@
-from sanic import Sanic
-from sanic.worker.loader import AppLoader
-
-from example.app import app_factory
-from example.settings import settings
-from sanic_api.enum import RunModeEnum
-
-if __name__ == "__main__":
-    loader = AppLoader(factory=app_factory)
-    app = loader.load()
-    app.prepare(
-        host=settings.host,
-        port=settings.port,
-        debug=settings.mode == RunModeEnum.DEBUG,
-        dev=settings.mode == RunModeEnum.DEV,
-        workers=settings.workers,
-        fast=settings.mode == RunModeEnum.PRODUCTION and settings.workers == 1,
-    )
-    Sanic.serve(app, app_loader=loader)
+from sanic import Sanic
+from sanic.worker.loader import AppLoader
+
+from example.app import app_factory
+from example.settings import settings
+from sanic_api.enum import RunModeEnum
+
+if __name__ == "__main__":
+    loader = AppLoader(factory=app_factory)
+    app = loader.load()
+    app.prepare(
+        host=settings.host,
+        port=settings.port,
+        debug=settings.mode == RunModeEnum.DEBUG,
+        dev=settings.mode == RunModeEnum.DEV,
+        workers=settings.workers,
+        fast=settings.mode == RunModeEnum.PRODUCTION and settings.workers == 1,
+    )
+    Sanic.serve(app, app_loader=loader)

{sanic-api-0.2.5 → sanic-api-0.2.7}/example/api/__init__.py

@@ -1 +1 @@
-from .user import users_blueprint
+from .user import users_blueprint

sanic-api-0.2.7/example/api/t1/__init__.py

@@ -0,0 +1,2 @@
+from .t1_1 import t1_1_blueprint
+from .t1_2 import t1_2_blueprint

sanic-api-0.2.5/example/api/t1/t1.py → sanic-api-0.2.7/example/api/t1/t1_1.py

@@ -1,22 +1,22 @@
-from sanic import Blueprint, Request, text
-
-from sanic_api.api.exception import ServerException
-
-t1_blueprint = Blueprint("t1_blueprint", url_prefix="/t1")
-t1_blueprint.ctx.desc = "测试蓝图2"
-
-
-@t1_blueprint.route("/test", methods=["GET", "POST"])
-async def hello(request):
-    return text("Hello world!")
-
-
-@t1_blueprint.route("/error", methods=["GET", "POST"])
-async def error(request):
-    raise ServerException(message="Error")
-
-
-@t1_blueprint.route("/restart", methods=["GET", "POST"])
-async def restart(request: Request):
-    request.app.m.restart(all_workers=True, zero_downtime=True)
-    return text("ok")
+from sanic import Blueprint, Request, text
+
+from sanic_api.api.exception import ServerException
+
+t1_1_blueprint = Blueprint("t1_1_blueprint", url_prefix="/t1_1")
+t1_1_blueprint.ctx.desc = "测试蓝图1_1"
+
+
+@t1_1_blueprint.route("/test", methods=["GET", "POST"])
+async def hello(request):
+    return text("Hello world!")
+
+
+@t1_1_blueprint.route("/error", methods=["GET", "POST"])
+async def error(request):
+    raise ServerException(message="Error")
+
+
+@t1_1_blueprint.route("/restart", methods=["GET", "POST"])
+async def restart(request: Request):
+    request.app.m.restart(all_workers=True, zero_downtime=True)
+    return text("ok")

sanic-api-0.2.7/example/api/t1/t1_2.py

@@ -0,0 +1,9 @@
+from sanic import Blueprint, text
+
+t1_2_blueprint = Blueprint("t1_2_blueprint", url_prefix="/t1_2")
+t1_2_blueprint.ctx.desc = "测试蓝图1_2"
+
+
+@t1_2_blueprint.get("/test")
+async def hello(request):
+    return text("Hello world!")

{sanic-api-0.2.5 → sanic-api-0.2.7}/example/api/t2/__init__.py

@@ -1 +1 @@
-from .t2 import t2_blueprint
+from .t2 import t2_blueprint

{sanic-api-0.2.5 → sanic-api-0.2.7}/example/api/t2/t2.py

@@ -1,9 +1,9 @@
-from sanic import Blueprint, text
-
-t2_blueprint = Blueprint("t2_blueprint", url_prefix="/t2")
-t2_blueprint.ctx.desc = "测试蓝图2"
-
-
-@t2_blueprint.route("/test", methods=["GET", "POST"])
-async def hello(request):
-    return text("Hello world!")
+from sanic import Blueprint, text
+
+t2_blueprint = Blueprint("t2_blueprint", url_prefix="/t2")
+t2_blueprint.ctx.desc = "测试蓝图2"
+
+
+@t2_blueprint.route("/test", methods=["GET", "POST"])
+async def hello(request):
+    return text("Hello world!")

{sanic-api-0.2.5 → sanic-api-0.2.7}/example/api/t2/t3/__init__.py

@@ -1 +1 @@
-from .t3 import t3_blueprint
+from .t3 import t3_blueprint

{sanic-api-0.2.5 → sanic-api-0.2.7}/example/api/t2/t3/t3.py

@@ -1,9 +1,9 @@
-from sanic import Blueprint, text
-
-t3_blueprint = Blueprint("t3_blueprint", url_prefix="/t3")
-t3_blueprint.ctx.desc = "测试蓝图3"
-
-
-@t3_blueprint.route("/test", methods=["GET", "POST"])
-async def hello(request):
-    return text("Hello world!")
+from sanic import Blueprint, text
+
+t3_blueprint = Blueprint("t3_blueprint", url_prefix="/t3")
+t3_blueprint.ctx.desc = "测试蓝图3"
+
+
+@t3_blueprint.route("/test", methods=["GET", "POST"])
+async def hello(request):
+    return text("Hello world!")

{sanic-api-0.2.5 → sanic-api-0.2.7}/example/api/user.py

@@ -1,89 +1,89 @@
-from typing import Any, Dict, List
-from uuid import uuid4
-
-from sanic import Blueprint, text
-from sanic.request import Request
-
-from .validator import (
-    UserAddApi,
-    UserDelApi,
-    UserFindOneApi,
-    UserListApi,
-    UserUpdateApi,
-)
-
-users_blueprint = Blueprint("users_blueprint", url_prefix="/users")
-users_blueprint.ctx.desc = "用户"
-
-
-@users_blueprint.route("/test", methods=["GET"])
-async def hello(request):
-    return text("Hello world!")
-
-
-@users_blueprint.route("/", methods=["POST"])
-async def user_add(request: Request, api: UserAddApi):
-    """
-    添加用户
-    """
-    api.resp.uid = 1
-    return api.json_resp()
-
-
-@users_blueprint.route("/<uid>", methods=["DELETE"])
-async def user_del(request: Request, uid: int, api: UserDelApi):
-    """
-    刪除一个用户
-    """
-
-    api.resp.uid = uid
-
-    return api.json_resp()
-
-
-@users_blueprint.route("/<uid>", methods=["PUT"])
-async def user_update(request: Request, uid: int, api: UserUpdateApi):
-    """
-    更新一个用户
-    """
-
-    api.resp.uid = uid
-
-    return api.json_resp()
-
-
-@users_blueprint.route("/<uid>", methods=["GET"])
-async def user_one(request: Request, uid: int, api: UserFindOneApi):
-    """
-    获取一个用户
-    """
-
-    api.resp.uid = 1
-    api.resp.username = "username"
-    api.resp.password = uuid4().hex
-
-    return api.json_resp()
-
-
-@users_blueprint.route("/", methods=["GET"])
-async def user_list(request: Request, api: UserListApi):
-    """
-    获取一些用户
-    """
-
-    users: List[Dict[str, Any]] = [
-        {
-            "uid": 1,
-            "username": "user1",
-        },
-        {
-            "uid": 2,
-            "username": "user2",
-        },
-    ]
-    for user in users:
-        api.resp.username = user["username"]
-        api.resp.uid = user["uid"]
-        api.resp.add_data()
-
-    return api.json_resp()
+from typing import Any, Dict, List
+from uuid import uuid4
+
+from sanic import Blueprint, text
+from sanic.request import Request
+
+from .validator import (
+    UserAddApi,
+    UserDelApi,
+    UserFindOneApi,
+    UserListApi,
+    UserUpdateApi,
+)
+
+users_blueprint = Blueprint("users_blueprint", url_prefix="/users")
+users_blueprint.ctx.desc = "用户"
+
+
+@users_blueprint.route("/test", methods=["GET"])
+async def hello(request):
+    return text("Hello world!")
+
+
+@users_blueprint.route("/", methods=["POST"])
+async def user_add(request: Request, api: UserAddApi):
+    """
+    添加用户
+    """
+    api.resp.uid = 1
+    return api.json_resp()
+
+
+@users_blueprint.route("/<uid>", methods=["DELETE"])
+async def user_del(request: Request, uid: int, api: UserDelApi):
+    """
+    刪除一个用户
+    """
+
+    api.resp.uid = uid
+
+    return api.json_resp()
+
+
+@users_blueprint.route("/<uid>", methods=["PUT"])
+async def user_update(request: Request, uid: int, api: UserUpdateApi):
+    """
+    更新一个用户
+    """
+
+    api.resp.uid = uid
+
+    return api.json_resp()
+
+
+@users_blueprint.route("/<uid>", methods=["GET"])
+async def user_one(request: Request, uid: int, api: UserFindOneApi):
+    """
+    获取一个用户
+    """
+
+    api.resp.uid = 1
+    api.resp.username = "username"
+    api.resp.password = uuid4().hex
+
+    return api.json_resp()
+
+
+@users_blueprint.route("/", methods=["GET"])
+async def user_list(request: Request, api: UserListApi):
+    """
+    获取一些用户
+    """
+
+    users: List[Dict[str, Any]] = [
+        {
+            "uid": 1,
+            "username": "user1",
+        },
+        {
+            "uid": 2,
+            "username": "user2",
+        },
+    ]
+    for user in users:
+        api.resp.username = user["username"]
+        api.resp.uid = user["uid"]
+        api.resp.add_data()
+
+    return api.json_resp()