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

{sanic_api-0.3.0a3 → sanic_api-0.3.0a4}/.pre-commit-config.yaml

@@ -1,18 +1,18 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-repos:
-  # bandit
-  - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.10
-    hooks:
-      - id: bandit
-        args: [ "-c", "pyproject.toml" ]
-        additional_dependencies: [ "bandit[toml]" ]
-
-  # ruff
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.6.9'
-    hooks:
-      - id: ruff
-        args: [ --fix, --exit-non-zero-on-fix, --show-fixes ]
-      - id: ruff-format
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  # bandit
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.10
+    hooks:
+      - id: bandit
+        args: [ "-c", "pyproject.toml" ]
+        additional_dependencies: [ "bandit[toml]" ]
+
+  # ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.6.9'
+    hooks:
+      - id: ruff
+        args: [ --fix, --exit-non-zero-on-fix, --show-fixes ]
+      - id: ruff-format

{sanic_api-0.3.0a3 → sanic_api-0.3.0a4}/CHANGELOG.md

@@ -1,97 +1,98 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.2.6] -2023-07-05
-
-### Fixed
-
-- 修复配置类报错的问题
-
-### Changed
-
-- 升级sanic依赖版本为22.3
-- 增加`setuptools`依赖
-
-## [0.2.5] - 2023-04-09
-
-### Added
-
-- 支持捕获在中间件期间发生错误的异常情况
-- 增加配置类功能
-- 示例文件更新
-- 工具方法中新增自动蓝图方法
-
-### Changed
-
-- 默认的json dumps方法改为orjson
-- sanic 最低版本依赖更新至22.12
-- 优化API响应封装及响应文档的生成
-
-### Fixed
-
-- 修复openapi tag重复的问题
-- 修复日志级别判断不准问题
-
-## [0.2.4] - 2023-02-05
-
-### Fixed
-
-- 修复示例文件不生效的问题
-
-## [0.2.3] - 2023-02-03
-
-### Fixed
-
-- 修复无蓝图的api接口blueprint.ctx.desc报错的问题
-- 实现_missing_方法，修复枚举基类无法识别枚举值的问题
-
-### Changed
-
-- 请求接口无参数时访问日志中不打印 “args:”
-- 枚举基类字段类名称修改，避免重名
-
-### Added
-
-- API接口类支持自定义接口标签和接口描述
-- 添加types-ujson包
-- 自动生成的文档支持识别必须和可选参数
-- 枚举基类增加to_desc方法列出枚举的所有描述
-
-## [0.2.0] - 2023-01-19
-
-### Changed
-
-- api json序列化改为使用ujson
-- 移除部分3.10以上的语法
-
-### Added
-
-- 日志功能优化改进:
-    - 实现方式更加简洁优雅
-    - 可按照类型去区分
-    - 日志增加打印请求ID
-- json响应体格式设置为可配置的
-- 添加ujson包，移除orjson包
-- 读取蓝图上面的 blueprint.ctx.desc 属性来代替name设置中文tag名
-- 引入mypy、autoflake等代码检查工具
-- 添加配置文件基类
-
-## [0.1.1] - 2022-12-19
-
-### Changed
-
-- pip 首页的文件修改
-
-## [0.1.0] - 2022-12-19
-
-### Added
-
-- 接口参数校验
-- 接口文档生成
-- 日志使用`loguru`代替
-- 接口异常拦截
-- 接口响应统一化
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.2.6] - 2023-07-05
+
+### Fixed
+
+- 修复配置类报错的问题
+
+### Changed
+
+- 升级sanic依赖版本为22.3
+- 增加`setuptools`依赖
+
+## [0.2.5] - 2023-04-09
+
+### Added
+
+- 支持捕获在中间件期间发生错误的异常情况
+- 增加配置类功能
+- 示例文件更新
+- 工具方法中新增自动蓝图方法
+
+### Changed
+
+- 默认的json dumps方法改为orjson
+- sanic 最低版本依赖更新至22.12
+- 优化API响应封装及响应文档的生成
+
+### Fixed
+
+- 修复openapi tag重复的问题
+- 修复日志级别判断不准问题
+
+## [0.2.4] - 2023-02-05
+
+### Fixed
+
+- 修复示例文件不生效的问题
+
+## [0.2.3] - 2023-02-03
+
+### Fixed
+
+- 修复无蓝图的api接口blueprint.ctx.desc报错的问题
+- 实现_missing_方法，修复枚举基类无法识别枚举值的问题
+
+### Changed
+
+- 请求接口无参数时访问日志中不打印 “args:”
+- 枚举基类字段类名称修改，避免重名
+
+### Added
+
+- API接口类支持自定义接口标签和接口描述
+- 添加types-ujson包
+- 自动生成的文档支持识别必须和可选参数
+- 枚举基类增加to_desc方法列出枚举的所有描述
+
+## [0.2.0] - 2023-01-19
+
+### Changed
+
+- api json序列化改为使用ujson
+- 移除部分3.10以上的语法
+
+### Added
+
+- 日志功能优化改进:
+    - 实现方式更加简洁优雅
+    - 可按照类型去区分
+    - 日志增加打印请求ID
+- json响应体格式设置为可配置的
+- 添加ujson包，移除orjson包
+- 读取蓝图上面的 blueprint.ctx.desc 属性来代替name设置中文tag名
+- 引入mypy、autoflake等代码检查工具
+- 添加配置文件基类
+
+## [0.1.1] - 2022-12-19
+
+### Changed
+
+- pip 首页的文件修改
+
+## [0.1.0] - 2022-12-19
+
+### Added
+
+- 接口参数校验
+- 接口文档生成
+- 日志使用`loguru`代替
+- 接口异常拦截
+- 接口响应统一化

