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

sanic_api/logger/config.py

@@ -1,77 +1,99 @@
-import logging
+import inspect
 import logging.config
-import sys
-from types import FrameType
-from typing import Optional, Union
+from logging import LogRecord, StreamHandler
 
-import sanic.exceptions
 from loguru import logger
-from pygments import highlight
-from pygments.formatters.terminal import TerminalFormatter
-from pygments.lexers.sql import PostgresLexer
-from sanic import Request
+from sanic import BadRequest, Request, Sanic
 
 
-class InterceptHandler(logging.StreamHandler):
+class InterceptHandler(StreamHandler):
     def emit(self, record: logging.LogRecord):
-        # Get corresponding Loguru level if it exists
+        # Get corresponding Loguru level if it exists.
+        level: str | int
         try:
-            level: Union[int, str] = logger.level(record.levelname).name
+            level = logger.level(record.levelname).name
         except ValueError:
             level = record.levelno
 
         # Find caller from where originated the logged message.
-        # noinspection PyProtectedMember,PyUnresolvedReferences
-        frame: Optional[FrameType] = sys._getframe(6)
-        depth: int = 6
-        while frame and frame.f_code.co_filename == logging.__file__:
+        frame, depth = inspect.currentframe(), 0
+        while frame and (depth == 0 or frame.f_code.co_filename == logging.__file__):
             frame = frame.f_back
             depth += 1
 
-        fmt = "%(message)s"
-        sanic_access_fmt = "[%(host)s]: %(request)s %(message)s %(status)d %(byte)s %(time)s%(req_args)s"
-        fmt = fmt if record.name != "sanic.access" else sanic_access_fmt
-        formatter = logging.Formatter(fmt=fmt)
-        msg = formatter.format(record)
-        msg = self.highlight_sql(record, msg)
-        req_id = self.get_req_id()
+        # 获取标准日志的扩展信息
+        default_record = LogRecord("", 0, "", 0, "", None, None, "")
+        etxra_info = {key: value for key, value in record.__dict__.items() if key not in default_record.__dict__}
 
-        if "Dispatching signal" not in msg:
-            etxra_data = {"type": record.name, "req_id": req_id}
-            logger.bind(**etxra_data).opt(depth=depth, exception=record.exc_info).log(level, msg)
+        # 加入情求ID。用来识别情求链
+        req_id = self._get_req_id()
+        if req_id:
+            etxra_info.update({"req_id": req_id})
 
+        # 给访问日志里面加入情求体数据
+        if record.name == "sanic.access":
+            req_body = self._get_req_body()
+            etxra_info.update({"req_body": req_body})
+
+        # 如果没有扩展信息，则为空字符串
+        etxra_info = etxra_info if etxra_info else ""
+
+        # 如果有扩展信息，则在信息后面加个空格
+        src_msg = record.getMessage()
+        msg = f"{src_msg} " if etxra_info and src_msg else src_msg
+
+        # 把标准日志的名字加入到loguru日志的type字段
+        etxra_data = {"type": record.name, "etxra_info": etxra_info}
+        logger.bind(**etxra_data).opt(depth=depth, exception=record.exc_info).log(level, msg)
+
+    # noinspection PyUnresolvedReferences,PyBroadException
     @staticmethod
-    def get_req_id():
+    def _get_req() -> Request | None:
         """
-        获取请求ID
+        获取请求
         """
+
         try:
-            req = Request.get_current()
-            req_id = f" [{req.id}] "
-        except sanic.exceptions.ServerError:
-            req_id = " "
-        return req_id
+            app = Sanic.get_app()
+            req = app.request_class.get_current()
+        except Exception:
+            req = None
+        return req
+
+    def _get_req_id(self) -> str:
+        """
+        获取请求ID
+        """
 
-    def highlight_sql(self, record: logging.LogRecord, message: str):
+        req = self._get_req()
+        return str(req.id) if req else ""
+
+    def _get_req_body(self) -> dict | None:
         """
-        打印日志时高亮SQl
-        Args:
-            record: 日志记录
-            message: 日志消息
+        获取请求体数据
 
         Returns:
-
+            返回具有 json、query、form参数的json
         """
-        name = record.name
-        postgres = PostgresLexer()
-        terminal_formatter = TerminalFormatter()
-
-        if name == "tortoise.db_client":
-            if (
-                record.levelname == "DEBUG"
-                and not message.startswith("Created connection pool")
-                and not message.startswith("Closed connection pool")
-            ):
-                message = highlight(message, postgres, terminal_formatter).rstrip()
-
-        return message
+        req = self._get_req()
+        if not req:
+            return None
+
+        data = {}
+        for attr in ["args", "form"]:
+            attr_data = {}
+            for k, v in getattr(req, attr).items():
+                if isinstance(v, list) and len(v) == 1:
+                    attr_data[k] = v[0]
+                else:
+                    attr_data[k] = v
+            if attr_data:
+                data[attr] = attr_data
+
+        try:
+            if req.json:
+                data["json"] = req.json
+        except BadRequest:
+            ...
+
+        return data

