infomankit 0.3.23__py3-none-any.whl

infoman/cli/templates/project/main.py.template

@@ -0,0 +1,10 @@
+from infoman.service.launch import serve
+
+
+if __name__ == "__main__":
+    serve(
+        app_target="app.app:application",
+        server="granian",
+        reload=False,
+        workers=1
+    )

infoman/cli/templates/project/manage.sh.template

@@ -0,0 +1,97 @@
+#!/bin/bash
+
+# Color definitions
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Print colored message
+print_message() {{
+    local color=$1
+    local message=$2
+    echo -e "${{color}}${{message}}${{NC}}"
+}}
+
+# Print usage
+print_usage() {{
+    echo "Usage: ./manage.sh [command]"
+    echo ""
+    echo "Available commands:"
+    echo "  dev          - Start development server"
+    echo "  test         - Run tests"
+    echo "  lint         - Run linter"
+    echo "  format       - Format code"
+    echo "  clean        - Clean temporary files"
+    echo "  help         - Show this help message"
+}}
+
+# Development server
+cmd_dev() {{
+    print_message "$BLUE" "Starting development server..."
+    infoman-serve run app.app:app --reload --host 0.0.0.0 --port 8000
+}}
+
+# Run tests
+cmd_test() {{
+    print_message "$BLUE" "Running tests..."
+    pytest tests/ -v --cov=app
+}}
+
+# Run linter
+cmd_lint() {{
+    print_message "$BLUE" "Running linter..."
+    ruff check .
+    mypy app/
+}}
+
+# Format code
+cmd_format() {{
+    print_message "$BLUE" "Formatting code..."
+    black .
+    ruff check --fix .
+    print_message "$GREEN" "Code formatted successfully"
+}}
+
+# Clean temporary files
+cmd_clean() {{
+    print_message "$BLUE" "Cleaning temporary files..."
+    find . -type d -name "__pycache__" -exec rm -rf {{}} + 2>/dev/null
+    find . -type f -name "*.pyc" -delete 2>/dev/null
+    find . -type f -name "*.pyo" -delete 2>/dev/null
+    find . -type d -name "*.egg-info" -exec rm -rf {{}} + 2>/dev/null
+    find . -type d -name ".pytest_cache" -exec rm -rf {{}} + 2>/dev/null
+    find . -type d -name ".ruff_cache" -exec rm -rf {{}} + 2>/dev/null
+    find . -type d -name ".mypy_cache" -exec rm -rf {{}} + 2>/dev/null
+    rm -rf dist/ build/ 2>/dev/null
+    print_message "$GREEN" "Cleanup completed"
+}}
+
+# Main command dispatcher
+case "$1" in
+    dev)
+        cmd_dev
+        ;;
+    test)
+        cmd_test
+        ;;
+    lint)
+        cmd_lint
+        ;;
+    format)
+        cmd_format
+        ;;
+    clean)
+        cmd_clean
+        ;;
+    help|--help|-h|"")
+        print_usage
+        ;;
+    *)
+        print_message "$RED" "Error: Unknown command '$1'"
+        echo ""
+        print_usage
+        exit 1
+        ;;
+esac

infoman/cli/templates/project/pyproject.toml.template

