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

sanic_api/api/model.py

@@ -1,45 +1,45 @@
-from typing import Optional, Union
-
-from pydantic.fields import ModelField, ModelPrivateAttr
-from pydantic.main import BaseModel
-
-
-class ResponseModel(BaseModel):
-    """
-    响应基础模型
-    """
-
-    def __new__(cls, *args, **kwargs):
-        for _field, value in cls.__fields__.items():
-            if not isinstance(value, ModelField):
-                continue
-            value.required = False
-
-        return super().__new__(cls, *args, **kwargs)
-
-
-class ListRespModel(ResponseModel):
-    """
-    列表格式的响应基础模型
-    """
-
-    _data_list: Optional[Union[ModelPrivateAttr, list]] = ModelPrivateAttr(default_factory=list)
-
-    def add_data(self):
-        """
-        当前模型下数据添加到列表中
-        Returns:
-
-        """
-        data = self.dict()
-        self._data_list.append(data)
-        for attr in data.keys():
-            self.__setattr__(attr, None)
-
-    def to_list(self):
-        """
-        返回列表响应数据
-        Returns:
-
-        """
-        return self._data_list
+from typing import Optional, Union
+
+from pydantic.fields import ModelField, ModelPrivateAttr
+from pydantic.main import BaseModel
+
+
+class ResponseModel(BaseModel):
+    """
+    响应基础模型
+    """
+
+    def __new__(cls, *args, **kwargs):
+        for _field, value in cls.__fields__.items():
+            if not isinstance(value, ModelField):
+                continue
+            value.required = False
+
+        return super().__new__(cls, *args, **kwargs)
+
+
+class ListRespModel(ResponseModel):
+    """
+    列表格式的响应基础模型
+    """
+
+    _data_list: Optional[Union[ModelPrivateAttr, list]] = ModelPrivateAttr(default_factory=list)
+
+    def add_data(self):
+        """
+        当前模型下数据添加到列表中
+        Returns:
+
+        """
+        data = self.dict()
+        self._data_list.append(data)
+        for attr in data.keys():
+            self.__setattr__(attr, None)
+
+    def to_list(self):
+        """
+        返回列表响应数据
+        Returns:
+
+        """
+        return self._data_list

sanic_api/api/validators.py

