aury-boot 0.0.4__py3-none-any.whl → 0.0.7__py3-none-any.whl

aury/boot/commands/templates/project/env.example.tpl

@@ -1,213 +0,0 @@
-# =============================================================================
-# {project_name} 环境变量配置
-# =============================================================================
-# 复制此文件为 .env 并根据实际情况修改
-# 所有配置项均有默认值，只需取消注释并修改需要覆盖的项
-
-# =============================================================================
-# 服务配置 (SERVICE_)
-# =============================================================================
-# 服务名称，用于日志目录区分
-SERVICE_NAME={project_name_snake}
-# 服务类型: api / worker
-# SERVICE_TYPE=api
-
-# =============================================================================
-# 服务器配置 (SERVER_)
-# =============================================================================
-# SERVER_HOST=127.0.0.1
-# SERVER_PORT=8000
-# 工作进程数（生产环境建议设为 CPU 核心数）
-# SERVER_WORKERS=1
-# 是否启用热重载（生产环境应设为 false）
-# SERVER_RELOAD=true
-
-# =============================================================================
-# 数据库配置 (DATABASE_)
-# =============================================================================
-# 数据库连接字符串（默认 SQLite）
-# DATABASE_URL=sqlite+aiosqlite:///./dev.db
-# PostgreSQL: postgresql+asyncpg://user:pass@localhost:5432/{project_name_snake}
-# MySQL: mysql+aiomysql://user:pass@localhost:3306/{project_name_snake}
-
-# 连接池大小
-# DATABASE_POOL_SIZE=5
-# 连接池最大溢出连接数
-# DATABASE_MAX_OVERFLOW=10
-# 连接回收时间（秒）
-# DATABASE_POOL_RECYCLE=3600
-# 获取连接超时时间（秒）
-# DATABASE_POOL_TIMEOUT=30
-# 是否在获取连接前 PING
-# DATABASE_POOL_PRE_PING=true
-# 是否输出 SQL 语句（调试用）
-# DATABASE_ECHO=false
-
-# =============================================================================
-# 缓存配置 (CACHE_)
-# =============================================================================
-# 缓存类型: memory / redis / memcached
-# CACHE_TYPE=memory
-# Redis/Memcached URL
-# CACHE_URL=redis://localhost:6379/0
-# 内存缓存最大大小
-# CACHE_MAX_SIZE=1000
-
-# =============================================================================
-# 日志配置 (LOG_)
-# =============================================================================
-# 日志级别: DEBUG / INFO / WARNING / ERROR / CRITICAL
-# LOG_LEVEL=INFO
-# 日志文件目录
-# LOG_DIR=logs
-# 日志文件轮转时间 (HH:MM 格式)
-# LOG_ROTATION_TIME=00:00
-# 日志文件轮转大小阈值
-# LOG_ROTATION_SIZE=100 MB
-# 日志文件保留天数
-# LOG_RETENTION_DAYS=7
-# 是否启用日志文件轮转
-# LOG_ENABLE_FILE_ROTATION=true
-# 是否输出日志到控制台
-# LOG_ENABLE_CONSOLE=true
-
-# =============================================================================
-# 健康检查配置 (HEALTH_CHECK_)
-# =============================================================================
-# 健康检查端点路径
-# HEALTH_CHECK_PATH=/api/health
-# 是否启用健康检查端点
-# HEALTH_CHECK_ENABLED=true
-
-# =============================================================================
-# 管理后台配置 (ADMIN_) - SQLAdmin Admin Console
-# =============================================================================
-# 是否启用管理后台（生产建议仅内网或配合反向代理）
-# ADMIN_ENABLED=false
-# 管理后台路径（默认 /api/admin-console，避免与业务 URL 冲突）
-# ADMIN_PATH=/api/admin-console
-#
-# SQLAdmin 通常要求同步 SQLAlchemy Engine：
-# - 若 DATABASE_URL 使用的是异步驱动（如 postgresql+asyncpg），建议显式提供同步 URL 覆盖
-# ADMIN_DATABASE_URL=postgresql+psycopg://user:pass@localhost:5432/{project_name_snake}
-#
-# 可选：显式指定项目侧模块（用于注册 views/auth）
-# ADMIN_VIEWS_MODULE={project_name_snake}.admin_console
-#
-# 认证（默认建议 basic / bearer；jwt/custom 通常需要自定义 backend）
-# ADMIN_AUTH_MODE=basic
-# ADMIN_AUTH_SECRET_KEY=CHANGE_ME_TO_A_RANDOM_SECRET
-#
-# basic：登录页用户名/密码
-# ADMIN_AUTH_BASIC_USERNAME=admin
-# ADMIN_AUTH_BASIC_PASSWORD=change_me
-#
-# bearer：token 白名单（也支持在登录页输入 token）
-# ADMIN_AUTH_BEARER_TOKENS=["change_me_token"]
-#
-# custom/jwt：自定义认证后端（动态导入）
-# ADMIN_AUTH_BACKEND=yourpkg.admin_auth:backend
-
-# =============================================================================
-# CORS 配置 (CORS_)
-# =============================================================================
-# 允许的 CORS 源（生产环境应设置具体域名）
-# CORS_ORIGINS=["*"]
-# 是否允许 CORS 凭据
-# CORS_ALLOW_CREDENTIALS=true
-# 允许的 CORS 方法
-# CORS_ALLOW_METHODS=["*"]
-# 允许的 CORS 头
-# CORS_ALLOW_HEADERS=["*"]
-
-# =============================================================================
-# 调度器配置 (SCHEDULER_)
-# =============================================================================
-# 是否在 API 服务中启用内嵌调度器
-# SCHEDULER_ENABLED=true
-# 定时任务模块列表（为空时自动发现 schedules 模块）
-# SCHEDULER_SCHEDULE_MODULES=[]
-
-# =============================================================================
-# 任务队列配置 (TASK_)
-# =============================================================================
-# 任务队列代理 URL（如 Redis 或 RabbitMQ）
-# TASK_BROKER_URL=redis://localhost:6379/1
-# 最大重试次数
-# TASK_MAX_RETRIES=3
-# 任务超时时间（秒）
-# TASK_TIMEOUT=3600
-
-# =============================================================================
-# 事件总线配置 (EVENT_)
-# =============================================================================
-# 事件总线代理 URL（如 RabbitMQ）
-# EVENT_BROKER_URL=amqp://guest:guest@localhost:5672/
-# 事件交换机名称
-# EVENT_EXCHANGE_NAME=aury.events
-
-# =============================================================================
-# 数据库迁移配置 (MIGRATION_)
-# =============================================================================
-# Alembic 配置文件路径
-# MIGRATION_CONFIG_PATH=alembic.ini
-# Alembic 迁移脚本目录
-# MIGRATION_SCRIPT_LOCATION=migrations
-# 是否自动创建迁移配置和目录
-# MIGRATION_AUTO_CREATE=true
-
-# =============================================================================
-# 对象存储配置 (STORAGE_) - 基于 aury-sdk-storage
-# =============================================================================
-# 是否启用存储组件
-# STORAGE_ENABLED=true
-# 存储类型: local / s3 / cos / oss
-# STORAGE_TYPE=local
-#
-# 本地存储（开发环境）
-# STORAGE_BASE_PATH=./storage
-#
-# S3/COS/OSS 通用配置
-# STORAGE_ACCESS_KEY_ID=AKIDxxxxx
-# STORAGE_ACCESS_KEY_SECRET=xxxxx
-# STORAGE_SESSION_TOKEN=
-# STORAGE_ENDPOINT=https://cos.ap-guangzhou.myqcloud.com
-# STORAGE_REGION=ap-guangzhou
-# STORAGE_BUCKET_NAME=my-bucket-1250000000
-# STORAGE_ADDRESSING_STYLE=virtual
-#
-# STS AssumeRole（可选，服务端自动刷新凭证）
-# STORAGE_ROLE_ARN=
-# STORAGE_ROLE_SESSION_NAME=aury-storage
-# STORAGE_EXTERNAL_ID=
-# STORAGE_STS_ENDPOINT=
-# STORAGE_STS_REGION=
-# STORAGE_STS_DURATION_SECONDS=3600
-
-# =============================================================================
-# RPC 客户端配置 (RPC_CLIENT_)
-# =============================================================================
-# 服务地址映射 {{service_name: url}}
-# RPC_CLIENT_SERVICES={{"user-service": "http://localhost:8001"}}
-# 默认超时时间（秒）
-# RPC_CLIENT_DEFAULT_TIMEOUT=30
-# 默认重试次数
-# RPC_CLIENT_DEFAULT_RETRY_TIMES=3
-# DNS 解析使用的协议
-# RPC_CLIENT_DNS_SCHEME=http
-# DNS 解析默认端口
-# RPC_CLIENT_DNS_PORT=80
-# 是否使用 DNS 回退（K8s/Docker Compose 自动 DNS）
-# RPC_CLIENT_USE_DNS_FALLBACK=true
-
-# =============================================================================
-# RPC 服务注册配置 (RPC_SERVICE_)
-# =============================================================================
-# 服务名称（用于注册）
-# RPC_SERVICE_NAME={project_name_snake}
-# 服务地址（用于注册）
-# RPC_SERVICE_URL=http://localhost:8000
-# 健康检查 URL（用于注册）
-# RPC_SERVICE_HEALTH_CHECK_URL=http://localhost:8000/api/health
-# 是否自动注册到服务注册中心
-# RPC_SERVICE_AUTO_REGISTER=false