@@ -0,0 +1,47 @@
+[project]
+name = "{project_name}"
+version = "0.1.0"
+description = "FastAPI application built with infomankit"
+requires-python = ">=3.11"
+dependencies = [
+    "infomankit>=0.3.18",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-cov>=4.1.0",
+    "black>=23.11.0",
+    "ruff>=0.1.6",
+    "mypy>=1.7.0",
+]
+
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 100
+target-version = ["py311"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"
+asyncio_mode = "auto"

infoman/cli/templates/project/service.sh.template

@@ -0,0 +1,203 @@
+#!/bin/bash
+
+# {project_name} Service Management Script
+# Manages the application as a background service
+
+set -e
+
+PROJECT_NAME="{project_name}"
+PID_FILE=".app.pid"
+LOG_FILE="logs/app.log"
+ERROR_LOG_FILE="logs/app.error.log"
+
+# Color definitions
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Print colored message
+print_message() {{
+    local color=$1
+    local message=$2
+    echo -e "${{color}}${{message}}${{NC}}"
+}}
+
+# Check if service is running
+is_running() {{
+    if [ -f "$PID_FILE" ]; then
+        local pid=$(cat "$PID_FILE")
+        if kill -0 "$pid" 2>/dev/null; then
+            return 0
+        else
+            # PID file exists but process is dead, clean up
+            rm -f "$PID_FILE"
+            return 1
+        fi
+    fi
+    return 1
+}}
+
+# Start service
+cmd_start() {{
+    if is_running; then
+        print_message "$YELLOW" "Service is already running (PID: $(cat "$PID_FILE"))"
+        exit 1
+    fi
+
+    print_message "$BLUE" "Starting $PROJECT_NAME service..."
+
+    # Create logs directory if not exists
+    mkdir -p logs
+
+    # Start service in background
+    nohup python main.py > "$LOG_FILE" 2> "$ERROR_LOG_FILE" &
+    local pid=$!
+    echo $pid > "$PID_FILE"
+
+    # Wait a moment and check if it's still running
+    sleep 2
+    if is_running; then
+        print_message "$GREEN" "Service started successfully (PID: $pid)"
+        print_message "$BLUE" "Logs: $LOG_FILE"
+    else
+        print_message "$RED" "Service failed to start. Check $ERROR_LOG_FILE for details"
+        rm -f "$PID_FILE"
+        exit 1
+    fi
+}}
+
+# Stop service
+cmd_stop() {{
+    if ! is_running; then
+        print_message "$YELLOW" "Service is not running"
+        exit 1
+    fi
+
+    local pid=$(cat "$PID_FILE")
+    print_message "$BLUE" "Stopping $PROJECT_NAME service (PID: $pid)..."
+
+    # Try graceful shutdown first
+    kill -TERM "$pid" 2>/dev/null || true
+
+    # Wait up to 10 seconds for graceful shutdown
+    local count=0
+    while kill -0 "$pid" 2>/dev/null && [ $count -lt 10 ]; do
+        sleep 1
+        count=$((count + 1))
+    done
+
+    # Force kill if still running
+    if kill -0 "$pid" 2>/dev/null; then
+        print_message "$YELLOW" "Graceful shutdown failed, forcing kill..."
+        kill -9 "$pid" 2>/dev/null || true
+    fi
+
+    rm -f "$PID_FILE"
+    print_message "$GREEN" "Service stopped"
+}}
+
+# Restart service
+cmd_restart() {{
+    print_message "$BLUE" "Restarting $PROJECT_NAME service..."
+    if is_running; then
+        cmd_stop
+        sleep 1
+    fi
+    cmd_start
+}}
+
+# Show service status
+cmd_status() {{
+    if is_running; then
+        local pid=$(cat "$PID_FILE")
+        print_message "$GREEN" "Service is running (PID: $pid)"
+
+        # Show process info
+        if command -v ps >/dev/null 2>&1; then
+            echo ""
+            ps -p "$pid" -o pid,ppid,user,%cpu,%mem,etime,command 2>/dev/null || true
+        fi
+    else
+        print_message "$RED" "Service is not running"
+        exit 1
+    fi
+}}
+
+# Show logs
+cmd_logs() {{
+    if [ ! -f "$LOG_FILE" ]; then
+        print_message "$YELLOW" "Log file not found: $LOG_FILE"
+        exit 1
+    fi
+
+    print_message "$BLUE" "Showing logs (Ctrl+C to exit)..."
+    tail -f "$LOG_FILE"
+}}
+
+# Show error logs
+cmd_errors() {{
+    if [ ! -f "$ERROR_LOG_FILE" ]; then
+        print_message "$YELLOW" "Error log file not found: $ERROR_LOG_FILE"
+        exit 1
+    fi
+
+    print_message "$BLUE" "Showing error logs (Ctrl+C to exit)..."
+    tail -f "$ERROR_LOG_FILE"
+}}
+
+# Print usage
+print_usage() {{
+    cat << EOF
+${{BLUE}}$PROJECT_NAME Service Manager${{NC}}
+
+Usage: ./service.sh [command]
+
+Commands:
+  start        Start the service in background
+  stop         Stop the service
+  restart      Restart the service
+  status       Show service status
+  logs         Show application logs (follow mode)
+  errors       Show error logs (follow mode)
+  help         Show this help message
+
+Examples:
+  ./service.sh start
+  ./service.sh status
+  ./service.sh logs
+
+EOF
+}}
+
+# Main command dispatcher
+case "$1" in
+    start)
+        cmd_start
+        ;;
+    stop)
+        cmd_stop
+        ;;
+    restart)
+        cmd_restart
+        ;;
+    status)
+        cmd_status
+        ;;
+    logs)
+        cmd_logs
+        ;;
+    errors)
+        cmd_errors
+        ;;
+    help|--help|-h|"")
+        print_usage
+        ;;
+    *)
+        print_message "$RED" "Error: Unknown command '$1'"
+        echo ""
+        print_usage
+        exit 1
+        ;;
+esac