sanic_api/logger/extension.py

@@ -0,0 +1,130 @@
+import logging
+import logging.config
+import sys
+from pathlib import Path
+
+from loguru import logger
+
+# noinspection PyProtectedMember
+from loguru._defaults import env
+from loki_logger_handler.formatters.loguru_formatter import LoguruFormatter
+from loki_logger_handler.loki_logger_handler import LokiLoggerHandler
+from sanic import Sanic
+from sanic.application.constants import Mode
+from sanic_ext import Extension
+
+from sanic_api.logger.config import InterceptHandler
+
+
+class LoggerExtend(Extension):
+    """
+    处理日志的扩展
+    """
+
+    name = "LoguruExtend"
+
+    def __init__(
+        self,
+        app: Sanic,
+        *,
+        log_file: str | Path | None = None,
+        rotation: str | None = None,
+        retention: str | None = None,
+        compression: str | None = None,
+        loki_url: str | None = None,
+        loki_labels: dict[str, str] | None = None,
+    ):
+        """
+        Args:
+            app: sanic app
+            log_file: 日志文件的路径
+            rotation: 日志文件自动轮转条件：查看loguru文档：https://loguru.readthedocs.io/en/stable/api/logger.html#file
+            retention: 日志文件保留条件： 查看loguru文档：https://loguru.readthedocs.io/en/stable/api/logger.html#file
+            compression: 日志文件压缩格式： "gz", "bz2", "xz", "lzma", "tar", "tar.gz", "tar.bz2", "tar.xz", "zip"
+            loki_url: 推送loki的url
+            loki_labels：loki推送时的标签
+
+        """
+        self.app = app
+        self.log_file = log_file
+        self.rotation = rotation
+        self.retention = retention
+        self.compression = compression
+        self.loki_url = loki_url
+        self.loki_labels = loki_labels
+        self.setup()
+
+    def startup(self, bootstrap) -> None:
+        """
+        扩展在初始化时安装，保留他是为了证明是一个扩展
+        因为要拦截sanic.application.motd:display的日志，所以不能写在这里
+        Args:
+            bootstrap:
+
+        Returns:
+
+        """
+
+    def setup(self):
+        """
+        安装扩展
+        Returns:
+
+        """
+        logger.remove()
+
+        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> - "
+            "<level>{message}</level>{extra[etxra_info]}",
+        )
+
+        # 基本的控制台输出
+        log_handlers = [
+            {"sink": sys.stdout, "format": log_format, "colorize": True},
+        ]
+
+        # 日志文件输出
+        if self.log_file:
+            self.log_file = self.log_file if isinstance(self.log_file, Path) else Path(self.log_file)
+            self.log_file.parent.mkdir(parents=True, exist_ok=True)
+            log_handlers.append(
+                {
+                    "sink": self.log_file,
+                    "format": log_format,
+                    "colorize": False,
+                    "serialize": True,
+                    "compression": self.compression,
+                    "rotation": self.rotation,
+                    "retention": self.retention,
+                }
+            )
+
+        # loki 推送
+        if self.loki_url:
+            loki_handler = LokiLoggerHandler(
+                url=self.loki_url,
+                labels=self.loki_labels or {},
+                labelKeys={},
+                timeout=10,
+                defaultFormatter=LoguruFormatter(),
+            )
+            log_handlers.append(
+                {
+                    "sink": loki_handler,
+                    "format": log_format,
+                    "colorize": False,
+                    "serialize": True,
+                }
+            )
+
+        # 配置日志
+        logger.configure(handlers=log_handlers)
+
+        # 接收logging的日志
+        log_level = logging.DEBUG if self.app.state.mode is Mode.DEBUG else logging.INFO
+        logging.basicConfig(handlers=[InterceptHandler()], level=log_level, force=True)

sanic_api/openapi/__init__.py

@@ -1,7 +0,0 @@
-from sanic import Sanic
-
-from sanic_api.openapi.openapi import auto_doc
-
-
-def init(sanic_app: Sanic):
-    sanic_app.before_server_start(auto_doc)

sanic_api/{enum.py → utils/enum.py}

