aury-boot 0.0.13__tar.gz → 0.0.15__tar.gz

{aury_boot-0.0.13 → aury_boot-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aury-boot
-Version: 0.0.13
+Version: 0.0.15
 Summary: Aury Boot - 基于 FastAPI 生态的企业级 API 开发框架
 Requires-Python: >=3.13
 Requires-Dist: alembic>=1.17.2

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.13'
-__version_tuple__ = version_tuple = (0, 0, 13)
+__version__ = version = '0.0.15'
+__version_tuple__ = version_tuple = (0, 0, 15)
 
 __commit_id__ = commit_id = None

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/application/middleware/logging.py

@@ -17,7 +17,7 @@ from starlette.requests import Request
 from starlette.responses import Response
 
 from aury.boot.application.errors import global_exception_handler
-from aury.boot.common.logging import get_request_contexts, logger, set_trace_id
+from aury.boot.common.logging import logger, set_trace_id
 
 
 def log_request[T](func: Callable[..., T]) -> Callable[..., T]:
@@ -187,12 +187,6 @@ class RequestLoggingMiddleware(BaseHTTPMiddleware):
             )
             logger.log(log_level.upper(), response_log)
             
-            # 记录请求上下文（user_id, tenant_id 等用户注册的字段）
-            request_contexts = get_request_contexts()
-            if request_contexts:
-                ctx_str = " | ".join(f"{k}: {v}" for k, v in request_contexts.items())
-                logger.info(f"[REQUEST_CONTEXT] Trace-ID: {trace_id} | {ctx_str}")
-            
             # 写入 access 日志（简洁格式）
             logger.bind(access=True).info(
                 f"{request.method} {request.url.path} {status_code} {duration:.3f}s"
@@ -216,12 +210,6 @@ class RequestLoggingMiddleware(BaseHTTPMiddleware):
                 f"耗时: {duration:.3f}s | Trace-ID: {trace_id}"
             )
             
-            # 记录请求上下文（即使异常也要记录，便于追踪问题）
-            request_contexts = get_request_contexts()
-            if request_contexts:
-                ctx_str = " | ".join(f"{k}: {v}" for k, v in request_contexts.items())
-                logger.info(f"[REQUEST_CONTEXT] Trace-ID: {trace_id} | {ctx_str}")
-            
             # 使用全局异常处理器生成响应，而不是直接抛出异常
             # BaseHTTPMiddleware 中直接 raise 会绕过 FastAPI 的异常处理器
             response = await global_exception_handler(request, exc)

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/commands/templates/project/aury_docs/11-logging.md.tpl

@@ -19,44 +19,8 @@ logger.exception("异常信息")  # 自动记录堆栈
 2024-01-15 12:00:00 | INFO | app.service:create:42 | abc123 - 操作成功
 ```
 
-## 11.2 注入用户信息
 
-框架不内置用户系统，但支持注入自定义请求上下文：
-
-```python
-# app/auth/context.py
-from contextvars import ContextVar
-from aury.boot.common.logging import register_request_context
-
-_user_id: ContextVar[str] = ContextVar("user_id", default="")
-
-def set_user_id(uid: str) -> None:
-    _user_id.set(uid)
-
-# 启动时注册（只需一次）
-register_request_context("user_id", _user_id.get)
-```
-
-在认证中间件中设置（order < 100 以在日志中间件前执行）：
-
-```python
-class AuthMiddleware(Middleware):
-    order = 50  # 在日志中间件(order=100)之前执行
-    
-    async def dispatch(self, request, call_next):
-        user = await verify_token(request)
-        if user:
-            set_user_id(str(user.id))
-        return await call_next(request)
-```
-
-结果：
-```
-← GET /api/users | 状态: 200 | 耗时: 0.05s | Trace-ID: abc123
-[REQUEST_CONTEXT] Trace-ID: abc123 | user_id: 123
-```
-
-## 11.3 性能监控装饰器
+## 11.2 性能监控装饰器
 
 ```python
 from aury.boot.common.logging import log_performance, log_exceptions
@@ -70,7 +34,7 @@ async def risky_operation():
     ...
 ```
 
-## 11.4 HTTP 请求日志
+## 11.3 HTTP 请求日志
 
 框架内置 `RequestLoggingMiddleware` 自动记录：
 
@@ -85,7 +49,7 @@ async def risky_operation():
 慢请求: GET /api/reports | 耗时: 2.345s (超过1秒) | Trace-ID: abc123
 ```
 
-## 11.5 自定义日志文件
+## 11.4 自定义日志文件
 
 为特定业务创建独立的日志文件：
 
@@ -99,7 +63,7 @@ register_log_sink("payment", filter_key="payment")
 logger.bind(payment=True).info(f"支付成功 | 订单: {{order_id}}")
 ```
 
-## 11.6 异步任务链路追踪
+## 11.5 异步任务链路追踪
 
 跨进程任务需要手动传递 trace_id：
 
@@ -117,7 +81,7 @@ async def process_order(order_id: str, trace_id: str | None = None):
     logger.info(f"处理订单: {{order_id}}")  # 自动包含 trace_id
 ```
 
