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

sanic_api/enum.py

@@ -1,88 +1,88 @@
-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))  # 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模式启动。")

sanic_api/logger/__init__.py

@@ -1 +1 @@
-from .extend import LoggerExtend
+from .extend import LoggerExtend

sanic_api/logger/config.py

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

sanic_api/logger/extend.py

@@ -1,71 +1,71 @@
-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
+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 +1,68 @@
-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 ""
+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/__init__.py

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