sanic-api 0.2.9__py3-none-any.whl → 0.3.0__py3-none-any.whl

sanic_api/logger/extend.py

@@ -1,71 +0,0 @@
-import logging
-import logging.config
-import sys
-import time
-
-from loguru import logger
-
-# noinspection PyProtectedMember
-from loguru._defaults import env
-from sanic import HTTPResponse, Request
-from sanic.application.constants import Mode
-from sanic.server import HttpProtocol
-from sanic_ext import Extension
-
-from sanic_api.logger.config import InterceptHandler
-from sanic_api.logger.sanic_http import SanicHttp
-
-
-class LoggerExtend(Extension):
-    """
-    处理日志的扩展
-    """
-
-    name = "LoggerExtend"
-
-    def startup(self, bootstrap) -> None:
-        if not self.included():
-            return
-
-        log_level = logging.DEBUG if self.app.state.mode is Mode.DEBUG else logging.INFO
-        log_format = env(
-            "LOGURU_FORMAT",
-            str,
-            "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | "
-            "<red>{extra[type]: <10}</red> | "
-            "<level>{level: <8}</level> | "
-            "<cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - {extra[req_id]}<level>{message}</level>",
-        )
-        logger.remove()
-        logger.add(sys.stdout, colorize=True, format=log_format)
-
-        logging.basicConfig(handlers=[InterceptHandler()], level=log_level, force=True)
-
-        HttpProtocol.HTTP_CLASS = SanicHttp
-        self.app.on_request(self.proc_request, priority=999)
-        self.app.on_response(self.proc_response, priority=0)
-
-    async def proc_request(self, request: Request):
-        """
-        处理请求的中间件
-        Args:
-            request:
-
-        Returns:
-
-        """
-        request.ctx.st = time.perf_counter()
-
-    async def proc_response(self, request: Request, response: HTTPResponse):
-        """
-        处理响应的中间件
-        Args:
-            request: 请求响应
-            response: 响应
-
-        Returns:
-
-        """
-        request.ctx.et = time.perf_counter()
-
-        return response

sanic_api/logger/sanic_http.py

@@ -1,68 +0,0 @@
-from sanic import Request
-from sanic.http import Http
-from sanic.log import access_logger
-
-from sanic_api.utils import json_dumps
-
-
-class SanicHttp(Http):
-    def log_response(self) -> None:
-        """
-        自定义输出访问日志
-        Returns:
-
-        """
-        req, res = self.request, self.response
-
-        dt = (req.ctx.et - req.ctx.st) * 1000
-        size = getattr(self, "response_bytes_left", getattr(self, "response_size", -1))
-        req_args = self.get_req_args(req)
-        extra = {
-            "status": getattr(res, "status", 0),
-            "byte": self.format_size(size),
-            "host": "UNKNOWN",
-            "request": "nil",
-            "time": f"{dt:.4f} ms",
-            "req_args": f" args: {req_args}" if req_args else "",
-        }
-        if req is not None:
-            if req.remote_addr or req.ip:
-                extra["host"] = f"{req.remote_addr or req.ip}:{req.port}"
-            extra["request"] = f"{req.method} {req.url}"
-        access_logger.info("", extra=extra)
-
-    def format_size(self, size: float):
-        """
-        格式化输出大小
-        :param size: 大小
-        :return: 返回格式化的字符串
-        """
-        for count in ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB"]:
-            if -1024.0 < size < 1024.0:
-                return f"{size:3.1f} {count}"
-            size /= 1024.0
-        return f"{size:3.1f} YB"
-
-    def get_req_args(self, request: Request) -> str:
-        """
-        获取请求参数
-        Args:
-            request: 请求
-
-        Returns:
-            返回具有 json、query、form参数的json
-        """
-        data = {}
-        for attr in ["args", "form"]:
-            attr_data = {}
-            for k, v in getattr(request, attr).items():
-                if type(v) == list and len(v) == 1:
-                    attr_data[k] = v[0]
-                else:
-                    attr_data[k] = v
-            if attr_data:
-                data[attr] = attr_data
-        if request.json:
-            data["json"] = request.json
-
-        return json_dumps(data) if data else ""

sanic_api/openapi/openapi.py