@@ -22,7 +22,7 @@ class EnumBase(Enum):
 
     @classmethod
     def _missing_(cls, value: object) -> Any:
-        result = list(filter(lambda d: d.value == value, cls))  # type: ignore
+        result = list(filter(lambda d: d.value == value, cls))
         return result[0] if result else None
 
     @DynamicClassAttribute
@@ -56,33 +56,3 @@ class EnumBase(Enum):
     def to_desc(cls) -> str:
         data = {d.value: d.desc for d in cls}
         return json.dumps(data, ensure_ascii=False)
-
-
-class RespCodeEnum(EnumBase):
-    """
-    响应码枚举
-    """
-
-    SUCCESS = EnumField(10000, desc="成功")
-    FAILED = EnumField(40000, desc="失败")
-    PARAM_FAILED = EnumField(40001, desc="参数校验失败")
-
-
-class ParamEnum(EnumBase):
-    """
-    参数位置
-    """
-
-    JSON = EnumField("json")
-    FORM = EnumField("form")
-    QUERY = EnumField("query")
-
-
-class RunModeEnum(EnumBase):
-    """
-    运行模式
-    """
-
-    DEV = EnumField("dev", desc="开发模式。相当于debug模式加自动重载")
-    DEBUG = EnumField("debug", desc="调试模式。单workers启动。输出将更加详细，并将禁用多个运行时优化")
-    PRODUCTION = EnumField("production", desc="生产模式。如未指定workers数量，则自动使用fast模式启动。")

sanic_api-0.3.0.dist-info/METADATA

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: sanic-api
+Version: 0.3.0
+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-Expression: MIT
+License-File: LICENSE.txt
+Keywords: Sanic,Sanic扩展,异步
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: BSD
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: hs-config==0.1.3
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: loki-logger-handler>=0.1.4
+Requires-Dist: orjson>=3.8.6
+Requires-Dist: requests>=2.32.0
+Requires-Dist: sanic-ext>=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
+
+[![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.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+sanic_api/__init__.py,sha256=QKQ2Q7WcHp48T7FBPeWyNxrbWYd6hGMHtc90Lxbsdys,75
+sanic_api/app.py,sha256=_hSbX7SZQSxWDO3nP1gVOv7tlZtS6CCNOGTHZocqPYU,7948
+sanic_api/api/__init__.py,sha256=tlfFmLNwI_Y5uQD4EN6h-XRr1YmoAktqEsjlo48kvX0,383
+sanic_api/api/model.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/api/request.py,sha256=PN6_PEQRfM_-SkndTmAqNHawzPph8uN3QpkM5Mdegvs,5735
+sanic_api/api/response.py,sha256=stQ6sVF_YiWM8cp4vr79w4HSD81zCHUxV8xAcx5Sk2o,1303
+sanic_api/config/__init__.py,sha256=DVqXHMXANl_xUwBsLVYisr7ZPdX2ubA2_WH3GUZC-Bs,80
+sanic_api/config/setting.py,sha256=_WS_vACxrac7enD4ghFC8GD6d_r13TumCWSLbpbk-5Y,2583
+sanic_api/logger/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/logger/config.py,sha256=5C-kYrE13_cgw7vNxBwBLi4F8BijHakOKs6YSzxsEMA,3031
+sanic_api/logger/extension.py,sha256=xj8DjGW3jN2M7MTu4mk65H1Qs-j5VwvgO0LGahoeQRU,4108
+sanic_api/openapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/openapi/extension.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/utils/enum.py,sha256=JGFh8o8kovcR4LF3ekuWJIiZINQspfeYrvVhmFvYK-I,1240
+sanic_api-0.3.0.dist-info/METADATA,sha256=Knr3_58TA6jQFgWrSzbq4HHc1Vf4bK3P5Rv5HvrFumA,4285
+sanic_api-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sanic_api-0.3.0.dist-info/licenses/LICENSE.txt,sha256=T20w-F8AfuFO9CHy2mSk_An6T9eV4X4rGA01i-gp4M4,1090
+sanic_api-0.3.0.dist-info/RECORD,,

{sanic_api-0.2.9.dist-info → sanic_api-0.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-pep517 1.1.4
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

example/__main__.py

@@ -1,19 +0,0 @@
-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 +0,0 @@
-from .user import users_blueprint

example/api/t1/__init__.py

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

example/api/t1/t1_1.py

@@ -1,22 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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 +0,0 @@
-from .t2 import t2_blueprint

example/api/t2/t2.py

@@ -1,9 +0,0 @@
-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 +0,0 @@
-from .t3 import t3_blueprint

example/api/t2/t3/t3.py

@@ -1,9 +0,0 @@
-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!")