infoman/config/__init__.py

@@ -0,0 +1,25 @@
+# !/usr/bin/env python
+# -*-coding:utf-8 -*-
+
+"""
+# Time       ：2025/6/22 12:02
+# Author     ：Maxwell
+# Description：
+"""
+
+from .settings import settings
+from .base import BaseConfig
+from .db_relation import DatabaseConfig, DatabaseInstanceConfig
+from .db_cache import RedisConfig
+from .db_vector import VectorDBConfig
+from .mq import MessageQueueConfig
+
+__all__ = [
+    "settings",
+    "BaseConfig",
+    "DatabaseConfig",
+    "DatabaseInstanceConfig",
+    "RedisConfig",
+    "VectorDBConfig",
+    "MessageQueueConfig",
+]

infoman/config/base.py

@@ -0,0 +1,67 @@
+# !/usr/bin/env python
+# -*-coding:utf-8 -*-
+
+"""
+# Time       ：2025/12/22 21:40
+# Author     ：Maxwell
+# Description：
+"""
+
+from typing import Literal
+from pydantic_settings import BaseSettings
+from pydantic import Field, field_validator
+
+
+class BaseConfig(BaseSettings):
+    # ========== 环境 ==========
+    ENV: Literal["dev", "test", "prod"] = Field(default="dev")
+
+    # ========== 应用 ==========
+    APP_NAME: str = Field(default="InfoMan")
+    APP_BASE_URI: str = Field(default="/infoman")
+    APP_VERSION: str = Field(default="1.0.0")
+    APP_HOST: str = Field(default="0.0.0.0")
+    APP_PORT: int = Field(default=8000)
+    APP_DESCRIPTION: str = Field(default="Information System")
+
+    DEFAULT_LANGUAGE_IS_EN: bool = Field(default=True)
+
+    # ========== 服务器配置 ==========
+    APP_WORKERS: int = Field(default=2, description="工作进程数（Granian/Gunicorn）")
+    APP_THREADS: int = Field(default=1, description="每个 worker 的线程数（Granian）")
+
+    # ========== API 文档 ==========
+    DOCS_URL: str = Field(default="/doc")
+    APP_REDOC_URL: str = Field(default="/redoc")
+
+    # ========== CORS ==========
+    ALLOW_ORIGINS: list[str] = Field(default=["*"])
+    ALLOW_CREDENTIALS: bool = Field(default=False)
+    ALLOW_METHODS: list[str] = Field(default=["GET", "POST"])
+    ALLOW_HEADERS: list[str] = Field(default=["Content-Type", "Authorization", "X-Request-ID"])
+    MAX_AGE: int = Field(default=600)
+
+    # ========== Router配置 ==========
+    USE_DEFAULT_ROUTER: bool = Field(default=False)
+    USE_PROMETHEUS_ROUTER: bool = Field(default=False)
+    USE_STATIC: bool = Field(default=False)
+    STATIC_NAME: str = Field(default="static")
+    STATIC_DIR: str = Field(default="./app/static")
+    STATIC_URL: str = Field(default="/static")
+    USE_TEMPLATES: bool = Field(default=False)
+    TEMPLATE_DIR: str = Field(default="./app/template")
+
+    @property
+    def is_dev(self) -> bool:
+        return self.ENV == "dev"
+
+    @property
+    def is_test(self) -> bool:
+        return self.ENV == "test"
+
+    @property
+    def is_prod(self) -> bool:
+        return self.ENV == "pro"
+
+
+

