toms-fast 0.2.1__py3-none-any.whl

tomskit/cli/templates/fastapi.py

@@ -0,0 +1,400 @@
+"""
+FastAPI 模板模块
+包含所有 FastAPI 相关的文件模板
+"""
+
+from typing import Callable
+
+
+def get_fastapi_templates(project_name: str) -> dict[str, Callable[[], str]]:
+    """获取 FastAPI 模板"""
+    return {
+        "main_py": lambda: f'''"""
+{project_name} 应用入口
+"""
+
+import os
+from pathlib import Path
+from dotenv import load_dotenv
+
+from tomskit.server import FastApp
+from app.config import setup_config
+from app.middleware import setup_middleware
+from app.controllers.users.module import init_user_module
+from extensions import init_all_extensions
+
+
+# 加载环境变量
+env_path = Path(__file__).parent / ".env"
+if env_path.exists():
+    load_dotenv(env_path)
+else:
+    print("⚠️  警告: .env 文件不存在，请从 .env.example 复制并配置")
+
+
+# 创建应用实例
+app = FastApp(
+    title="{project_name}",
+    description="基于 toms-fast 的 FastAPI 应用",
+    version="0.1.0"
+)
+
+# 设置应用根路径
+app.set_app_root_path(__file__)
+
+# 初始化配置
+setup_config(app)
+
+# 配置中间件
+setup_middleware(app)
+
+# 统一初始化所有扩展（logger, database, redis 等）
+init_all_extensions(app)
+
+# 注册控制器
+init_user_module(app)
+
+# 健康检查端点
+@app.get("/health")
+async def health_check():
+    """健康检查"""
+    return {{"status": "ok", "service": "{project_name}"}}
+
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(
+        "main:app",
+        host="0.0.0.0",
+        port=8000,
+        reload=True
+    )
+''',
+        
+        "app_init_py": lambda: "",
+        
+        "config_py": lambda: '''"""
+应用配置管理
+"""
+
+from tomskit.server import FastApp
+
+
+def setup_config(app: FastApp):
+    """设置应用配置"""
+    # 从环境变量加载配置
+    # 配置会自动从环境变量读取（通过 pydantic-settings）
+    pass
+''',
+        
+        "middleware_init_py": lambda: '''"""
+中间件统一注册
+"""
+
+from tomskit.server import FastApp
+
+from . import request_id, resource_cleanup
+# 在这里导入更多中间件模块
+# from . import cors, auth, rate_limit
+
+
+def setup_middleware(app: FastApp):
+    """
+    统一注册所有中间件
+    
+    中间件执行顺序（从外到内，按注册顺序）：
+    1. request_id - 请求 ID 追踪（最外层）
+    2. resource_cleanup - 资源清理（最内层）
+    
+    注意：中间件的注册顺序很重要，后注册的中间件会更靠近应用核心
+    """
+    # 按顺序注册中间件
+    request_id.setup(app)
+    resource_cleanup.setup(app)
+    
+    # 注册更多中间件
+    # cors.setup(app)
+    # auth.setup(app)
+    # rate_limit.setup(app)
+''',
+        
+        "middleware_request_id_py": lambda: '''"""
+请求 ID 追踪中间件
+"""
+
+from tomskit.server import FastApp, RequestIDMiddleware
+
+
+def setup(app: FastApp):
+    """
+    配置请求 ID 追踪中间件
+    
+    功能：
+    - 自动处理 X-Request-ID 请求头
+    - 如果请求中没有 X-Request-ID，自动生成 UUID
+    - 将请求 ID 设置到日志上下文中，用于分布式追踪
+    - 在响应头中添加 X-Request-ID
+    """
+    app.add_middleware(RequestIDMiddleware)
+''',
+        
+        "middleware_resource_cleanup_py": lambda: '''"""
+资源清理中间件
+"""
+
+from tomskit.server import FastApp, ResourceCleanupMiddleware
+from tomskit.sqlalchemy.database import DatabaseCleanupStrategy
+from tomskit.redis.redis_pool import RedisCleanupStrategy
+
+
+def setup(app: FastApp):
+    """
+    配置资源清理中间件
+    
+    功能：
+    - 自动清理数据库会话，防止资源泄漏
+    - 自动清理 Redis 连接，防止资源泄漏
+    - 在请求完成后自动执行清理，即使发生异常也会清理
+    """
+    app.add_middleware(
+        ResourceCleanupMiddleware,
+        strategies=[
+            DatabaseCleanupStrategy(),
+            RedisCleanupStrategy(),
+        ]
+    )
+''',
+        
+        "controllers_init_py": lambda: '''"""
+Controllers 目录
+"""
+
+''',
+        
+        "users_init_py": lambda: '''"""
+用户控制器模块
+"""
+
+from .module import init_user_module
+
+__all__ = ["init_user_module"]
+''',
+        
+        "users_resources_py": lambda: '''"""
+用户资源 API
+"""
+
+from fastapi import Request, HTTPException
+
+from tomskit.server import Resource, api_doc, register_resource
+from .schemas import UserResponse, UserCreate, UserUpdate
+
+
+@register_resource(module="users", path="/users", tags=["用户管理"])
+class UserResource(Resource):
+    """用户资源"""
+    
+    @api_doc(
+        summary="获取用户列表",
+        description="获取所有用户列表，支持分页",
+        response_model=list[UserResponse],
+        responses={{
+            200: "成功",
+            500: "服务器错误"
+        }}
+    )
+    async def get(self, request: Request):
+        """获取用户列表"""
+        # TODO: 从数据库获取用户列表
+        return [
+            {{"id": 1, "name": "Alice", "email": "alice@example.com"}},
+            {{"id": 2, "name": "Bob", "email": "bob@example.com"}}
+        ]
+    
+    @api_doc(
+        summary="创建用户",
+        description="创建新用户",
+        response_model=UserResponse,
+        status_code=201,
+        responses={{
+            201: "用户创建成功",
+            400: "请求参数错误",
+            409: "用户已存在"
+        }}
+    )
+    async def post(self, request: Request):
+        """创建用户"""
+        data = await request.json()
+        # TODO: 验证数据并创建用户
+        return {{
+            "id": 3,
+            "name": data.get("name", ""),
+            "email": data.get("email", "")
+        }}
+    
+    @api_doc(
+        summary="获取用户详情",
+        description="根据用户 ID 获取用户详情",
+        response_model=UserResponse,
+        path="/users/{{user_id}}",
+        responses={{
+            200: "成功",
+            404: "用户不存在"
+        }}
+    )
+    async def get(self, request: Request):
+        """获取用户详情"""
+        user_id = request.path_params.get("user_id")
+        if not user_id:
+            raise HTTPException(status_code=404, detail="用户不存在")
+        # TODO: 从数据库获取用户
+        return {{"id": int(user_id), "name": "Alice", "email": "alice@example.com"}}
+    
+    @api_doc(
+        summary="更新用户",
+        description="更新用户信息",
+        response_model=UserResponse,
+        path="/users/{{user_id}}",
+        responses={{
+            200: "更新成功",
+            404: "用户不存在",
+            400: "请求参数错误"
+        }}
+    )
+    async def put(self, request: Request):
+        """更新用户"""
+        user_id = request.path_params.get("user_id")
+        data = await request.json()
+        # TODO: 更新用户信息
+        return {{"id": int(user_id), "name": data.get("name", ""), "email": data.get("email", "")}}
+    
+    @api_doc(
+        summary="删除用户",
+        description="删除指定用户",
+        path="/users/{{user_id}}",
+        responses={{
+            204: "删除成功",
+            404: "用户不存在"
+        }}
+    )
+    async def delete(self, request: Request):
+        """删除用户"""
+        user_id = request.path_params.get("user_id")
+        # TODO: 删除用户
+        return None
+''',
+        
+        "users_schemas_py": lambda: '''"""
+用户数据模型
+"""
+
+from pydantic import BaseModel, EmailStr
+
+
+class UserBase(BaseModel):
+    """用户基础模型"""
+    name: str
+    email: EmailStr
+
+
+class UserCreate(UserBase):
+    """创建用户请求模型"""
+    pass
+
+
+class UserUpdate(BaseModel):
+    """更新用户请求模型"""
+    name: str | None = None
+    email: EmailStr | None = None
+
+
+class UserResponse(UserBase):
+    """用户响应模型"""
+    id: int
+    
+    class Config:
+        from_attributes = True
+''',
+        
+        "users_module_py": lambda: '''"""
+用户控制器初始化
+"""
+
+from tomskit.server import FastApp, FastModule
+
+
+def init_user_module(app: FastApp):
+    """初始化用户控制器"""
+    # 创建用户控制器模块
+    user_module = FastModule(name="users")
+    
+    # 创建路由（前缀会自动添加到所有资源路径）
+    user_module.create_router(prefix="/api/v1")
+    
+    # 自动注册所有标记为 "users" 模块的资源
+    user_module.auto_register_resources()
+    
+    # 配置 CORS（如果需要）
+    # user_module.setup_cors(
+    #     allow_origins=["http://localhost:3000"],
+    #     allow_credentials=True
+    # )
+    
+    # 挂载控制器到主应用
+    app.mount("/", user_module)
+    
+    print("✅ 用户控制器初始化成功")
+''',
+        
+        "models_init_py": lambda: '''"""
+数据库模型模块
+导出所有模型和 Base
+"""
+
+from tomskit.sqlalchemy import SQLAlchemy
+
+# 导入所有模型，确保它们被注册到 Base.metadata
+from .user import User  # noqa: F401
+
+# 导出 Base 供 Alembic 使用
+Base = SQLAlchemy.Model
+''',
+        
+        "user_model_py": lambda: '''"""
+用户数据库模型
+"""
+
+from sqlalchemy import Column, Integer, String
+from tomskit.sqlalchemy import SQLAlchemy
+
+
+class User(SQLAlchemy.Model):
+    """用户模型"""
+    __tablename__ = "users"
+    
+    id = Column(Integer, primary_key=True, index=True)
+    name = Column(String(100), nullable=False)
+    email = Column(String(255), unique=True, nullable=False, index=True)
+    
+    def __repr__(self):
+        return f"<User(id={self.id}, name={self.name}, email={self.email})>"
+''',
+        
+        "test_users_py": lambda: '''"""
+用户模块测试
+"""
+
+import pytest
+from httpx import AsyncClient
+from main import app
+
+
+@pytest.mark.asyncio
+async def test_get_users():
+    """测试获取用户列表"""
+    async with AsyncClient(app=app, base_url="http://test") as client:
+        response = await client.get("/api/v1/users")
+        assert response.status_code == 200
+        assert isinstance(response.json(), list)
+''',
+    }