-## 11.7 服务上下文隔离
+## 11.6 服务上下文隔离
 
 日志自动按服务类型分离：
 

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/commands/templates/project/aury_docs/16-adapter.md.tpl

@@ -131,7 +131,7 @@ class WechatAdapter(HttpAdapter):
     async def _prepare_headers(self, headers: dict | None) -> dict:
         """添加认证头。"""
         headers = await super()._prepare_headers(headers)
-        headers["Authorization"] = f"Bearer {await self._get_access_token()}"
+        headers["Authorization"] = f"Bearer {{await self._get_access_token()}}"
         return headers
 
     @adapter_method("send_message")

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/commands/templates/project/aury_docs/99-cli.md.tpl

@@ -104,14 +104,79 @@ aury pkg remove redis
 
 常用环境变量：
 
-| 变量 | 说明 | 默认值 |
-|------|------|--------|
-| `ADMIN__ENABLED` | 是否启用管理后台 | `false` |
-| `ADMIN__PATH` | 管理后台路径 | `/api/admin-console` |
-| `ADMIN__DATABASE_URL` | 管理后台同步数据库 URL（可覆盖自动推导） | - |
-| `ADMIN__AUTH_MODE` | 认证模式（basic/bearer/none/custom/jwt） | `basic` |
-| `ADMIN__AUTH_SECRET_KEY` | session 签名密钥（生产必配） | - |
-| `ADMIN__AUTH_BASIC_USERNAME` | basic 用户名 | - |
-| `ADMIN__AUTH_BASIC_PASSWORD` | basic 密码 | - |
-| `ADMIN__AUTH_BEARER_TOKENS` | bearer token 白名单 | `[]` |
-| `ADMIN__AUTH_BACKEND` | 自定义认证后端导入路径（module:attr） | - |
+|| 变量 | 说明 | 默认值 |
+||------|------|--------|
+|| `ADMIN__ENABLED` | 是否启用管理后台 | `false` |
+|| `ADMIN__PATH` | 管理后台路径 | `/api/admin-console` |
+|| `ADMIN__DATABASE_URL` | 管理后台同步数据库 URL（可覆盖自动推导） | - |
+|| `ADMIN__AUTH_MODE` | 认证模式（basic/bearer/none/custom/jwt） | `basic` |
+|| `ADMIN__AUTH_SECRET_KEY` | session 签名密钥（生产必配） | - |
+|| `ADMIN__AUTH_BASIC_USERNAME` | basic 用户名 | - |
+|| `ADMIN__AUTH_BASIC_PASSWORD` | basic 密码 | - |
+|| `ADMIN__AUTH_BEARER_TOKENS` | bearer token 白名单 | `[]` |
+|| `ADMIN__AUTH_BACKEND` | 自定义认证后端导入路径（module:attr） | - |
+
+## 注册 CLI 与扩展命令
+
+### 内置 `aury` 命令如何注册
+
+Aury Boot 安装后会自动注册一个全局命令 `aury`（见框架自身的 `pyproject.toml`）：
+
+```toml
+[project.scripts]
+aury = "aury.boot.commands:main"
+```
+
+- `aury.boot.commands:main` 是 Typer 应用入口，内部通过 `app.add_typer(...)` 注册了 `init/generate/server/scheduler/worker/migrate/docker/docs/pkg` 等子命令。
+
+### 在你自己的项目里注册一个 CLI
+
+如果你希望在自己的服务里有一个独立的 CLI（例如 `{project_name_snake}`），并且复用 Aury Boot 的全部基础命令，可以这样做：
+
+1. 新建模块 `{package_name}/cli.py`：
+
+```python
+from typer import Typer
+from aury.boot.commands import register_commands
+
+# 创建项目自己的 CLI
+app = Typer(name="{project_name_snake}")
+
+# 继承 aury-boot 的所有基础命令
+register_commands(app)
+
+# 或者按需关闭某些命令，例如不暴露 docker 命令：
+# register_commands(app, include_docker=False)
+
+
+# 添加你自己的项目命令
+@app.command()
+async def hello(name: str = "world") -> None:
+    """示例：项目自定义命令。"""
+    print(f"Hello, {name} from {project_name_snake}!")
+```
+
+> 注意：这里的 `app` 是 Typer 应用实例，`register_commands` 会把所有内置的 `init/generate/server/...` 等命令挂到你自己的 CLI 下。
+
+2. 在你项目自己的 `pyproject.toml` 中注册脚本入口（**不是框架本身的 pyproject**）：
+
+```toml
+[project.scripts]
+{project_name_snake} = "{package_name}.cli:app"
+```
+
+3. 安装项目后，你就可以使用：
+
+```bash
+# 使用项目 CLI 运行 aury-boot 命令
+{project_name_snake} init
+{project_name_snake} generate crud user -i
+{project_name_snake} server dev
+
+# 调用你自定义的命令
+{project_name_snake} hello --name dev
+```
+
+这样：
+- 基础命令仍由 Aury Boot 维护和升级；
+- 你的项目可以在自己的命名空间下扩展命令，而不用直接修改框架的 `aury` 命令。

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/common/logging/__init__.py