@@ -1,76 +1,76 @@
-import inspect
-
-from sanic import Request
-
-from sanic_api.api import API
-from sanic_api.api.exception import ValidationInitError
-from sanic_api.enum import ParamEnum
-
-
-def _do_validation(param_enum: ParamEnum, api: API, data: dict):
-    if param_enum == ParamEnum.JSON:
-        req_data = data
-    elif param_enum in [ParamEnum.QUERY, param_enum.FORM]:
-        req_data = {}
-        for k, v in data.items():
-            if type(v) == list and len(v) == 1:
-                req_data[k] = v[0]
-            else:
-                req_data[k] = v
-    else:
-        raise ValidationInitError("未知的验证器类型")
-
-    api.validate_params(req_data, param_enum)
-
-
-def get_handler_param(handler):
-    """
-    获取参数处理器的json、form、query参数
-    Args:
-        handler:
-
-    Returns:
-
-    """
-    sig = inspect.signature(handler)
-    api_parameter = sig.parameters.get("api")
-    api_cls = api_parameter.annotation if api_parameter else None
-    return api_cls
-
-
-async def validators(request: Request):
-    """
-    校验请求参数中间件
-    Args:
-        request: 请求
-
-    Returns:
-
-    """
-    # 如果执行中间价直接就发生了异常则直接抛出
-    if hasattr(request.ctx, "exception"):
-        raise request.ctx.exception
-
-    _, handler, _ = request.app.router.get(
-        request.path,
-        request.method,
-        request.headers.getone("host", None),
-    )
-
-    api_cls = get_handler_param(handler)
-    if not api_cls:
-        return
-
-    api: API = api_cls()
-    if api.json_req_type and api.query_req_type:
-        raise ValidationInitError("不能同时存在json参数和form参数")
-
-    if api.json_req_type and request.json:
-        _do_validation(param_enum=ParamEnum.JSON, api=api, data=request.json)
-    elif api.form_req_type and request.form:
-        _do_validation(param_enum=ParamEnum.FORM, api=api, data=request.form)
-    if api.query_req_type and request.query_args:
-        _do_validation(param_enum=ParamEnum.QUERY, api=api, data=request.args)
-
-    request.match_info.update({"api": api})
-    request.ctx.api = api
+import inspect
+
+from sanic import Request
+
+from sanic_api.api import API
+from sanic_api.api.exception import ValidationInitError
+from sanic_api.enum import ParamEnum
+
+
+def _do_validation(param_enum: ParamEnum, api: API, data: dict):
+    if param_enum == ParamEnum.JSON:
+        req_data = data
+    elif param_enum in [ParamEnum.QUERY, param_enum.FORM]:
+        req_data = {}
+        for k, v in data.items():
+            if type(v) == list and len(v) == 1:
+                req_data[k] = v[0]
+            else:
+                req_data[k] = v
+    else:
+        raise ValidationInitError("未知的验证器类型")
+
+    api.validate_params(req_data, param_enum)
+
+
+def get_handler_param(handler):
+    """
+    获取参数处理器的json、form、query参数
+    Args:
+        handler:
+
+    Returns:
+
+    """
+    sig = inspect.signature(handler)
+    api_parameter = sig.parameters.get("api")
+    api_cls = api_parameter.annotation if api_parameter else None
+    return api_cls
+
+
+async def validators(request: Request):
+    """
+    校验请求参数中间件
+    Args:
+        request: 请求
+
+    Returns:
+
+    """
+    # 如果执行中间价直接就发生了异常则直接抛出
+    if hasattr(request.ctx, "exception"):
+        raise request.ctx.exception
+
+    _, handler, _ = request.app.router.get(
+        request.path,
+        request.method,
+        request.headers.getone("host", None),
+    )
+
+    api_cls = get_handler_param(handler)
+    if not api_cls:
+        return
+
+    api: API = api_cls()
+    if api.json_req_type and api.query_req_type:
+        raise ValidationInitError("不能同时存在json参数和form参数")
+
+    if api.json_req_type and request.json:
+        _do_validation(param_enum=ParamEnum.JSON, api=api, data=request.json)
+    elif api.form_req_type and request.form:
+        _do_validation(param_enum=ParamEnum.FORM, api=api, data=request.form)
+    if api.query_req_type and request.query_args:
+        _do_validation(param_enum=ParamEnum.QUERY, api=api, data=request.args)
+
+    request.match_info.update({"api": api})
+    request.ctx.api = api

sanic_api/config/__init__.py

@@ -1,2 +1,2 @@
-from .base import SettingsBase
-from .setting import DefaultSettings
+from .base import SettingsBase
+from .setting import DefaultSettings

sanic_api/config/base.py

