sanic-api 0.4.1__tar.gz → 0.5.0__tar.gz

{sanic_api-0.4.1 → sanic_api-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sanic-api
-Version: 0.4.1
+Version: 0.5.0
 Summary: Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发
 Project-URL: homepage, https://github.com/x-haose/sanic-api
 Project-URL: repository, https://github.com/x-haose/sanic-api
@@ -19,6 +19,7 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{sanic_api-0.4.1 → sanic_api-0.5.0}/pyproject.toml

@@ -1,8 +1,10 @@
 [project]
 name = "sanic-api"
-version = "0.4.1"
+version = "0.5.0"
 keywords = ["Sanic", "异步", "Sanic扩展"]
 description = "Sanic 框架实用API工具集，拥有自动生成文档、参数校验、配置的导入、日志功能的优化等功能，更好的助力接口的开发"
+readme = "README.md"
+license = "MIT"
 authors = [
     { name = "昊色居士", email = "xhrtxh@gmail.com" }
 ]
@@ -17,14 +19,12 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Internet :: WWW/HTTP",
     "Topic :: Software Development :: Libraries :: Application Frameworks",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-license = "MIT"
-readme = "README.md"
-requires-python = ">= 3.10"
-
+requires-python = ">=3.10"
 dependencies = [
     # sanic
     "sanic>=24.12.0",
@@ -48,23 +48,19 @@ homepage = "https://github.com/x-haose/sanic-api"
 repository = "https://github.com/x-haose/sanic-api"
 documentation = "https://github.com/x-haose/sanic-api"
 
+[project.scripts]
+sanic-api = "sanic_api:main"
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.rye]
-managed = true
-dev-dependencies = [
-    "pre-commit>=4.0.1",
-    "twine>=6.0.1",
-]
+[tool.hatch.build.targets.sdist]
 include = [
-    "src/sanic_api/"
+    "src",
+    "examples",
 ]
 
-[tool.hatch.metadata]
-allow-direct-references = true
-
 [tool.hatch.build.targets.wheel]
 packages = ["src/sanic_api"]
 
@@ -141,14 +137,4 @@ fixable = ["ALL"]
 unfixable = []
 
 [tool.ruff.lint.per-file-ignores]
-"__init__.py" = ["F401"]
-
-
-[tool.rye.scripts]
-publish_testpypi = { cmd = "rye run twine upload -r testpypi dist/*" }
-publish_pypi = { cmd = "rye run twine upload dist/*" }
-sb = { cmd = "rye build --clean" }
-spt = { chain = ["sb", "publish_testpypi"] }
-sp = { chain = ["sb", "publish_pypi"] }
-check_i = { cmd = "rye run pre-commit install" }
-check = { cmd = "rye run pre-commit run --all-files" }
+"__init__.py" = ["F401"]

{sanic_api-0.4.1 → sanic_api-0.5.0}/src/sanic_api/__init__.py

@@ -1,3 +1,3 @@
 from sanic_api.logger.extension import LoggerExtend
 
-__version__ = "0.4.1"
+__version__ = "0.5.0"

{sanic_api-0.4.1 → sanic_api-0.5.0}/src/sanic_api/app.py

@@ -43,7 +43,7 @@ class BaseApp:
         # 默认启用sanic_ext里面的后台日志记录器
         motd_display = {"envornment": settings.envornment}
         config = {"access_log": settings.access_log, "motd_display": motd_display}
-        if settings.mode == RunModeEnum.DEBNUG:
+        if settings.mode == RunModeEnum.DEBUG:
             config.update({"auto_reload": settings.auto_reload, "workers": 1, "debug": True})
         else:
             config.update({"fast": True, "auto_reload": False})
@@ -158,6 +158,7 @@ class BaseApp:
 
         """
         # app.config.LOGGING = True
+        app.config.INSPECTOR = True
         app.config.FALLBACK_ERROR_FORMAT = "json"
         self._setup_cors(app)
 
@@ -185,7 +186,7 @@ class BaseApp:
 
         """
         cors = ",".join(self.settings.cors.origins)
-        if self.settings.mode == RunModeEnum.DEBNUG:
+        if self.settings.mode == RunModeEnum.DEBUG:
             app.config.CORS_SEND_WILDCARD = True
             app.config.CORS_SUPPORTS_CREDENTIALS = self.settings.cors.supports_credentials
             app.config.CORS_ORIGINS = cors or "*"
@@ -221,7 +222,11 @@ class BaseApp:
             retention=log_config.retention,
             compression=log_config.compression,
             loki_url=log_config.loki_url,
-            loki_labels={"application": self.name, "envornment": self.settings.envornment},
+            loki_labels={
+                "application": self.name,
+                "envornment": self.settings.env,
+            },
+            log_in_json=log_config.log_in_json,
         )
         Extend.register(log_ext)
 