@@ -5,7 +5,6 @@
 - 性能监控装饰器
 - 异常日志装饰器
 - 链路追踪 ID 支持
-- 请求上下文注入（user_id 等）
 - 自定义日志 sink 注册 API
 
 日志文件：
@@ -27,10 +26,8 @@ logger.remove()
 # 从子模块导入
 from aury.boot.common.logging.context import (
     ServiceContext,
-    get_request_contexts,
     get_service_context,
     get_trace_id,
-    register_request_context,
     set_service_context,
     set_trace_id,
 )
@@ -55,7 +52,6 @@ __all__ = [
     "ServiceContext",
     "format_exception_java_style",
     "get_class_logger",
-    "get_request_contexts",
     "get_service_context",
     "get_trace_id",
     "log_exception",
@@ -63,7 +59,6 @@ __all__ = [
     "log_performance",
     "logger",
     "register_log_sink",
-    "register_request_context",
     "set_service_context",
     "set_trace_id",
     "setup_intercept",

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/common/logging/context.py

@@ -1,11 +1,10 @@
 """日志上下文管理。
 
-提供链路追踪 ID、服务上下文、请求上下文的管理。
+提供链路追踪 ID、服务上下文的管理。
 """
 
 from __future__ import annotations
 
-from collections.abc import Callable
 from contextvars import ContextVar
 from enum import Enum
 import uuid
@@ -24,8 +23,6 @@ _service_context: ContextVar[ServiceContext] = ContextVar("service_context", def
 # 链路追踪 ID
 _trace_id_var: ContextVar[str] = ContextVar("trace_id", default="")
 
-# 请求上下文字段注册表（用户可注册自定义字段，如 user_id, tenant_id）
-_request_context_getters: dict[str, Callable[[], str]] = {}
 
 
 def get_service_context() -> ServiceContext:
@@ -75,58 +72,10 @@ def set_trace_id(trace_id: str) -> None:
     _trace_id_var.set(trace_id)
 
 
-def register_request_context(name: str, getter: Callable[[], str]) -> None:
-    """注册请求上下文字段。
-    
-    注册后，该字段会在每个请求结束时记录一次（与 trace_id 关联）。
-    适用于 user_id、tenant_id 等需要关联到请求但不需要每行日志都记录的信息。
-    
-    Args:
-        name: 字段名（如 "user_id", "tenant_id"）
-        getter: 获取当前值的函数（通常从 ContextVar 读取）
-    
-    使用示例:
-        from contextvars import ContextVar
-        from aury.boot.common.logging import register_request_context
-        
-        # 定义上下文变量
-        _user_id: ContextVar[str] = ContextVar("user_id", default="")
-        
-        def set_user_id(uid: str):
-            _user_id.set(uid)
-        
-        # 启动时注册（一次）
-        register_request_context("user_id", _user_id.get)
-        
-        # Auth 中间件中设置（每次请求）
-        set_user_id(str(user.id))
-    """
-    _request_context_getters[name] = getter
-
-
-def get_request_contexts() -> dict[str, str]:
-    """获取所有已注册的请求上下文当前值。
-    
-    Returns:
-        字段名到值的字典（仅包含非空值）
-    """
-    result = {}
-    for name, getter in _request_context_getters.items():
-        try:
-            value = getter()
-            if value:  # 只包含非空值
-                result[name] = value
-        except Exception:
-            pass  # 忽略获取失败的字段
-    return result
-
-
 __all__ = [
     "ServiceContext",
-    "get_request_contexts",
     "get_service_context",
     "get_trace_id",
-    "register_request_context",
     "set_service_context",
     "set_trace_id",
 ]

{aury_boot-0.0.13 → aury_boot-0.0.15}/aury/boot/infrastructure/database/manager.py

@@ -10,7 +10,7 @@ from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
 
 from sqlalchemy import text
-from sqlalchemy.exc import DisconnectionError, OperationalError
+from sqlalchemy.exc import DisconnectionError, OperationalError, SQLAlchemyError
 from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, async_sessionmaker, create_async_engine
 
 from aury.boot.common.logging import logger
@@ -237,10 +237,16 @@ class DatabaseManager:
         try:
             await self._check_session_connection(session)
             yield session
-        except Exception as exc:
+        except SQLAlchemyError as exc:
+            # 只捕获数据库相关异常
             await session.rollback()
             logger.exception(f"数据库会话异常: {exc}")
             raise
+        except Exception:
+            # 非数据库异常（如请求验证错误）：仍需回滚以确保事务一致性
+            # 但不记录为数据库异常，直接传播
+            await session.rollback()
+            raise
         finally:
             await session.close()