@@ -1,102 +0,0 @@
-from pydantic import BaseModel
-from sanic import Sanic
-from sanic_ext.extensions.openapi.builders import (
-    OperationBuilder,
-    OperationStore,
-    SpecificationBuilder,
-)
-from sanic_ext.extensions.openapi.definitions import Schema
-from sanic_ext.extensions.openapi.types import Array, Object
-from sanic_ext.utils.route import get_all_routes
-
-from sanic_api.api import API
-from sanic_api.api.model import ListRespModel
-from sanic_api.api.validators import get_handler_param
-
-
-# noinspection PyProtectedMember
-def auto_doc(app: Sanic):
-    config = app.config
-    specification = SpecificationBuilder()
-
-    for (
-        uri,
-        route_name,
-        _route_parameters,
-        method_handlers,
-        _host,
-    ) in get_all_routes(app, config.OAS_URL_PREFIX):
-        uri = uri if uri == "/" else uri.rstrip("/")
-
-        for method, _handler in method_handlers:
-            if (
-                (method == "OPTIONS" and app.config.OAS_IGNORE_OPTIONS)
-                or (method == "HEAD" and app.config.OAS_IGNORE_HEAD)
-                or method == "TRACE"
-            ):
-                continue
-
-            if hasattr(_handler, "view_class"):
-                _handler = getattr(_handler.view_class, method.lower())
-            operation: OperationBuilder = OperationStore()[_handler]
-
-            if operation._exclude or "openapi" in operation.tags:
-                continue
-
-            api_cls = get_handler_param(_handler)
-            if not api_cls:
-                continue
-
-            api: API = api_cls()
-
-            # 读取蓝图上面的 blueprint.ctx.desc 属性来代替name设置中文tag名
-            if len(route_name.split(".")) > 1:
-                blueprint = app.blueprints[route_name.split(".")[0]]
-                blueprint.ctx.desc = blueprint.ctx.desc or blueprint.name
-                api.tags.insert(0, blueprint.ctx.desc)
-
-            # 设置接口的标签和描述
-            tags = set(api.tags)
-            operation.tag(*tags)
-            tags_str = " ".join([f"[{tag}](/docs#tag/{tag})" for tag in tags])
-            operation.describe(description=f"### 标签: {tags_str}\n{api.description}")
-
-            if api.json_req_type:
-                body_type = api.json_req_type
-                mine_type = "application/json"
-            elif api.form_req_type:
-                body_type = api.form_req_type
-                mine_type = "application/x-www-form-urlencoded"
-            else:
-                body_type, mine_type, body_dict = ["", "", {}]
-
-            if body_type:
-                body_schema: dict = body_type.schema(ref_template="#/components/schemas/{model}")
-                body_dict = {
-                    mine_type: Object(body_schema["properties"]),
-                }
-                for model_name, schema_model in body_schema.get("definitions", {}).items():
-                    specification.add_component("schemas", model_name, schema_model)
-                body_dict[mine_type]._fields["required"] = body_schema.get("required", [])
-                operation.body(body_dict)
-
-            if api.query_req_type:
-                for k, v in api.query_req_type.schema()["properties"].items():  # type: (str, dict)
-                    operation.parameter(k, Schema(**v))
-
-            if api.response_type and issubclass(api.response_type, BaseModel):
-                resp_schema = api.response_type.schema(ref_template="#/components/schemas/{model}")
-                schema: Schema = Object(resp_schema["properties"])
-                if issubclass(api.response_type, ListRespModel):
-                    schema = Array(schema)
-                for model_name, schema_model in resp_schema.get("definitions", {}).items():
-                    specification.add_component("schemas", model_name, schema_model)
-                operation.response(
-                    status=200,
-                    content={"application/json": schema},
-                    description="成功",
-                )
-                specification.add_component("schemas", api.response_type.__name__, schema)
-
-            operation._app = app
-            specification.operation(uri, method, operation)

sanic_api/utils.py