{sanic_api-0.4.1 → sanic_api-0.5.0}/src/sanic_api/config/setting.py

@@ -9,7 +9,7 @@ class RunModeEnum(EnumBase):
     运行模式
     """
 
-    DEBNUG = EnumField("debug", desc="开发模式")
+    DEBUG = EnumField("debug", desc="开发模式")
     PRODUCTION = EnumField("prod", desc="生产模式")
 
 
@@ -36,6 +36,9 @@ class LoggerSettings(BaseModel):
     # loji的地址。如果存在，则会把日志推送给logki
     loki_url: HttpUrl | None = Field(default=None)
 
+    # 日志是否以json形式打印
+    log_in_json: bool | None = Field(default=None)
+
 
 class JsonRespSettings(BaseModel):
     """
@@ -83,11 +86,11 @@ class DefaultSettings(SettingsBase):
     port: int = Field(default=6969)
 
     # 运行模式
-    mode: RunModeEnum = Field(default=RunModeEnum.DEBNUG)
+    mode: RunModeEnum = Field(default=RunModeEnum.DEBUG)
 
     # 运行环境，仅作为环境标识。
     # 尽量不要使用这个字段去做逻辑判断。请使用mode去进行判断，因为测试环境、预发布环境、生产环境都应属于生产模式模式
-    envornment: str = Field(default="dev")
+    env: str = Field(default="dev")
 
     # 自动重载。生产模式强制关闭
     auto_reload: bool = Field(default=False)

{sanic_api-0.4.1 → sanic_api-0.5.0}/src/sanic_api/logger/extension.py

@@ -33,6 +33,7 @@ class LoggerExtend(Extension):
         compression: str | None = None,
         loki_url: str | None = None,
         loki_labels: dict[str, str] | None = None,
+        log_in_json: bool = False,
     ):
         """
         Args:
@@ -43,6 +44,7 @@ class LoggerExtend(Extension):
             compression: 日志文件压缩格式： "gz", "bz2", "xz", "lzma", "tar", "tar.gz", "tar.bz2", "tar.xz", "zip"
             loki_url: 推送loki的url
             loki_labels：loki推送时的标签
+            log_in_json: 日志是否以json形式打印
 
         """
         self.app = app
@@ -52,6 +54,7 @@ class LoggerExtend(Extension):
         self.compression = compression
         self.loki_url = loki_url
         self.loki_labels = loki_labels
+        self.log_in_json: bool = log_in_json
         self.setup()
 
     def startup(self, bootstrap) -> None:
@@ -84,9 +87,12 @@ class LoggerExtend(Extension):
         )
 
         # 基本的控制台输出
-        log_handlers = [
-            {"sink": sys.stdout, "format": log_format, "colorize": True},
-        ]
+        if self.log_in_json:
+            log_handlers = [{"sink": sys.stdout, "serialize": True}]
+        else:
+            log_handlers = [
+                {"sink": sys.stdout, "format": log_format, "colorize": True},
+            ]
 
         # 日志文件输出
         if self.log_file:
