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

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

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

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

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

{aury_boot-0.0.11 → aury_boot-0.0.13}/aury/boot/commands/docs.py

@@ -83,8 +83,15 @@ def _detect_project_info(project_dir: Path) -> dict[str, str]:
 def _render_template(template_name: str, context: dict[str, str]) -> str:
     """渲染模板。
     
-    支持根目录模板和 aury_docs/ 子目录模板。
+    支持根目录模板、aury_docs/ 子目录模板，且 .env.example 复用 init.py 的 env_templates 逻辑。
     """
+    # 特殊处理 env.example.tpl（通过 init.py 的 env_templates 目录合并生成）
+    if template_name == "env.example.tpl":
+        from .init import _read_env_template  # 复用初始化脚手架的 env 生成逻辑
+
+        content = _read_env_template()
+        return content.format(**context)
+
     # 先在根目录找
     template_path = TEMPLATES_DIR / template_name
     if not template_path.exists():
@@ -173,6 +180,60 @@ def _get_aury_docs_templates() -> list[Path]:
     return sorted(AURY_DOCS_TPL_DIR.glob("*.md.tpl"))
 
 
+def generate_aury_docs(
+    *,
+    project_dir: Path,
+    context: dict[str, str],
+    force: bool = False,
+    dry_run: bool = False,
+    quiet: bool = False,
+) -> int:
+    """核心实现：根据 aury_docs 模板生成开发文档包。
+
+    被 `aury docs dev` 和 `aury init` 复用，确保生成逻辑一致。
+    返回成功生成的文档数量。
+    """
+    if not quiet:
+        console.print()
+
+    # 确保输出目录存在
+    aury_docs_dir = project_dir / "aury_docs"
+    if not dry_run:
+        aury_docs_dir.mkdir(parents=True, exist_ok=True)
+
+    success_count = 0
+    for tpl_path in _get_aury_docs_templates():
+        try:
+            output_name = tpl_path.stem  # 去掉 .tpl 后缀，保留 .md
+            output_path = aury_docs_dir / output_name
+            content = tpl_path.read_text(encoding="utf-8")
+            content = content.format(**context)
+            # init 直接写文件，不走 rich 提示
+            if quiet:
+                if output_path.exists() and not force and not dry_run:
+                    continue
+                if not dry_run:
+                    output_path.write_text(content, encoding="utf-8")
+                success_count += 1
+            else:
+                if _write_file(output_path, content, force=force, dry_run=dry_run):
+                    success_count += 1
+        except Exception as e:
+            if not quiet:
+                console.print(f"[red]❌ 生成 {tpl_path.name} 失败: {e}[/red]")
+            # 静默模式下（init）忽略单个文档失败
+            continue
+
+    if not quiet:
+        console.print()
+        if dry_run:
+            console.print(f"[dim]🔍 预览模式完成，将生成 {success_count} 个文档到 aury_docs/ 目录[/dim]")
+        else:
+            console.print(f"[green]✨ 完成！成功生成 {success_count} 个文档到 aury_docs/ 目录[/green]")
+
+    return success_count
+
+
 @app.command(name="dev")
 def generate_dev_doc(
     project_dir: Path = typer.Argument(
@@ -198,32 +259,16 @@ def generate_dev_doc(
 ) -> None:
     """生成/更新 aury_docs/ 开发文档包。"""
     context = _detect_project_info(project_dir)
-    
+
     console.print(f"[cyan]📚 检测到项目: {context['project_name']}[/cyan]")
-    console.print()
-    
-    # 确保输出目录存在
-    aury_docs_dir = project_dir / "aury_docs"
-    if not dry_run:
-        aury_docs_dir.mkdir(parents=True, exist_ok=True)
-    
-    success_count = 0
-    for tpl_path in _get_aury_docs_templates():
-        try:
-            output_name = tpl_path.stem  # 去掉 .tpl 后缀，保留 .md
-            output_path = aury_docs_dir / output_name
-            content = tpl_path.read_text(encoding="utf-8")
-            content = content.format(**context)
-            if _write_file(output_path, content, force=force, dry_run=dry_run):
-                success_count += 1
-        except Exception as e:
-            console.print(f"[red]❌ 生成 {tpl_path.name} 失败: {e}[/red]")
-    
-    console.print()
-    if dry_run:
-        console.print(f"[dim]🔍 预览模式完成，将生成 {success_count} 个文档到 aury_docs/ 目录[/dim]")
-    else:
-        console.print(f"[green]✨ 完成！成功生成 {success_count} 个文档到 aury_docs/ 目录[/green]")
+
+    generate_aury_docs(
+        project_dir=project_dir,
+        context=context,
+        force=force,
+        dry_run=dry_run,
+        quiet=False,
+    )
 
 
 @app.command(name="cli")

{aury_boot-0.0.11 → aury_boot-0.0.13}/aury/boot/commands/init.py

@@ -836,25 +836,17 @@ def init(
     else:
         console.print("  [dim]ℹ️  migrations/ 目录已存在，跳过[/dim]")
 
-    # 5. 生成开发文档 (aury_docs/) - 动态扫描模板目录
+    # 5. 生成开发文档 (aury_docs/) - 复用 docs.generate_aury_docs
     console.print("\n[bold]📚 生成开发文档...[/bold]")
-    aury_docs_tpl_dir = TEMPLATES_DIR / "aury_docs"
-    aury_docs_dir = base_path / "aury_docs"
-    aury_docs_dir.mkdir(parents=True, exist_ok=True)
-    docs_count = 0
-    if aury_docs_tpl_dir.exists():
-        for tpl_path in sorted(aury_docs_tpl_dir.glob("*.md.tpl")):
-            output_name = tpl_path.stem  # 去掉 .tpl 后缀，保留 .md
-            output_path = aury_docs_dir / output_name
-            if output_path.exists() and not force:
-                continue
-            try:
-                content = tpl_path.read_text(encoding="utf-8")
-                content = content.format(**template_vars)
-                output_path.write_text(content, encoding="utf-8")
-                docs_count += 1
-            except Exception:
-                pass
+    from .docs import generate_aury_docs
+
+    docs_count = generate_aury_docs(
+        project_dir=base_path,
+        context=template_vars,
+        force=force,
+        dry_run=False,
+        quiet=True,
+    )
     console.print(f"  [green]✅ 已生成 {docs_count} 个文档到 aury_docs/[/green]")
 
     # 6. 生成 Docker 配置

{aury_boot-0.0.11 → aury_boot-0.0.13}/aury/boot/commands/templates/project/aury_docs/10-storage.md.tpl

@@ -11,17 +11,20 @@ pip install "aury-sdk-storage[aws]"
 
 ## 10.2 基本用法（StorageManager）
 
-`StorageManager` 支持**命名多实例**，可以同时管理多个存储后端。
+`StorageManager` 支持**命名多实例**，内部使用 `aury-sdk-storage` 提供的 `StorageFactory.from_config()` 智能选择后端（COS 原生 / S3 兼容等），对上层暴露统一接口。
 
 ```python
 from aury.boot.infrastructure.storage import (
-    StorageManager, StorageConfig, StorageBackend, StorageFile,
+    StorageManager,
+    StorageConfig,
+    StorageBackend,
+    StorageFile,
 )
 
 # 默认实例
 storage = StorageManager.get_instance()
 await storage.initialize(StorageConfig(
-    backend=StorageBackend.COS,
+    backend=StorageBackend.COS,  # 自动选择 COS 原生 SDK 或 S3 兼容模式
     bucket_name="my-bucket-1250000000",
     region="ap-guangzhou",
     endpoint="https://cos.ap-guangzhou.myqcloud.com",
@@ -45,6 +48,12 @@ url = await storage.upload_file(
     )
 )
 
+# 批量上传
+urls = await storage.upload_files([
+    StorageFile(object_name="img/1.jpg", data=b"..."),
+    StorageFile(object_name="img/2.jpg", data=b"..."),
+])
+
 # 下载文件
 content = await storage.download_file("user/123/avatar.png")
 
@@ -58,7 +67,38 @@ exists = await storage.file_exists("user/123/avatar.png")
 await storage.delete_file("user/123/avatar.png")
 ```
 
-## 10.3 STS 临时凭证（前端直传）
+## 10.3 高级用法：直接使用 SDKStorageFactory / StorageType
+
+对于需要更精细控制后端类型（如在脚手架或基础设施层扩展存储实现）的场景，可以直接使用 SDK 导出的类型：
+
+```python
+from aury.boot.infrastructure.storage import (
+    COSStorage,
+    LocalStorage,
+    S3Storage,
+    SDKStorageFactory,  # SDK 工厂（基于 StorageType 枚举）
+    StorageConfig,
+    StorageFile,
+    StorageType,
+)
+
+# 使用 StorageType 创建后端
+config = StorageConfig(
+    backend=StorageType.COS,
+    bucket_name="my-bucket-1250000000",
+    region="ap-guangzhou",
+)
+
+backend = SDKStorageFactory.from_config(config)
+result = await backend.upload_file(
+    StorageFile(object_name="dev/test.txt", data=b"hello"),
+)
+print(result.url)
+```
+
+> 一般业务代码直接通过 `StorageManager` 即可，只有在需要自定义装配流程或编写基础设施扩展时才需要直接使用 `SDKStorageFactory` / `StorageType` / `COSStorage` 等类型。
+
+## 10.4 STS 临时凭证（前端直传）
 
 ```python
 from aury.sdk.storage.sts import (
@@ -95,11 +135,14 @@ return {{
 }}
 ```
 
-## 10.4 本地存储（开发测试）
+## 10.5 本地存储（开发测试）
 
 ```python
 from aury.boot.infrastructure.storage import (
-    StorageManager, StorageConfig, StorageBackend, StorageFile,
+    StorageManager,
+    StorageConfig,
+    StorageBackend,
+    StorageFile,
 )
 
 storage = StorageManager.get_instance()

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

@@ -33,7 +33,7 @@ class PaymentAdapter(BaseAdapter):
         # 真实调用第三方 API
         response = await self.http_client.post(
             "https://api.payment.com/orders",
-            json={"amount": amount, "order_id": order_id},
+            json={{"amount": amount, "order_id": order_id}},
         )
         return response.json()
 
@@ -41,29 +41,29 @@ class PaymentAdapter(BaseAdapter):
     async def create_order_mock(self, amount: int, order_id: str) -> dict:
         """创建支付订单（Mock 实现）。"""
         if amount > 100000:
-            return {"success": False, "error": "金额超限"}
-        return {
+            return {{"success": False, "error": "金额超限"}}
+        return {{
             "success": True,
-            "transaction_id": f"mock_tx_{order_id}",
+            "transaction_id": f"mock_tx_{{order_id}}",
             "amount": amount,
-        }
+        }}
 
     @adapter_method("query_order")
     async def query_order(self, transaction_id: str) -> dict:
         """查询支付订单。"""
         response = await self.http_client.get(
-            f"https://api.payment.com/orders/{transaction_id}"
+            f"https://api.payment.com/orders/{{transaction_id}}"
         )
         return response.json()
 
     @query_order.mock
     async def query_order_mock(self, transaction_id: str) -> dict:
         """查询支付订单（Mock）。"""
-        return {
+        return {{
             "transaction_id": transaction_id,
             "status": "paid",
             "mock": True,
-        }
+        }}
 ```
 
 ## 16.3 Adapter 配置
@@ -78,7 +78,7 @@ THIRD_PARTY__GATEWAY_MODE=mock
 
 # 方法级模式覆盖（JSON 格式）
 # 例如：query 方法使用 real，其他方法使用全局配置
-THIRD_PARTY__METHOD_MODES={"query_order": "real"}
+THIRD_PARTY__METHOD_MODES={{"query_order": "real"}}
 
 # Mock 策略：decorator（装饰器）/ auto（自动生成）
 THIRD_PARTY__MOCK_STRATEGY=decorator
@@ -98,10 +98,10 @@ settings = AdapterSettings()
 # 方式 2：代码显式配置
 settings = AdapterSettings(
     mode="mock",
-    method_modes={
+    method_modes={{
         "query_order": "real",  # query_order 使用真实调用
         "create_order": "mock", # create_order 使用 Mock
-    },
+    }},
     debug=True,
 )
 
@@ -140,13 +140,13 @@ class WechatAdapter(HttpAdapter):
         return await self._request(
             "POST",
             "/cgi-bin/message/send",
-            json={"touser": openid, "content": content},
+            json={{"touser": openid, "content": content}},
         )
 
     @send_message.mock
     async def send_message_mock(self, openid: str, content: str) -> dict:
         """发送消息（Mock）。"""
-        return {"errcode": 0, "errmsg": "ok", "mock": True}
+        return {{"errcode": 0, "errmsg": "ok", "mock": True}}
 ```
 
 ## 16.5 方法级模式覆盖
@@ -156,13 +156,13 @@ class WechatAdapter(HttpAdapter):
 ```python
 settings = AdapterSettings(
     mode="mock",  # 默认 Mock
-    method_modes={
+    method_modes={{
         "query_order": "real",      # 查询走真实接口
         "create_order": "mock",     # 创建走 Mock
         "refund": "disabled",       # 退款禁用
-    },
+    }},
+    debug=True,
 )
-
 adapter = PaymentAdapter("payment", settings)
 
 # query_order 会调用真实 API
@@ -237,19 +237,19 @@ class PaymentAdapter(HttpAdapter):
         self, method: str, args: tuple, kwargs: dict
     ) -> None:
         """调用前钩子。"""
-        logger.info(f"调用 {method}，参数: {args}")
+        logger.info(f"调用 {{method}}，参数: {{args}}")
 
     async def _on_after_call(
         self, method: str, args: tuple, kwargs: dict, result: Any
     ) -> None:
         """调用后钩子。"""
-        logger.info(f"{method} 返回: {result}")
+        logger.info(f"{{method}} 返回: {{result}}")
 
     async def _on_call_error(
         self, method: str, args: tuple, kwargs: dict, error: Exception
     ) -> None:
         """调用异常钩子。"""
-        logger.error(f"{method} 异常: {error}")
+        logger.error(f"{{method}} 异常: {{error}}")
         # 可以在这里发送告警
 ```
 
@@ -272,16 +272,16 @@ class CompositePaymentAdapter(BaseAdapter):
         elif channel == "wechat":
             return await self.wechat.create_order(amount, order_id)
         else:
-            raise ValueError(f"不支持的支付渠道: {channel}")
+            raise ValueError(f"不支持的支付渠道: {{channel}}")
 
     @pay.mock
     async def pay_mock(self, channel: str, amount: int, order_id: str) -> dict:
         """统一 Mock 实现。"""
-        return {
+        return {{
             "success": True,
             "channel": channel,
-            "transaction_id": f"mock_{channel}_{order_id}",
-        }
+            "transaction_id": f"mock_{{channel}}_{{order_id}}",
+        }}
 ```
 
 ## 16.8 异常处理
@@ -303,9 +303,9 @@ except AdapterTimeoutError:
     logger.error("支付适配器超时")
     # 重试或告警
 except AdapterValidationError as e:
-    logger.error(f"参数校验失败: {e}")
+    logger.error(f"参数校验失败: {{e}}")
 except AdapterError as e:
-    logger.error(f"适配器错误: {e}")
+    logger.error(f"适配器错误: {{e}}")
 ```
 
 ## 16.9 最佳实践
@@ -329,16 +329,16 @@ async def create_order_mock(self, amount: int, order_id: str) -> dict:
     """Mock 应模拟各种场景。"""
     # 模拟金额校验
     if amount <= 0:
-        return {"success": False, "error": "金额必须大于0"}
+        return {{"success": False, "error": "金额必须大于0"}}
     if amount > 100000:
-        return {"success": False, "error": "金额超限"}
+        return {{"success": False, "error": "金额超限"}}
 
     # 模拟偶发失败（可选）
     import random
     if random.random() < 0.01:
-        return {"success": False, "error": "系统繁忙"}
+        return {{"success": False, "error": "系统繁忙"}}
 
-    return {"success": True, "transaction_id": f"mock_{order_id}"}
+    return {{"success": True, "transaction_id": f"mock_{{order_id}}"}}
 ```
 
 ### 3. 环境配置建议
@@ -350,7 +350,7 @@ THIRD_PARTY__DEBUG=true
 
 # 测试环境 (.env.testing)
 THIRD_PARTY__GATEWAY_MODE=mock
-THIRD_PARTY__METHOD_MODES={"query": "sandbox"}
+THIRD_PARTY__METHOD_MODES={{"query": "sandbox"}}
 
 # 生产环境 (.env.production)
 THIRD_PARTY__GATEWAY_MODE=real
@@ -381,11 +381,11 @@ class OrderService(BaseService):
     async def create_order(self, user_id: str, amount: int) -> Order:
         """创建订单并发起支付。"""
         # 1. 创建订单记录
-        order = await self.order_repo.create({
+        order = await self.order_repo.create({{
             "user_id": user_id,
             "amount": amount,
             "status": "pending",
-        })
+        }})
 
         # 2. 调用支付适配器
         pay_result = await self.payment.create_order(amount, str(order.id))
@@ -394,10 +394,10 @@ class OrderService(BaseService):
             raise PaymentError(pay_result["error"])
 
         # 3. 更新订单状态
-        await self.order_repo.update(order, {
+        await self.order_repo.update(order, {{
             "transaction_id": pay_result["transaction_id"],
             "status": "paid",
-        })
+        }})
 
         return order
 ```