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

sanic_api/logger/config.py

@@ -1,77 +1,99 @@
-import logging
-import logging.config
-import sys
-from types import FrameType
-from typing import Optional, Union
-
-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
-
-
-class InterceptHandler(logging.StreamHandler):
-    def emit(self, record: logging.LogRecord):
-        # Get corresponding Loguru level if it exists
-        try:
-            level: Union[int, str] = 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 = 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()
-
-        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)
-
-    @staticmethod
-    def get_req_id():
-        """
-        获取请求ID
-        """
-        try:
-            req = Request.get_current()
-            req_id = f" [{req.id}] "
-        except sanic.exceptions.ServerError:
-            req_id = " "
-        return req_id
-
-    def highlight_sql(self, record: logging.LogRecord, message: str):
-        """
-        打印日志时高亮SQl
-        Args:
-            record: 日志记录
-            message: 日志消息
-
-        Returns:
-
-        """
-        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
+import inspect
+import logging.config
+from logging import LogRecord, StreamHandler
+
+from loguru import logger
+from sanic import BadRequest, Request, Sanic
+
+
+class InterceptHandler(StreamHandler):
+    def emit(self, record: logging.LogRecord):
+        # Get corresponding Loguru level if it exists.
+        level: str | int
+        try:
+            level = logger.level(record.levelname).name
+        except ValueError:
+            level = record.levelno
+
+        # Find caller from where originated the logged message.
+        frame, depth = inspect.currentframe(), 0
+        while frame and (depth == 0 or frame.f_code.co_filename == logging.__file__):
+            frame = frame.f_back
+            depth += 1
+
+        # 获取标准日志的扩展信息
+        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__}
+
+        # 加入情求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() -> Request | None:
+        """
+        获取请求
+        """
+
+        try:
+            app = Sanic.get_app()
+            req = app.request_class.get_current()
+        except Exception:
+            req = None
+        return req
+
+    def _get_req_id(self) -> str:
+        """
+        获取请求ID
+        """
+
+        req = self._get_req()
+        return str(req.id) if req else ""
+
+    def _get_req_body(self) -> dict | None:
+        """
+        获取请求体数据
+
+        Returns:
+            返回具有 json、query、form参数的json
+        """
+        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,129 @@
+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.loki_logger_handler import LoguruFormatter, 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/openapi/extension.py

@@ -0,0 +1,41 @@
+from typing import TYPE_CHECKING
+
+from sanic import Blueprint
+from sanic_ext.extensions.openapi.blueprint import blueprint_factory
+from sanic_ext.extensions.openapi.builders import SpecificationBuilder
+from sanic_ext.extensions.openapi.extension import OpenAPIExtension as BaseExtension
+
+if TYPE_CHECKING:
+    from sanic_ext import Extend
+
+
+class OpenAPIExtension(BaseExtension):
+    name = "openapi"
+    bp: Blueprint
+
+    def startup(self, bootstrap: Extend) -> None:
+        if self.app.config.OAS:
+            self.bp = blueprint_factory(self.app.config)
+            self.app.blueprint(self.bp)
+            bootstrap._openapi = SpecificationBuilder()
+
+
+"""
+import inspect
+import ast
+
+def build_spec(app, loop):
+    ...
+
+source_code = inspect.getsource(blueprint_factory)
+ast_tree = ast.parse(source_code)
+
+my_source_code = inspect.getsource(build_spec)
+my_func_ast = ast.parse(my_source_code)
+
+ast_tree.body[0].body[6] = my_func_ast
+modified_code = compile(ast_tree, filename="<ast>", mode="exec")
+
+
+
+"""

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