sanic_api-0.3.0a4/COMMIT_GUIDE.MD

@@ -0,0 +1,10 @@
+- ✨ feat: 一个新特性
+- ➕ improvement: 对现有特性的提升
+- 🐛 fix: 修复Bug
+- 🛠 refactor: 代码重构，注意和特性、重构区分开
+- 📚 docs: 变更文档
+- 💅 style: 修改格式，不影响功能，例如空格、代码格式等
+- 📈 perf: 性能提升
+- 🔧 ci: 修改ci相关配置、脚本等
+- ⏪ revert: 回退版本
+- 🗯 chore: 杂务，不属于以上类型，例如run build、引入或更新软件包等

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

@@ -1,12 +1,13 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: sanic-api
-Version: 0.3.0a3
+Version: 0.3.0a4
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
 Project-URL: homepage, https://github.com/x-haose/sanic-api
 Project-URL: repository, https://github.com/x-haose/sanic-api
 Project-URL: documentation, https://github.com/x-haose/sanic-api
 Author-email: 昊色居士 <xhrtxh@gmail.com>
-License: MIT
+License-Expression: MIT
+License-File: LICENSE.txt
 Keywords: Sanic,Sanic扩展,异步
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -35,12 +36,9 @@ Requires-Dist: sentry-sdk>=2.17.0
 Requires-Dist: ujson>=5.7.0
 Description-Content-Type: text/markdown
 
