sanic-api 0.2.5__py3-none-any.whl → 0.2.7__py3-none-any.whl

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)

example/api/__init__.py

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

example/api/t1/__init__.py

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

example/api/t1/{t1.py → 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")

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!")

example/api/t2/__init__.py

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

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!")

example/api/t2/t3/__init__.py

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

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!")

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

example/api/validator.py

@@ -1,97 +1,97 @@
-from pydantic import BaseModel, Field
-
-from sanic_api.api import API
-from sanic_api.api.model import ListRespModel, ResponseModel
-
-
-class Pagination(BaseModel):
-    """
-    分页
-    """
-
-    page: int = Field(1, gt=0, title="页数")
-    per_page: int = Field(20, title="每页数量", gt=0, lt=100)
-
-
-class ListParam(Pagination):
-    """
-    列表
-    """
-
-    orderings: str = Field(None, title="排序字段", description='排序字段，多个字段 ”,“ 分割，倒序使用 "-", 如："id, -name"')
-
-
-class UserModel(BaseModel):
-    username: str = Field(title="用户名")
-    password: str = Field(title="密码", description="密码，经过md5加密的")
-
-
-class AddUserReqModel(BaseModel):
-    """
-    添加请求参数
-    """
-
-    user: UserModel = Field(title="用户信息")
-
-
-class AddUserRespModel(ResponseModel):
-    """
-    响应参数
-    """
-
-    uid: int = Field(default=None, title="用户ID", description="创建用户的用户ID")
-
-
-class FindOneUserRespModel(UserModel, AddUserRespModel):
-    """
-    响应参数
-    """
-
-
-class UserListRespModel(ListRespModel, FindOneUserRespModel):
-    """
-    用户列表响应参数
-    """
-
-
-class UserAddApi(API):
-    """
-    添加用户API
-    """
-
-    json_req: AddUserReqModel
-    resp: AddUserRespModel
-
-
-class UserDelApi(API):
-    """
-    删除用户API
-    """
-
-    resp: AddUserRespModel
-
-
-class UserUpdateApi(UserAddApi):
-    """
-    更新用户API
-    """
-
-    json_req: AddUserReqModel
-    resp: AddUserRespModel
-
-
-class UserFindOneApi(API):
-    """
-    查询单个用户API
-    """
-
-    resp: FindOneUserRespModel
-
-
-class UserListApi(API):
-    """
-    用户列表API
-    """
-
-    query_req: ListParam
-    resp: UserListRespModel
+from pydantic import BaseModel, Field
+
+from sanic_api.api import API
+from sanic_api.api.model import ListRespModel, ResponseModel
+
+
+class Pagination(BaseModel):
+    """
+    分页
+    """
+
+    page: int = Field(1, gt=0, title="页数")
+    per_page: int = Field(20, title="每页数量", gt=0, lt=100)
+
+
+class ListParam(Pagination):
+    """
+    列表
+    """
+
+    orderings: str = Field(None, title="排序字段", description='排序字段，多个字段 ”,“ 分割，倒序使用 "-", 如："id, -name"')
+
+
+class UserModel(BaseModel):
+    username: str = Field(title="用户名")
+    password: str = Field(title="密码", description="密码，经过md5加密的")
+
+
+class AddUserReqModel(BaseModel):
+    """
+    添加请求参数
+    """
+
+    user: UserModel = Field(title="用户信息")
+
+
+class AddUserRespModel(ResponseModel):
+    """
+    响应参数
+    """
+
+    uid: int = Field(default=None, title="用户ID", description="创建用户的用户ID")
+
+
+class FindOneUserRespModel(UserModel, AddUserRespModel):
+    """
+    响应参数
+    """
+
+
+class UserListRespModel(ListRespModel, FindOneUserRespModel):
+    """
+    用户列表响应参数
+    """
+
+
+class UserAddApi(API):
+    """
+    添加用户API
+    """
+
+    json_req: AddUserReqModel
+    resp: AddUserRespModel
+
+
+class UserDelApi(API):
+    """
+    删除用户API
+    """
+
+    resp: AddUserRespModel
+
+
+class UserUpdateApi(UserAddApi):
+    """
+    更新用户API
+    """
+
+    json_req: AddUserReqModel
+    resp: AddUserRespModel
+
+
+class UserFindOneApi(API):
+    """
+    查询单个用户API
+    """
+
+    resp: FindOneUserRespModel
+
+
+class UserListApi(API):
+    """
+    用户列表API
+    """
+
+    query_req: ListParam
+    resp: UserListRespModel

example/app.py

@@ -1,62 +1,62 @@
-from sanic import Sanic
-from sanic.log import logger
-
-from example.settings import settings
-from sanic_api import init_api
-from sanic_api.utils import auto_blueprint
-
-
-async def main_process_start(sanic_app: Sanic):
-    """
-    主进程启动之前调用
-    Args:
-        sanic_app: application
-
-    Returns:
-
-    """
-    sanic_cfg = settings.sanic.dict(by_alias=True)
-    sanic_app.config.update(sanic_cfg)
-    logger.info(f"{sanic_app.name} 服务启动")
-
-
-async def main_process_stop(sanic_app: Sanic):
-    """
-    主进程停止之后调用
-    Args:
-        sanic_app: application
-
-    Returns:
-
-    """
-
-    logger.info(f"{sanic_app.name} 服务停止")
-
-
-async def before_server_start(sanic_app: Sanic):
-    """
-    worker启动之前调用
-    Args:
-        sanic_app: application
-
-    Returns:
-
-    """
-    logger.debug(f"Worler {sanic_app.m.pid} 启动")
-
-
-def app_factory():
-    """
-    app 工厂方法
-    Returns:
-
-    """
-    app = Sanic(name="test", configure_logging=False)
-    app.main_process_start(main_process_start)
-    app.main_process_stop(main_process_stop)
-    app.before_server_start(before_server_start)
-
-    auto_blueprint(app, "example.api")
-    init_api(app)
-
-    return app
+from sanic import Sanic
+from sanic.log import logger
+
+from example.settings import settings
+from sanic_api import init_api
+from sanic_api.utils import auto_blueprint
+
+
+async def main_process_start(sanic_app: Sanic):
+    """
+    主进程启动之前调用
+    Args:
+        sanic_app: application
+
+    Returns:
+
+    """
+    sanic_cfg = settings.sanic.dict(by_alias=True)
+    sanic_app.config.update(sanic_cfg)
+    logger.info(f"{sanic_app.name} 服务启动")
+
+
+async def main_process_stop(sanic_app: Sanic):
+    """
+    主进程停止之后调用
+    Args:
+        sanic_app: application
+
+    Returns:
+
+    """
+
+    logger.info(f"{sanic_app.name} 服务停止")
+
+
+async def before_server_start(sanic_app: Sanic):
+    """
+    worker启动之前调用
+    Args:
+        sanic_app: application
+
+    Returns:
+
+    """
+    logger.debug(f"Worler {sanic_app.m.pid} 启动")
+
+
+def app_factory():
+    """
+    app 工厂方法
+    Returns:
+
+    """
+    app = Sanic(name="test", configure_logging=False)
+    app.main_process_start(main_process_start)
+    app.main_process_stop(main_process_stop)
+    app.before_server_start(before_server_start)
+
+    auto_blueprint(app, "api")
+    init_api(app)
+
+    return app

example/settings.py

@@ -1,10 +1,10 @@
-from sanic_api.config import DefaultSettings
-
-
-class Settings(DefaultSettings):
-    """
-    设置类
-    """
-
-
-settings = Settings()
+from sanic_api.config import DefaultSettings
+
+
+class Settings(DefaultSettings):
+    """
+    设置类
+    """
+
+
+settings = Settings()