@@ -1,112 +0,0 @@
-from decimal import Decimal
-from importlib import import_module
-from pathlib import Path
-from typing import Dict, List, Optional
-
-import orjson
-from sanic import Blueprint, Request, Sanic
-from sanic.blueprint_group import BlueprintGroup
-from sanic.exceptions import ServerError as SanicServerError
-
-
-def getpath_by_root(path: str) -> Path:
-    """
-    根据根目录获取路径
-    基于 os.getcwd() 的同级路径、父目录来获取
-    Args:
-        path: 相对server的子路径
-
-    Returns:
-        完整路径
-    """
-    return (Path.cwd() / path).absolute()
-
-
-def json_dumps(data: dict, default=None) -> str:
-    """
-    调用orjson进行dumps
-    Args:
-        data: 数据
-        default: 数量处理方法
-
-    Returns:
-        返回json字符串
-    """
-
-    def _default(item):
-        if isinstance(item, Decimal):
-            return float(item.to_eng_string())
-
-    json_bytes = orjson.dumps(
-        data,
-        default=default or _default,
-        option=orjson.OPT_APPEND_NEWLINE | orjson.OPT_INDENT_2,
-    )
-    return json_bytes.decode("utf-8")
-
-
-def get_current_request() -> Optional[Request]:
-    """ "
-    获取当前请求
-    """
-    try:
-        return Request.get_current()
-    except SanicServerError:
-        return None
-
-
-def auto_blueprint(sanic_app: Sanic, base_api_module_name: str) -> None:
-    """
-    自动生成蓝图
-    Args:
-        sanic_app: app
-        base_api_module_name: api层模块名称
-
-    Returns:
-
-    """
-    # 导入base_api_module_name模块并获取其文件夹路径
-    base_api_dir: Path = Path.cwd() / base_api_module_name
-
-    # 创建根API蓝图组
-    root_group: BlueprintGroup = BlueprintGroup(base_api_module_name)
-
-    blueprint_group_map: Dict[str, BlueprintGroup] = {}
-
-    # 遍历所有__init__.py文件，查找蓝图并创建对应的蓝图组
-    init_files: List[Path] = list(base_api_dir.glob("**/__init__.py"))
-    for file in reversed(init_files):
-        # 忽略__init__.py
-        init_file: Path = file.parent
-        # 获取该蓝图所在的模块路径和名称
-        module_path: str = init_file.relative_to(base_api_dir.parent).with_suffix("").as_posix()
-        module_name: str = module_path.replace("/", ".")
-
-        # 导入蓝图所在的模块，并获取该模块下的所有蓝图
-        module = import_module(module_name, base_api_module_name)
-        blueprints = [getattr(module, attr) for attr in dir(module) if isinstance(getattr(module, attr), Blueprint)]
-        # 拆分模块路径，创建对应的蓝图组并添加到父级蓝图组中
-        parts = [path for path in module_path.split("/") if path not in [base_api_module_name, init_file.name]]
-
-        if len(blueprints) == 1:
-            blueprint = blueprints[0]
-            if not parts:
-                blueprint_group = blueprint_group_map.get(init_file.name)
-                if blueprint_group:
-                    blueprint.url_prefix = ""
-                    blueprint_group.append(blueprint)
-                    root_group.append(blueprint_group)
-                else:
-                    root_group.append(blueprint)
-            else:
-                for part in parts:
-                    group = blueprint_group_map.get(part, BlueprintGroup(part))
-                    group.append(blueprint)
-                    blueprint_group_map[part] = group
-        else:
-            group = BlueprintGroup(init_file.name)
-            group.extend(blueprints)
-            root_group.append(group)
-
-    # 将根API蓝图组添加到应用中
-    sanic_app.blueprint(root_group)

sanic_api-0.2.9.dist-info/METADATA