-![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)]()
+[![Python](https://img.shields.io/badge/Python-3.10+-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
 
@@ -48,28 +46,25 @@ Description-Content-Type: text/markdown
 
 ## 特性
 
-- 无需任何多余改动，全自动生成openapi文档，使用更加方便
+- 无需任何多余改动，全自动生成openapi文档，使用更加方便 (新版方案正在积极优化开发中)
 
-- 基于`pydantic`的参数校验器，让接口的请求及响应更符合你的预期
+- 基于`pydantic`的参数校验器，让接口的请求及响应更符合你的预期，使用更方便
 
-- 使用`loguru`库代替官方`logging`日志库，并对访问日志进行扩展，支持打印接口耗时、接口参数
+- 使用`loguru`库代替官方`logging`日志库，并对访问日志进行扩展，支持写入文件及推送loki
 
-- 使用`{code: 0, data: null, msg: ""}`样式的接口返回
+- 使用了基于`pydantic-settings`的项目配置方案，支持json、yml、ini、.env等多种格式
 
-- 对接口中的异常进行拦截，及自定义错误码
+- 对sanic的启动进行了简单的封装，可快速启动项目
 
-- 接口返回样式可自定义配置
 
 ## 截图
 
 ## 路线图
 
-- 增加一键生成预设项目cli命令
+- 全自动生成openapi文档
 
 - 编写详细文档
 
-- API接口增加请求头、URL路径参数收集和校验:
-
 ## 安装
 
 使用 pip 安装 sanic-api
@@ -80,37 +75,88 @@ Description-Content-Type: text/markdown
 
 ## 使用方法/示例
 
+### 最小示例
+```python
+from sanic_api.app import BaseApp
+
+
+class App(BaseApp):
+    """
+    最小的sanic服务示例
+    """
+
+
+if __name__ == "__main__":
+    App.run()
+```
+
+### 带参数校验的示例
 ```python
-from sanic import Sanic, text
-from sanic_api import init_api
+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.app import BaseApp
 
-app = Sanic("Sanic-API")
+user_blueprint = Blueprint("user", "/user")
 
 
-@app.get('/')
-async def index(request):
-    return text("Sanic-API Example")
+class UserInfoModel(BaseModel):
+    user_id: int = Field(title="用户ID")
 
 
-def main():
-    init_api(app)
-    app.run(access_log=True)
+class UserInfoResponse(BaseRespTml):
+    user_name: str = Field(title="用户名")
 
 
-if __name__ == '__main__':
-    main()
+class UseLoginRequest(Request):
+    form_data: UserInfoModel
 
+
+@user_blueprint.post("info")
+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()
+
+
+@user_blueprint.post("login")
+async def user_login(request: UseLoginRequest):
+    """
+    用户登录
+    """
+    logger.info(f"user_id: {request.form_data.user_id}")
+    return json(request.form_data.model_dump())
+
+
+class App(BaseApp):
+    """
+    服务示例
+    """
+
+    async def setup_route(self, app: Sanic):
+        api = Blueprint.group(url_prefix="api")
+        api.append(user_blueprint)
+        app.blueprint(api)
+
+
+if __name__ == "__main__":
+    App.run()
 ```
 
 ## 开发
 
-要部署这个项目，请运行
+要部署这个项目，请先安装rye
 
 ```bash
-  pip install pdm
-  pdm sync
+  rye sync
 ```
 
 ## 文档
-
-[文档](https://linktodocumentation)
+正在编写中，敬请期待

sanic_api-0.3.0a4/README.md

@@ -0,0 +1,124 @@
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+[![Python](https://img.shields.io/badge/Python-3.10+-yellow.svg?logo=python)]()
+[![Sanic](https://img.shields.io/badge/framework-Sanic-Server.svg)](http://www.gnu.org/licenses/agpl-3.0)
+
+# Sanic-API
+
+让您的sanic服务程序更好的支持API文档、参数校验、日志打印、响应规范等
+
+## 特性
+
+- 无需任何多余改动，全自动生成openapi文档，使用更加方便 (新版方案正在积极优化开发中)
+
+- 基于`pydantic`的参数校验器，让接口的请求及响应更符合你的预期，使用更方便
+
+- 使用`loguru`库代替官方`logging`日志库，并对访问日志进行扩展，支持写入文件及推送loki
+
+- 使用了基于`pydantic-settings`的项目配置方案，支持json、yml、ini、.env等多种格式
+
+- 对sanic的启动进行了简单的封装，可快速启动项目
+
+
+## 截图
+
+## 路线图
+
+- 全自动生成openapi文档
+
+- 编写详细文档
+
+## 安装
+
+使用 pip 安装 sanic-api
+
+```bash
+  pip install sanic-api
+```
+
+## 使用方法/示例
+
+### 最小示例
+```python
+from sanic_api.app import BaseApp
+
+
+class App(BaseApp):
+    """
+    最小的sanic服务示例
+    """
+
+
+if __name__ == "__main__":
+    App.run()
+```
+
+### 带参数校验的示例
+```python
+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.app import BaseApp
+
+user_blueprint = Blueprint("user", "/user")
+
+
+class UserInfoModel(BaseModel):
+    user_id: int = Field(title="用户ID")
+
+
+class UserInfoResponse(BaseRespTml):
+    user_name: str = Field(title="用户名")
+
+
+class UseLoginRequest(Request):
+    form_data: UserInfoModel
+
+
+@user_blueprint.post("info")
+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()
+
+
+@user_blueprint.post("login")
+async def user_login(request: UseLoginRequest):
+    """
+    用户登录
+    """
+    logger.info(f"user_id: {request.form_data.user_id}")
+    return json(request.form_data.model_dump())
+
+
+class App(BaseApp):
+    """
+    服务示例
+    """
+
+    async def setup_route(self, app: Sanic):
+        api = Blueprint.group(url_prefix="api")
+        api.append(user_blueprint)
+        app.blueprint(api)
+
+
+if __name__ == "__main__":
+    App.run()
+```
+
+## 开发
+
+要部署这个项目，请先安装rye
+
+```bash
+  rye sync
+```
+
+## 文档
+正在编写中，敬请期待

{sanic_api-0.3.0a3 → sanic_api-0.3.0a4}/example/app.py

@@ -1,56 +1,56 @@
-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.app import BaseApp
-
-user_blueprint = Blueprint("user", "/user")
-
-
-class UserInfoModel(BaseModel):
-    user_id: int = Field(title="用户ID")
-
-
-class UserInfoResponse(BaseRespTml):
-    user_name: str = Field(title="用户名")
-
-
-class UseLoginRequest(Request):
-    form_data: UserInfoModel
-
-
-@user_blueprint.post("info")
-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()
-
-
-@user_blueprint.post("login")
-async def user_login(request: UseLoginRequest):
-    """
-    用户登录
-    """
-    logger.info(f"user_id: {request.form_data.user_id}")
-    return json(request.form_data.model_dump())
-
-
-class App(BaseApp):
-    """
-    服务示例
-    """
-
-    async def setup_route(self, app: Sanic):
-        api = Blueprint.group(url_prefix="api")
-        api.append(user_blueprint)
-        app.blueprint(api)
-
-
-if __name__ == "__main__":
-    App.run()
+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.app import BaseApp
+
+user_blueprint = Blueprint("user", "/user")
+
+
+class UserInfoModel(BaseModel):
+    user_id: int = Field(title="用户ID")
+
+
+class UserInfoResponse(BaseRespTml):
+    user_name: str = Field(title="用户名")
+
+
+class UseLoginRequest(Request):
+    form_data: UserInfoModel
+
+
+@user_blueprint.post("info")
+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()
+
+
+@user_blueprint.post("login")
+async def user_login(request: UseLoginRequest):
+    """
+    用户登录
+    """
+    logger.info(f"user_id: {request.form_data.user_id}")
+    return json(request.form_data.model_dump())
+
+
+class App(BaseApp):
+    """
+    服务示例
+    """
+
+    async def setup_route(self, app: Sanic):
+        api = Blueprint.group(url_prefix="api")
+        api.append(user_blueprint)
+        app.blueprint(api)
+
+
+if __name__ == "__main__":
+    App.run()