infoman/config/db_cache.py

@@ -0,0 +1,237 @@
+# !/usr/bin/env python
+# -*-coding:utf-8 -*-
+
+"""
+# Time       ：2025/12/22 21:37
+# Author     ：Maxwell
+# Description：
+"""
+from typing import Optional, Literal
+from pydantic import Field, field_validator
+from pydantic_settings import BaseSettings
+
+
+class RedisConfig(BaseSettings):
+    """Redis/DragonflyDB 缓存配置"""
+
+    # ========== 基础配置 ==========
+    REDIS_ENABLED: bool = Field(
+        default=False,
+        description="是否启用缓存服务"
+    )
+
+    REDIS_BACKEND: Literal["redis", "dragonfly", "auto"] = Field(
+        default="auto",
+        description="缓存后端类型：redis/dragonfly/auto（自动检测）"
+    )
+
+    REDIS_HOST: Optional[str] = Field(
+        default=None,
+        description="缓存服务器主机地址"
+    )
+
+    REDIS_PORT: int = Field(
+        default=6379,
+        description="缓存服务器端口"
+    )
+
+    REDIS_DB: int = Field(
+        default=0,
+        ge=0,
+        le=15,
+        description="Redis 数据库编号（0-15）"
+    )
+
+    REDIS_PASSWORD: Optional[str] = Field(
+        default=None,
+        description="缓存服务器密码"
+    )
+
+    # ========== 连接池配置 ==========
+    REDIS_MAX_CONNECTIONS: int = Field(
+        default=30,
+        ge=1,
+        le=1000,
+        description="连接池最大连接数"
+    )
+
+    REDIS_SOCKET_TIMEOUT: int = Field(
+        default=4,
+        ge=1,
+        description="Socket 超时时间（秒）"
+    )
+
+    REDIS_SOCKET_CONNECT_TIMEOUT: int = Field(
+        default=2,
+        ge=1,
+        description="连接超时时间（秒）"
+    )
+
+    REDIS_HEALTH_CHECK_INTERVAL: int = Field(
+        default=30,
+        ge=0,
+        description="健康检查间隔（秒），0 表示禁用"
+    )
+
+    REDIS_RETRY_ON_TIMEOUT: bool = Field(
+        default=True,
+        description="超时时是否自动重试"
+    )
+
+    # ========== 缓存配置 ==========
+    REDIS_CACHE_PREFIX: str = Field(
+        default="infoman",
+        description="缓存 key 前缀"
+    )
+
+    REDIS_CACHE_EXPIRE: int = Field(
+        default=3600,
+        ge=0,
+        description="默认缓存过期时间（秒），0 表示永不过期"
+    )
+
+    REDIS_CACHE_VERSION: Optional[str] = Field(
+        default=None,
+        description="缓存版本号（用于缓存失效），留空则使用应用版本"
+    )
+
+    # ========== 编码配置 ==========
+    REDIS_ENCODING: str = Field(
+        default="utf-8",
+        description="编码格式"
+    )
+
+    REDIS_DECODE_RESPONSES: bool = Field(
+        default=False,
+        description="是否自动解码响应（True: 返回 str，False: 返回 bytes）"
+    )
+
+    # ========== 验证器 ==========
+
+    @field_validator("REDIS_BACKEND")
+    @classmethod
+    def validate_backend(cls, v: str) -> str:
+        """验证后端类型"""
+        allowed = ["redis", "dragonfly", "auto"]
+        if v not in allowed:
+            raise ValueError(f"REDIS_BACKEND 必须是 {allowed} 之一")
+        return v
+
+    @field_validator("REDIS_CACHE_PREFIX")
+    @classmethod
+    def validate_prefix(cls, v: str) -> str:
+        if not v or not v.strip():
+            raise ValueError("REDIS_CACHE_PREFIX 不能为空")
+        return v.strip()
+
+    @field_validator("REDIS_HOST")
+    @classmethod
+    def validate_host(cls, v: Optional[str]) -> Optional[str]:
+        """验证主机地址"""
+        if v:
+            v = v.strip()
+            if not v:
+                return None
+        return v
+
+    # ========== 计算属性 ==========
+
+    @property
+    def redis_configured(self) -> bool:
+        return self.REDIS_ENABLED and bool(self.REDIS_HOST)
+
+    @property
+    def is_redis(self) -> bool:
+        """是否使用 Redis"""
+        return self.REDIS_BACKEND == "redis"
+
+    @property
+    def is_dragonfly(self) -> bool:
+        """是否使用 DragonflyDB"""
+        return self.REDIS_BACKEND == "dragonfly"
+
+    @property
+    def is_auto(self) -> bool:
+        """是否自动检测"""
+        return self.REDIS_BACKEND == "auto"
+
+    @property
+    def connection_url(self) -> Optional[str]:
+        """
+        获取连接 URL
+
+        Returns:
+            Redis 连接 URL，例如：redis://:password@localhost:6379/0
+        """
+        if not self.redis_configured:
+            return None
+
+        auth = f":{self.REDIS_PASSWORD}@" if self.REDIS_PASSWORD else ""
+        return f"redis://{auth}{self.REDIS_HOST}:{self.REDIS_PORT}/{self.REDIS_DB}"
+
+    def get_cache_key(self, key: str, version: Optional[str] = None) -> str:
+        """
+        生成完整的缓存 key
+
+        Args:
+            key: 原始 key
+            version: 版本号，留空则使用配置的版本
+
+        Returns:
+            完整的缓存 key，例如：infoman:v1.0.0:user:123
+        """
+        version = version or self.REDIS_CACHE_VERSION or "default"
+        return f"{self.REDIS_CACHE_PREFIX}:v{version}:{key}"
+
+    def to_dict(self) -> dict:
+        """
+        转换为字典（隐藏敏感信息）
+
+        Returns:
+            配置字典
+        """
+        return {
+            "enabled": self.REDIS_ENABLED,
+            "backend": self.REDIS_BACKEND,
+            "host": self.REDIS_HOST,
+            "port": self.REDIS_PORT,
+            "db": self.REDIS_DB,
+            "password": "***" if self.REDIS_PASSWORD else None,
+            "max_connections": self.REDIS_MAX_CONNECTIONS,
+            "cache_prefix": self.REDIS_CACHE_PREFIX,
+            "cache_expire": self.REDIS_CACHE_EXPIRE,
+            "configured": self.redis_configured,
+        }
+
+
+def get_redis_config() -> RedisConfig:
+    return RedisConfig()
+
+
+def print_redis_config():
+    config = get_redis_config()
+
+    print("=" * 60)
+    print("Redis/DragonflyDB 缓存配置")
+    print("=" * 60)
+
+    for key, value in config.to_dict().items():
+        print(f"  {key:20s}: {value}")
+
+    print("=" * 60)
+    print(f"  连接 URL: {config.connection_url or '未配置'}")
+    print("=" * 60)
+
+
+# ========== 使用示例 ==========
+
+if __name__ == "__main__":
+    # 打印配置
+    print_redis_config()
+
+    # 测试缓存 key 生成
+    config = get_redis_config()
+
+    print("\n缓存 Key 示例：")
+    print(f"  user:123 -> {config.get_cache_key('user:123')}")
+    print(f"  session:abc -> {config.get_cache_key('session:abc', version='2.0.0')}")