@@ -109,9 +115,9 @@ class LoggerExtend(Extension):
             loki_handler = LokiLoggerHandler(
                 url=self.loki_url,
                 labels=self.loki_labels or {},
-                labelKeys={},
+                label_keys={},
                 timeout=10,
-                defaultFormatter=LoguruFormatter(),
+                default_formatter=LoguruFormatter(),
             )
             log_handlers.append(
                 {

sanic_api-0.4.1/.pre-commit-config.yaml

@@ -1,18 +0,0 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-repos:
-  # bandit
-  - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.10
-    hooks:
-      - id: bandit
-        args: [ "-c", "pyproject.toml" ]
-        additional_dependencies: [ "bandit[toml]" ]
-
-  # ruff
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.6.9'
-    hooks:
-      - id: ruff
-        args: [ --fix, --exit-non-zero-on-fix, --show-fixes ]
-      - id: ruff-format

sanic_api-0.4.1/CHANGELOG.md

@@ -1,98 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-
-## [0.2.6] - 2023-07-05
-
-### Fixed
-
-- 修复配置类报错的问题
-
-### Changed
-
-- 升级sanic依赖版本为22.3
-- 增加`setuptools`依赖
-
-## [0.2.5] - 2023-04-09
-
-### Added
-
-- 支持捕获在中间件期间发生错误的异常情况
-- 增加配置类功能
-- 示例文件更新
-- 工具方法中新增自动蓝图方法
-
-### Changed
-
-- 默认的json dumps方法改为orjson
-- sanic 最低版本依赖更新至22.12
-- 优化API响应封装及响应文档的生成
-
-### Fixed
-
-- 修复openapi tag重复的问题
-- 修复日志级别判断不准问题
-
-## [0.2.4] - 2023-02-05
-
-### Fixed
-
-- 修复示例文件不生效的问题
-
-## [0.2.3] - 2023-02-03
-
-### Fixed
-
-- 修复无蓝图的api接口blueprint.ctx.desc报错的问题
-- 实现_missing_方法，修复枚举基类无法识别枚举值的问题
-
-### Changed
-
-- 请求接口无参数时访问日志中不打印 “args:”
-- 枚举基类字段类名称修改，避免重名
-
-### Added
-
-- API接口类支持自定义接口标签和接口描述
-- 添加types-ujson包
-- 自动生成的文档支持识别必须和可选参数
-- 枚举基类增加to_desc方法列出枚举的所有描述
-
-## [0.2.0] - 2023-01-19
-
-### Changed
-
-- api json序列化改为使用ujson
-- 移除部分3.10以上的语法
-
-### Added
-
-- 日志功能优化改进:
-    - 实现方式更加简洁优雅
-    - 可按照类型去区分
-    - 日志增加打印请求ID
-- json响应体格式设置为可配置的
-- 添加ujson包，移除orjson包
-- 读取蓝图上面的 blueprint.ctx.desc 属性来代替name设置中文tag名
-- 引入mypy、autoflake等代码检查工具
-- 添加配置文件基类
-
-## [0.1.1] - 2022-12-19
-
-### Changed
-
-- pip 首页的文件修改
-
-## [0.1.0] - 2022-12-19
-
-### Added
-
-- 接口参数校验
-- 接口文档生成
-- 日志使用`loguru`代替
-- 接口异常拦截
-- 接口响应统一化

sanic_api-0.4.1/COMMIT_GUIDE.MD

@@ -1,10 +0,0 @@
-- ✨ feat: 一个新特性
-- ➕ improvement: 对现有特性的提升
-- 🐛 fix: 修复Bug
-- 🛠 refactor: 代码重构，注意和特性、重构区分开
-- 📚 docs: 变更文档
-- 💅 style: 修改格式，不影响功能，例如空格、代码格式等
-- 📈 perf: 性能提升
-- 🔧 ci: 修改ci相关配置、脚本等
-- ⏪ revert: 回退版本
-- 🗯 chore: 杂务，不属于以上类型，例如run build、引入或更新软件包等

sanic_api-0.4.1/example/app.py

@@ -1,64 +0,0 @@
-from pydantic import BaseModel, Field
-from sanic import Blueprint, Sanic, json
-from sanic.log import logger
-
-from sanic_api.api import Request
-from sanic_api.app import BaseApp
-from sanic_api.config import DefaultSettings
-
-user_blueprint = Blueprint("user", "/user")
-
-
-class UserInfoModel(BaseModel):
-    user_id: int = Field(title="用户ID")
-
-
-class UserInfoResponse(BaseModel):
-    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="张三")
-    return request.json_resp(info, server_code="0000", server_msg="查询成功")
-
-
-@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__":
-    settings = DefaultSettings()
-    settings.port = 9999
-    settings.logger.loki_url = "http://127.0.0.1:23100/loki/api/v1/push"
-    App.run(settings)