@@ -1,96 +0,0 @@
-Metadata-Version: 2.1
-Name: sanic-api
-Version: 0.2.9
-Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
-License: MIT
-Author-email: 昊色居士 <xhrtxh@gmail.com>
-Requires-Python: >=3.8,<3.12
-Requires-Dist: hs-config>=0.1.0
-Requires-Dist: loguru>=0.6.0
-Requires-Dist: orjson>=3.8.6
-Requires-Dist: pygments>=2.13.0
-Requires-Dist: sanic[ext]>=23.6.0
-Requires-Dist: setuptools>=68.0.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)]()
-[![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.9.dist-info/RECORD

@@ -1,38 +0,0 @@
-example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-example/__main__.py,sha256=shOhgu0-e98nRuhXGzhi3rWsiZmpXZ9SDBLhgwvsFIY,605
-example/api/__init__.py,sha256=itThNDyCx_NwzUqClx_8igf1FHakygEz9y2v8tJamkE,34
-example/api/t1/__init__.py,sha256=KJ90I8L3UhOgUXA_uyoD06Rqz01mzhPeDqA7lpZXY38,66
-example/api/t1/t1_1.py,sha256=78QCk_BwCs_6s9nnkuWPGoHaNosujvUcJVsCjvn_Xhg,634
-example/api/t1/t1_2.py,sha256=071pQz-611GuY_DSKnZkRKdSh0J15fVPphTMvodexqc,233
-example/api/t2/__init__.py,sha256=Ni_NSedOlsH73KmeW5nW4J26MhBmbHg_1NbrJ3d72Co,29
-example/api/t2/t2.py,sha256=NqXZOKKZUmuLd2ce8TwtbBdIEkScbma8ngK5d_xxWXc,248
-example/api/t2/t3/__init__.py,sha256=2PBSrojyYILtU7rVFTBh-ULIFmboXQTbBr1vJ7h7c50,29
-example/api/t2/t3/t3.py,sha256=Kw7h0I43CMpan3tSmlecFHcQTao_X9dXVmYJUSd-Wz0,248
-example/api/user.py,sha256=BwAKVaaCylu_RfwcmIs2459ojgI9_hjg5fA9Whytcog,1844
-example/api/validator.py,sha256=-eZcXOIhaB-N-MlhVyHFzK6u6CnNBALKJsfC2nOyNho,1722
-example/app.py,sha256=_MJrYtVxcUz2a_ULYlXmqwPzRwaDyx3OF3QIZhJDaL0,1202
-example/settings.py,sha256=0HkZcxc7ArZfP_x31A9amL-cOw98XVjAxszOMj0PHII,134
-sanic_api/__init__.py,sha256=U2PtA7oaz_UtUqNg40fnpTAwroxxUle4XaEfi1EqDJY,348
-sanic_api/api/__init__.py,sha256=0Tb6LsOFscOqYCzgiZbR7UqP_cPGOOE-5is8YclWhI4,51
-sanic_api/api/api.py,sha256=SmGoSS7bnhVNH_RYMLXS3dCUuZD2rWy7ZXXVbi_9MBc,5486
-sanic_api/api/exception.py,sha256=hs4SpDLQjqGCKgQOa1WNocbTqheoIulr5Bplpm0Mc0w,1216
-sanic_api/api/extend.py,sha256=So_X0KgkYeOhDwFIziU1Q8qkeoPeIRisBU5nOMpJaUw,706
-sanic_api/api/handle_exception.py,sha256=Opq18Y1loRfBKtr_UTAyLMLT-C4vORnHFRhHKFNKX0o,1206
-sanic_api/api/model.py,sha256=vdIBfkJzQpAKKG5LpdFlH9UlbrNhUlcrG0rmFgh6QUY,1071
-sanic_api/api/validators.py,sha256=TCb0eRfKfTt11HN-x6u7Ci2j6cpH6UKDKGceaKU2TxE,2078
-sanic_api/config/__init__.py,sha256=G59ZgoVTr9dSvjDKh6y3_CkFn_uwbKPi0C3wlvK37xw,37
-sanic_api/config/sanic.py,sha256=BLKJgwsLVJvT1YlmW21FQXEwxSIHAhngu9Zwqe8Qh6M,636
-sanic_api/config/sanic_api.py,sha256=jIgrlOizjh3eXxiUhQ9RFiG5noAuvjTju27a4mL-xgU,373
-sanic_api/config/setting.py,sha256=oGvqkUhQVbPWhoPLPZ6uVOwwSpw8JWqJtzjvYa4YLFA,719
-sanic_api/enum.py,sha256=bBbYeys4CHI22sD_My8EIewOOznXb0nQmuIPKzZn-EM,2040
-sanic_api/logger/__init__.py,sha256=HPUhYmmzI-NHOo6uf8NGmMlSSN3gkGrmUN6TB5Qhxmc,33
-sanic_api/logger/config.py,sha256=1eEEp3YpoTCywgOeE8OZp4X0ghF4E9W52FBEAlTCVfw,2511
-sanic_api/logger/extend.py,sha256=rD7NxUFZE2esPUbpOlYul5ZNnDTjepPsu9iLgZ9JA00,1911
-sanic_api/logger/sanic_http.py,sha256=Nl1dM54XLTRO99rmzUbpR_vi-wSN_eK_9pei1kNJ7UE,2102
-sanic_api/openapi/__init__.py,sha256=_n-pklcQHcaor8WrJMGxc4HYNggZBfe3mmbkCN57fVI,146
-sanic_api/openapi/openapi.py,sha256=2Y3J8CJeT5LTLJGsQoCS98QGAZcyE3HgRTKWT2LKoao,4147
-sanic_api/utils.py,sha256=9dv_FWHb6ynuzoupOvIFPkar5Y0dlrFF977LjKIysHc,3564
-sanic_api-0.2.9.dist-info/WHEEL,sha256=B19PGBCYhWaz2p_UjAoRVh767nYQfk14Sn4TpIZ-nfU,87
-sanic_api-0.2.9.dist-info/METADATA,sha256=T7Z6L2QAvzOSjG8PQ3c84ekwDew70rP3WKk60U8mi7w,2312
-sanic_api-0.2.9.dist-info/licenses/LICENSE.txt,sha256=T20w-F8AfuFO9CHy2mSk_An6T9eV4X4rGA01i-gp4M4,1090
-sanic_api-0.2.9.dist-info/RECORD,,