tomskit/cli/templates/migrations.py

@@ -0,0 +1,281 @@
+"""
+数据库迁移模板模块
+包含 Alembic 相关的文件模板
+"""
+
+from typing import Callable
+
+
+def get_migrations_templates(project_name: str) -> dict[str, Callable[[], str]]:
+    """获取数据库迁移模板"""
+    return {
+        "alembic_ini": lambda: f'''# A generic, {project_name} database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = .
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# file_template = %%%%Y%%%%m%%%%d_%%%%H%%%%M%%%%S_%%%(rev)s_%%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %%(here)s/bar:%%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %%(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %%(levelname)-5.5s [%%(name)s] %%(message)s
+datefmt = %%%%H:%%%%M:%%%%S
+''',
+        
+        "migrations_env_py": lambda: f'''"""
+Alembic {project_name} 环境配置文件
+用于数据库迁移
+"""
+
+import sys
+from logging.config import fileConfig
+from pathlib import Path
+
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy import create_engine
+
+from alembic import context
+
+# 添加项目根目录到 Python 路径
+# migrations 在 backend/migrations，backend 在项目根目录下
+project_root = Path(__file__).parent.parent  # backend 目录
+sys.path.insert(0, str(project_root))
+
+# 导入数据库配置和模型
+try:
+    from app.models import Base  # 导入所有模型
+    target_metadata = Base.metadata
+except ImportError:
+    # 如果模型还没有定义，创建一个空的 metadata
+    from sqlalchemy import MetaData
+    target_metadata = MetaData()
+    print("⚠️  警告: 未找到 app.models，使用空的 metadata")
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def get_url():
+    """从环境变量获取数据库 URL"""
+    from dotenv import load_dotenv
+    from tomskit.sqlalchemy import DatabaseConfig
+    
+    # 加载环境变量（.env 在 backend 目录下）
+    env_path = Path(__file__).parent.parent / ".env"
+    if env_path.exists():
+        load_dotenv(env_path)
+    
+    # 获取数据库配置
+    db_config = DatabaseConfig()
+    # 使用同步 URI 用于 Alembic（因为 Alembic 需要同步连接）
+    return db_config.SQLALCHEMY_DATABASE_SYNC_URI
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = get_url()
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={{"paramstyle": "named"}},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def do_run_migrations(connection: Connection) -> None:
+    context.configure(connection=connection, target_metadata=target_metadata)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode."""
+
+    configuration = config.get_section(config.config_ini_section)
+    configuration["sqlalchemy.url"] = get_url()
+    
+    # 使用同步引擎（Alembic 需要同步连接）
+    connectable = create_engine(
+        configuration["sqlalchemy.url"],
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        do_run_migrations(connection)
+
+    connectable.dispose()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()
+''',
+        
+        "migrations_script_py_mako": lambda: '''"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}
+''',
+        
+        "migrations_versions_init_py": lambda: '''"""
+数据库迁移版本目录
+"""
+''',
+        
+        "migrations_init_py": lambda: '''"""
+数据库迁移目录
+"""
+''',
+    }