aury/boot/infrastructure/events/bus.py

@@ -1,362 +0,0 @@
-"""事件总线实现。
-
-提供事件发布/订阅机制，支持本地和分布式模式。
-
-**架构说明**：
-本模块不依赖具体的 domain.events 实现，而是通过接口和类型变量来保持通用性。
-事件总线作为 infrastructure 组件只需要事件对象能够被序列化。
-"""
-
-from __future__ import annotations
-
-import asyncio
-from collections.abc import Callable
-from typing import Any
-
-from kombu import Connection, Exchange
-
-from aury.boot.common.logging import logger
-
-from .config import EventConfig
-from .consumer import EventConsumer
-from .models import Event, EventHandler, EventType
-
-
-class EventBus:
-    """事件总线（单例模式）。
-    
-    职责：
-    1. 管理事件订阅者
-    2. 分发事件（支持本地和分布式模式）
-    3. 异步事件处理
-    
-    模式：
-    - 本地模式：内存中的观察者模式（默认，无需消息队列）
-    - 分布式模式：使用 Kombu 消息队列（需要配置 broker_url）
-    
-    使用示例:
-        # 本地模式（内存）
-        event_bus = EventBus.get_instance()
-        
-        @event_bus.subscribe(MyEvent)
-        async def on_my_event(event: MyEvent):
-            print(f"Event {event.event_name} received!")
-        
-        await event_bus.publish(MyEvent(...))
-        
-        # 分布式模式（Kombu）
-        await event_bus.initialize(broker_url="redis://localhost:6379/0")
-        await event_bus.publish(MyEvent(...))  # 通过消息队列发布
-    """
-    
-    _instance: EventBus | None = None
-    
-    def __init__(self, settings: EventConfig | None = None) -> None:
-        """私有构造函数，使用 get_instance() 获取实例。
-        
-        Args:
-            settings: 事件总线配置（如果为 None 则使用默认配置）
-        """
-        if EventBus._instance is not None:
-            raise RuntimeError("EventBus 是单例类，请使用 get_instance() 获取实例")
-        
-        self._settings = settings or EventConfig()
-        self._handlers: dict[type[Event], list[EventHandler]] = {}
-        self._event_history: list[Event] = []
-        
-        # Kombu 相关
-        self._connection: Any = None  # Connection | None
-        self._exchange: Any = None  # Exchange | None
-        self._producer: Any = None  # Producer | None
-        self._consumer: Any = None  # EventConsumer | None
-        self._consumer_task: Any = None  # asyncio.Task | None
-        self._initialized: bool = False
-        self._use_distributed: bool = False
-        self._broker_url: str | None = None
-        
-        logger.debug("事件总线已创建（本地模式）")
-    
-    @classmethod
-    def get_instance(cls) -> EventBus:
-        """获取单例实例。"""
-        if cls._instance is None:
-            cls._instance = cls()
-        return cls._instance
-    
-    async def initialize(
-        self,
-        broker_url: str | None = None,
-        *,
-        exchange_name: str | None = None,
-        queue_prefix: str | None = None,
-    ) -> None:
-        """初始化分布式事件总线（使用 Kombu）。
-        
-        Args:
-            broker_url: 消息队列 URL（如 "redis://localhost:6379/0" 或 "amqp://guest:guest@localhost:5672//"）
-                        如果不指定则使用配置中的值
-            exchange_name: 交换机名称，如果不指定则使用配置中的值
-            queue_prefix: 队列名称前缀，如果不指定则使用配置中的值
-        """
-        if self._initialized:
-            logger.warning("事件总线已初始化，跳过")
-            return
-        
-        # 使用提供的参数或配置中的值
-        final_broker_url = broker_url or self._settings.broker_url
-        final_exchange_name = exchange_name or self._settings.exchange_name
-        final_queue_prefix = queue_prefix or self._settings.queue_prefix
-        
-        if not final_broker_url:
-            logger.info("未提供 broker_url，使用本地模式（内存）")
-            self._use_distributed = False
-            self._initialized = True
-            return
-        
-        try:
-            self._broker_url = final_broker_url
-            self._connection = Connection(final_broker_url)
-            self._exchange = Exchange(final_exchange_name, type="topic", durable=True)
-            
-            # 创建生产者
-            self._producer = self._connection.Producer(
-                exchange=self._exchange,
-                serializer="json",
-            )
-            
-            # 启动消费者（在后台任务中）
-            self._consumer = EventConsumer(
-                connection=self._connection,
-                exchange=self._exchange,
-                queue_prefix=final_queue_prefix,
-                handlers=self._handlers,
-            )
-            
-            # 在后台启动消费者
-            self._consumer_task = asyncio.create_task(self._start_consumer())
-            
-            self._use_distributed = True
-            self._initialized = True
-            logger.info(f"事件总线已初始化（分布式模式，broker: {broker_url}）")
-        except Exception as exc:
-            logger.error(f"事件总线初始化失败: {exc}")
-            raise
-    
-    async def _start_consumer(self) -> None:
-        """启动消费者（在后台运行）。"""
-        if self._consumer:
-            try:
-                # 在事件循环中运行消费者
-                loop = asyncio.get_event_loop()
-                await loop.run_in_executor(None, self._consumer.run)
-            except Exception as exc:
-                logger.error(f"事件消费者运行失败: {exc}")
-    
-    def subscribe(
-        self,
-        event_type: type[EventType],
-        handler: EventHandler | None = None,
-    ) -> EventHandler | Callable[[EventHandler], EventHandler]:
-        """订阅事件。
-        
-        可以作为装饰器使用：
-            @event_bus.subscribe(MyEvent)
-            async def handler(event):
-                pass
-        
-        或直接调用：
-            event_bus.subscribe(MyEvent, handler)
-        
-        Args:
-            event_type: 事件类型
-            handler: 事件处理器
-            
-        Returns:
-            EventHandler | Callable: 处理器或装饰器
-        """
-        def decorator(fn: EventHandler) -> EventHandler:
-            if event_type not in self._handlers:
-                self._handlers[event_type] = []
-            
-            self._handlers[event_type].append(fn)
-            logger.debug(f"订阅事件: {event_type.__name__} -> {fn.__name__}")
-            
-            # 如果使用分布式模式，需要注册队列
-            if self._use_distributed and self._consumer:
-                self._consumer.register_event_type(event_type)
-            
-            return fn
-        
-        if handler is not None:
-            return decorator(handler)
-        return decorator
-    
-    def unsubscribe(self, event_type: type[EventType], handler: EventHandler) -> None:
-        """取消订阅事件。
-        
-        Args:
-            event_type: 事件类型
-            handler: 事件处理器
-        """
-        if event_type in self._handlers:
-            try:
-                self._handlers[event_type].remove(handler)
-                logger.debug(f"取消订阅事件: {event_type.__name__} -> {handler.__name__}")
-            except ValueError:
-                pass
-    
-    async def publish(self, event: EventType) -> None:
-        """发布事件。
-        
-        Args:
-            event: 事件对象
-        """
-        logger.info(f"发布事件: {event}")
-        
-        # 记录事件历史
-        self._add_to_history(event)
-        
-        if self._use_distributed:
-            # 分布式模式：通过消息队列发布
-            await self._publish_distributed(event)
-        else:
-            # 本地模式：直接调用处理器
-            await self._publish_local(event)
-    
-    async def _publish_local(self, event: EventType) -> None:
-        """本地模式：直接调用处理器。"""
-        handlers = self._handlers.get(type(event), [])
-        if not handlers:
-            logger.debug(f"事件 {event.event_name} 没有订阅者")
-            return
-        
-        # 执行处理器
-        for handler in handlers:
-            try:
-                if asyncio.iscoroutinefunction(handler):
-                    await handler(event)
-                else:
-                    handler(event)
-                logger.debug(f"事件处理成功: {handler.__name__}")
-            except Exception as exc:
-                logger.error(f"事件处理失败: {handler.__name__}, 错误: {exc}")
-    
-    async def _publish_distributed(self, event: EventType) -> None:
-        """分布式模式：通过消息队列发布。"""
-        if not self._producer:
-            logger.warning("生产者未初始化，回退到本地模式")
-            await self._publish_local(event)
-            return
-        
-        try:
-            # 序列化事件（使用 model_dump 而不是 model_dump_json，因为 kombu 会自动序列化）
-            event_data = event.model_dump()
-            routing_key = event.event_name.lower().replace("event", "")
-            
-            # 发布到消息队列
-            self._producer.publish(
-                event_data,
-                routing_key=routing_key,
-                declare=[self._exchange],
-            )
-            logger.debug(f"事件已发布到消息队列: {routing_key}")
-        except Exception as exc:
-            logger.error(f"发布事件到消息队列失败: {exc}")
-            # 失败时回退到本地模式
-            await self._publish_local(event)
-    
-    async def publish_many(self, events: list[Event]) -> None:
-        """批量发布事件。
-        
-        Args:
-            events: 事件列表
-        """
-        for event in events:
-            await self.publish(event)
-    
-    def _add_to_history(self, event: Event) -> None:
-        """添加事件到历史记录。
-        
-        Args:
-            event: 事件对象
-        """
-        # 检查是否启用了历史记录
-        if not self._settings.enable_history:
-            return
-        
-        self._event_history.append(event)
-        
-        # 限制历史记录大小
-        if (
-            self._settings.max_history_size is not None
-            and len(self._event_history) > self._settings.max_history_size
-        ):
-            self._event_history = self._event_history[-self._settings.max_history_size:]
-    
-    def get_history(
-        self,
-        event_type: type[EventType] | None = None,
-        limit: int = 100,
-    ) -> list[Event]:
-        """获取事件历史。
-        
-        Args:
-            event_type: 事件类型（可选，不指定则返回所有事件）
-            limit: 返回数量限制
-            
-        Returns:
-            list[Event]: 事件列表
-        """
-        if event_type is None:
-            return self._event_history[-limit:]
-        
-        filtered = [e for e in self._event_history if isinstance(e, event_type)]
-        return filtered[-limit:]
-    
-    def clear_history(self) -> None:
-        """清空事件历史。"""
-        self._event_history.clear()
-        logger.debug("事件历史已清空")
-    
-    def clear_handlers(self) -> None:
-        """清空所有事件处理器。"""
-        self._handlers.clear()
-        logger.debug("事件处理器已清空")
-    
-    def get_handler_count(self, event_type: type[EventType] | None = None) -> int:
-        """获取处理器数量。
-        
-        Args:
-            event_type: 事件类型（可选）
-            
-        Returns:
-            int: 处理器数量
-        """
-        if event_type is None:
-            return sum(len(handlers) for handlers in self._handlers.values())
-        return len(self._handlers.get(event_type, []))
-    
-    async def cleanup(self) -> None:
-        """清理资源。"""
-        if self._consumer:
-            self._consumer.should_stop = True
-        
-        if self._connection:
-            self._connection.close()
-        
-        self._initialized = False
-        self._use_distributed = False
-        logger.info("事件总线已清理")
-    
-    def __repr__(self) -> str:
-        """字符串表示。"""
-        event_count = len(self._handlers)
-        history_size = len(self._event_history)
-        mode = "distributed" if self._use_distributed else "local"
-        return f"<EventBus mode={mode} events={event_count} history={history_size}>"
-
-
-__all__ = [
-    "EventBus",
-]
-