@@ -1,88 +1,58 @@
-import json
-from dataclasses import dataclass, field
-from enum import Enum, auto
-from types import DynamicClassAttribute
-from typing import Any
-
-
-@dataclass
-class EnumField:
-    """
-    枚举字段类
-    """
-
-    value: Any = field(default=auto())
-    desc: str = field(default_factory=str)
-
-
-class EnumBase(Enum):
-    """
-    枚举基类
-    """
-
-    @classmethod
-    def _missing_(cls, value: object) -> Any:
-        result = list(filter(lambda d: d.value == value, cls))  # type: ignore
-        return result[0] if result else None
-
-    @DynamicClassAttribute
-    def value(self) -> Any:
-        """
-        获取枚举的值
-        Returns:
-
-        """
-        if isinstance(self._value_, EnumField):
-            return self._value_.value
-        return self._value_
-
-    @DynamicClassAttribute
-    def desc(self) -> str:
-        """
-        获取枚举值的描述
-        Returns:
-
-        """
-        if isinstance(self._value_, EnumField):
-            return self._value_.desc
-        else:
-            return ""
-
-    @classmethod
-    def list(cls) -> list:
-        return [c.value for c in cls]
-
-    @classmethod
-    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模式启动。")
+import json
+from dataclasses import dataclass, field
+from enum import Enum, auto
+from types import DynamicClassAttribute
+from typing import Any
+
+
+@dataclass
+class EnumField:
+    """
+    枚举字段类
+    """
+
+    value: Any = field(default=auto())
+    desc: str = field(default_factory=str)
+
+
+class EnumBase(Enum):
+    """
+    枚举基类
+    """
+
+    @classmethod
+    def _missing_(cls, value: object) -> Any:
+        result = list(filter(lambda d: d.value == value, cls))
+        return result[0] if result else None
+
+    @DynamicClassAttribute
+    def value(self) -> Any:
+        """
+        获取枚举的值
+        Returns:
+
+        """
+        if isinstance(self._value_, EnumField):
+            return self._value_.value
+        return self._value_
+
+    @DynamicClassAttribute
+    def desc(self) -> str:
+        """
+        获取枚举值的描述
+        Returns:
+
+        """
+        if isinstance(self._value_, EnumField):
+            return self._value_.desc
+        else:
+            return ""
+
+    @classmethod
+    def list(cls) -> list:
+        return [c.value for c in cls]
+
+    @classmethod
+    def to_desc(cls) -> str:
+        data = {d.value: d.desc for d in cls}
+        return json.dumps(data, ensure_ascii=False)

{sanic_api-0.2.9.dist-info → sanic_api-0.3.0a2.dist-info}/METADATA

@@ -1,16 +1,37 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: sanic-api
-Version: 0.2.9
+Version: 0.3.0a2
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
-License: MIT
+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>
-Requires-Python: >=3.8,<3.12
-Requires-Dist: hs-config>=0.1.0
-Requires-Dist: loguru>=0.6.0
+License: MIT
+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.3a5
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: loki-logger-handler>=0.1.4
 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: pydantic-settings[toml,yaml]>=2.5.2
+Requires-Dist: pydantic[dotenv]>=2.9.2
+Requires-Dist: requests<2.32.dev0,>=2.31.0
+Requires-Dist: sanic-ext>=23.12.0
+Requires-Dist: sanic>=23.12.0
+Requires-Dist: sentry-sdk>=2.17.0
 Requires-Dist: ujson>=5.7.0
 Description-Content-Type: text/markdown
 
@@ -93,4 +114,3 @@ if __name__ == '__main__':
 ## 文档
 
 [文档](https://linktodocumentation)
-

sanic_api-0.3.0a2.dist-info/RECORD

@@ -0,0 +1,19 @@
+sanic_api/__init__.py,sha256=LmrOzKXnPfRurT93l3JJIs56HV_vYnsfKoQlojV8qhA,80
+sanic_api/app.py,sha256=e5L3pr8MTqmjNh5V-Y276MUb3qw67K55wmhdrE2Sxf4,7386
+sanic_api/api/__init__.py,sha256=XTYNRtZj3ufh2SaswvHfbNKiUoR5nVzqGSXb766r_Mw,400
+sanic_api/api/model.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/api/request.py,sha256=y_IE51uo-7cQECxvK7iet0pO8TX-BtiscrnD3DDdtr0,5255
+sanic_api/api/response.py,sha256=5b4FLPv1Zl1Rjneqt08taHlrXBqwIKwOgZpoBtqbNNI,1337
+sanic_api/config/__init__.py,sha256=8hFCE2efii1P5URx8nPgFLqB5ys_8QbBAEOLJNUj-y4,81
+sanic_api/config/setting.py,sha256=-ANpVP9hak7u468zXwXpXYo0do6AFATxpL_ecsw9Cb4,2254
+sanic_api/logger/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/logger/config.py,sha256=0R605TsbF30vsAF6KbcipLkKVpFyZSiSNiTxwK9KEnw,3130
+sanic_api/logger/extension.py,sha256=HZ9lSg-poSsVFwEuDXvXdbLMcsab0PWwaHlCN78tMBg,4178
+sanic_api/openapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/openapi/extension.py,sha256=HCrcEgrj63FXOhx6TJyJDaee6mDuVnuSMA5EtdYUVjc,1009
+sanic_api/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sanic_api/utils/enum.py,sha256=4E1O6W9MLGitfGam9ZTc3GZPP6yiL87v5pJ3lhfIUkg,1298
+sanic_api-0.3.0a2.dist-info/METADATA,sha256=zfrifrnBGYfTGTsWN9M2Am2yggv_OKta0VF8TOJdhVo,3386
+sanic_api-0.3.0a2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sanic_api-0.3.0a2.dist-info/licenses/LICENSE.txt,sha256=T20w-F8AfuFO9CHy2mSk_An6T9eV4X4rGA01i-gp4M4,1090
+sanic_api-0.3.0a2.dist-info/RECORD,,

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

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-pep517 1.1.4
+Generator: hatchling 1.26.3
 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