@@ -1,110 +1,110 @@
-import json
-from configparser import ConfigParser
-from pathlib import Path
-from typing import Any, Dict, Tuple
-
-import yaml
-from pydantic import BaseSettings
-from pydantic.env_settings import SettingsSourceCallable
-
-from sanic_api.utils import getpath_by_root
-
-
-class CustomSettingsSource:
-    """
-    自定义的配置文件来源基类
-    """
-
-    def __init__(self, path: Path):
-        self.path = path
-
-    def __repr__(self) -> str:
-        return f"{self.__class__.__name__}(path={self.path!r})"
-
-
-class JsonSettingsSource(CustomSettingsSource):
-    """
-    json文件来源导入配置项
-    """
-
-    def __call__(self, settings: BaseSettings) -> Dict[str, Any]:
-        encoding = settings.__config__.env_file_encoding
-        return json.loads(self.path.read_text(encoding))
-
-
-class IniSettingsSource(CustomSettingsSource):
-    """
-    ini文件来源导入配置项
-    """
-
-    def __call__(self, settings: BaseSettings) -> Dict[str, Any]:
-        encoding = settings.__config__.env_file_encoding
-        parser = ConfigParser()
-        parser.read(self.path, encoding)
-        return getattr(parser, "_sections", {}).get("settings", {})
-
-
-class YamlSettingsSource(CustomSettingsSource):
-    """
-    Yaml文件来源导入配置项
-    """
-
-    def __call__(self, settings: BaseSettings) -> Dict[str, Any]:
-        encoding = settings.__config__.env_file_encoding
-        return yaml.safe_load(self.path.read_text(encoding))
-
-
-class SettingsBase(BaseSettings):
-    """
-    项目设置的基类
-    """
-
-    class Config:
-        root_config_dir = getpath_by_root("../configs")
-        env_file = root_config_dir / ".env"
-        env_file_encoding = "utf-8"
-        env_nested_delimiter = "__"
-
-        @classmethod
-        def customise_sources(
-            cls,
-            init_settings: SettingsSourceCallable,
-            env_settings: SettingsSourceCallable,
-            file_secret_settings: SettingsSourceCallable,
-        ) -> Tuple[SettingsSourceCallable, ...]:
-            """
-            自定义配置来源
-            Args:
-                init_settings: 初始化设置
-                env_settings:环境变量设置
-                file_secret_settings:加密文件设置
-
-            Returns:
-
-            """
-            # 默认的设置
-            default_settings = {
-                init_settings,
-                env_settings,
-                file_secret_settings,
-            }
-
-            # json 配置文件
-            json_file = cls.root_config_dir / "settings.json"
-            if json_file.exists():
-                json_settings_source = JsonSettingsSource(json_file)
-                default_settings.add(json_settings_source)
-
-            # ini配置文件
-            ini_file = cls.root_config_dir / "settings.ini"
-            if ini_file.exists():
-                ini_settings_source = IniSettingsSource(ini_file)
-                default_settings.add(ini_settings_source)
-
-            # yaml配置文件
-            yaml_file = cls.root_config_dir / "settings.yaml"
-            if yaml_file.exists():
-                yaml_settings_source = YamlSettingsSource(yaml_file)
-                default_settings.add(yaml_settings_source)
-
-            return tuple(default_settings)
+import json
+from configparser import ConfigParser
+from pathlib import Path
+from typing import Any, Dict, Tuple
+
+import yaml
+from pydantic import BaseSettings
+from pydantic.env_settings import SettingsSourceCallable
+
+from sanic_api.utils import getpath_by_root
+
+
+class CustomSettingsSource:
+    """
+    自定义的配置文件来源基类
+    """
+
+    def __init__(self, path: Path):
+        self.path = path
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}(path={self.path!r})"
+
+
+class JsonSettingsSource(CustomSettingsSource):
+    """
+    json文件来源导入配置项
+    """
+
+    def __call__(self, settings: BaseSettings) -> Dict[str, Any]:
+        encoding = settings.__config__.env_file_encoding
+        return json.loads(self.path.read_text(encoding))
+
+
+class IniSettingsSource(CustomSettingsSource):
+    """
+    ini文件来源导入配置项
+    """
+
+    def __call__(self, settings: BaseSettings) -> Dict[str, Any]:
+        encoding = settings.__config__.env_file_encoding
+        parser = ConfigParser()
+        parser.read(self.path, encoding)
+        return getattr(parser, "_sections", {}).get("settings", {})
+
+
+class YamlSettingsSource(CustomSettingsSource):
+    """
+    Yaml文件来源导入配置项
+    """
+
+    def __call__(self, settings: BaseSettings) -> Dict[str, Any]:
+        encoding = settings.__config__.env_file_encoding
+        return yaml.safe_load(self.path.read_text(encoding))
+
+
+class SettingsBase(BaseSettings):
+    """
+    项目设置的基类
+    """
+
+    class Config:
+        root_config_dir = getpath_by_root("./configs")
+        env_file = root_config_dir / ".env"
+        env_file_encoding = "utf-8"
+        env_nested_delimiter = "__"
+
+        @classmethod
+        def customise_sources(
+            cls,
+            init_settings: SettingsSourceCallable,
+            env_settings: SettingsSourceCallable,
+            file_secret_settings: SettingsSourceCallable,
+        ) -> Tuple[SettingsSourceCallable, ...]:
+            """
+            自定义配置来源
+            Args:
+                init_settings: 初始化设置
+                env_settings:环境变量设置
+                file_secret_settings:加密文件设置
+
+            Returns:
+
+            """
+            # 默认的设置
+            default_settings = {
+                init_settings,
+                env_settings,
+                file_secret_settings,
+            }
+
+            # json 配置文件
+            json_file = cls.root_config_dir / "settings.json"
+            if json_file.exists():
+                json_settings_source = JsonSettingsSource(json_file)
+                default_settings.add(json_settings_source)
+
+            # ini配置文件
+            ini_file = cls.root_config_dir / "settings.ini"
+            if ini_file.exists():
+                ini_settings_source = IniSettingsSource(ini_file)
+                default_settings.add(ini_settings_source)
+
+            # yaml配置文件
+            yaml_file = cls.root_config_dir / "settings.yaml"
+            if yaml_file.exists():
+                yaml_settings_source = YamlSettingsSource(yaml_file)
+                default_settings.add(yaml_settings_source)
+
+            return tuple(default_settings)