aury/boot/infrastructure/events/config.py

@@ -1,52 +0,0 @@
-"""事件总线配置。
-
-提供事件系统的配置管理。
-"""
-
-from __future__ import annotations
-
-from pydantic import Field
-from pydantic_settings import BaseSettings, SettingsConfigDict
-
-
-class EventConfig(BaseSettings):
-    """事件总线基础设施配置。
-    
-    Infrastructure 层直接使用的事件总线配置。
-    
-    环境变量前缀: EVENT_
-    示例: EVENT_BROKER_URL, EVENT_EXCHANGE_NAME, EVENT_QUEUE_PREFIX, EVENT_MAX_HISTORY_SIZE
-    """
-    
-    broker_url: str | None = Field(
-        default=None,
-        description="消息队列 URL（如 redis://localhost:6379/0 或 amqp://guest:guest@localhost:5672//），为空时使用本地模式"
-    )
-    exchange_name: str = Field(
-        default="events",
-        description="交换机名称"
-    )
-    queue_prefix: str = Field(
-        default="event",
-        description="队列名称前缀"
-    )
-    max_history_size: int | None = Field(
-        default=1000,
-        description="事件历史记录最大条数（None 表示不限制，生产环境建议设置或禁用历史记录）"
-    )
-    enable_history: bool = Field(
-        default=True,
-        description="是否启用事件历史记录（生产环境建议关闭以节省内存）"
-    )
-    
-    model_config = SettingsConfigDict(
-        env_prefix="EVENT_",
-        case_sensitive=False,
-    )
-
-
-__all__ = [
-    "EventConfig",
-]
-
-