sanic_api/config/sanic.py

@@ -1,21 +1,19 @@
-from pydantic import Field
-
-from .base import SettingsBase
-
-
-class SanicConfig(SettingsBase):
-    """
-    sanic 框架本身的配置
-    """
-
-    # 是否开启OpenAPI规范文档生成
-    oas: bool = Field(default=True)
-
-    # 访问日志开关
-    access_log: bool = Field(default=True, alias="ACCESS_LOG", env="ACCESS_LOG")
-
-    # 后台日志记录器，开启可增加一些性能。见：https://sanic.dev/en/plugins/sanic-ext/logger.html
-    background_log: bool = Field(default=True, alias="LOGGING", env="LOGGING")
-
-    # OpenAPI规范文档的URL前缀
-    oas_url_prefix: str = Field(default="docs", alias="OAS_URL_PREFIX", env="OAS_URL_PREFIX")
+from pydantic import BaseModel, Field
+
+
+class SanicConfig(BaseModel):
+    """
+    sanic 框架本身的配置
+    """
+
+    # 是否开启OpenAPI规范文档生成
+    oas: bool = Field(default=True)
+
+    # 访问日志开关
+    access_log: bool = Field(default=True, alias="ACCESS_LOG", env="ACCESS_LOG")
+
+    # 后台日志记录器，开启可增加一些性能。见：https://sanic.dev/en/plugins/sanic-ext/logger.html
+    background_log: bool = Field(default=True, alias="LOGGING", env="LOGGING")
+
+    # OpenAPI规范文档的URL前缀
+    oas_url_prefix: str = Field(default="docs", alias="OAS_URL_PREFIX", env="OAS_URL_PREFIX")

sanic_api/config/sanic_api.py

@@ -1,13 +1,11 @@
-from pydantic import Field
-
-from .base import SettingsBase
-
-
-class SanicApiConfig(SettingsBase):
-    """
-    sanic_api 框架需要的配置
-    """
-
-    data_tmp: str = Field(title="响应中data类型字段的key", default="data")
-    code_tmp: str = Field(title="响应中data类型字段的key", default="code")
-    msg_tmp: str = Field(title="响应中data类型字段的key", default="msg")
+from pydantic import BaseModel, Field
+
+
+class SanicApiConfig(BaseModel):
+    """
+    sanic_api 框架需要的配置
+    """
+
+    data_tmp: str = Field(title="响应中data类型字段的key", default="data")
+    code_tmp: str = Field(title="响应中data类型字段的key", default="code")
+    msg_tmp: str = Field(title="响应中data类型字段的key", default="msg")

sanic_api/config/setting.py

@@ -1,30 +1,30 @@
-from pydantic import Field
-
-from sanic_api.config.base import SettingsBase
-from sanic_api.config.sanic import SanicConfig
-from sanic_api.config.sanic_api import SanicApiConfig
-from sanic_api.enum import RunModeEnum
-
-
-class DefaultSettings(SettingsBase):
-    """
-    配置类
-    """
-
-    # 主机
-    host: str = Field(default="127.0.0.1")
-
-    # 端口
-    port: int = Field(default=5798)
-
-    # 运行模式
-    mode: RunModeEnum = Field(default=RunModeEnum.DEV)
-
-    # 工作进程的数量
-    workers: int = Field(default=1)
-
-    # sanic 自身的配置
-    sanic: SanicConfig = Field(default_factory=SanicConfig)
-
-    # sanic_api 扩展自身需要的配置
-    sanic_api: SanicApiConfig = Field(default_factory=SanicApiConfig)
+from pydantic import Field
+
+from sanic_api.config.base import SettingsBase
+from sanic_api.config.sanic import SanicConfig
+from sanic_api.config.sanic_api import SanicApiConfig
+from sanic_api.enum import RunModeEnum
+
+
+class DefaultSettings(SettingsBase):
+    """
+    配置类
+    """
+
+    # 主机
+    host: str = Field(default="127.0.0.1")
+
+    # 端口
+    port: int = Field(default=5798)
+
+    # 运行模式
+    mode: RunModeEnum = Field(default=RunModeEnum.DEV)
+
+    # 工作进程的数量
+    workers: int = Field(default=1)
+
+    # sanic 自身的配置
+    sanic: SanicConfig = Field(default_factory=SanicConfig)
+
+    # sanic_api 扩展自身需要的配置
+    sanic_api: SanicApiConfig = Field(default_factory=SanicApiConfig)