dwyeapi 0.4.0__py3-none-any.whl

dwyeapi/tasks/schema.py

@@ -0,0 +1,38 @@
+"""Pydantic schemas for task API requests and responses."""
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict
+
+from dwyeapi.tasks.model import TaskStatus
+
+
+class TaskCreate(BaseModel):
+    """Request body for submitting a new task."""
+
+    task_type: str
+    params: dict[str, Any]
+
+
+class TaskResponse(BaseModel):
+    """Single task detail returned by the API."""
+
+    id: str
+    task_type: str
+    status: TaskStatus
+    params: dict[str, Any]
+    result: dict[str, Any] | None
+    progress: int
+    logs: str
+    created_at: datetime
+    updated_at: datetime
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class TaskListResponse(BaseModel):
+    """Paginated task list returned by the API."""
+
+    items: list[TaskResponse]
+    total: int

dwyeapi/tasks/service.py

@@ -0,0 +1,145 @@
+"""Task CRUD operations and state transitions."""
+
+from sqlalchemy import func, select
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from dwyeapi import dt
+from dwyeapi.tasks.model import Task, TaskStatus
+from dwyeapi.tasks.schema import TaskCreate
+
+
+async def create_task(session: AsyncSession, task_in: TaskCreate) -> Task:
+    """Create a new task record in the database.
+
+    Args:
+        session: Async database session.
+        task_in: Task creation payload.
+
+    Returns:
+        The newly created Task instance.
+    """
+    task = Task(
+        task_type=task_in.task_type,
+        params=task_in.params,
+        logs=f"[{_now_str()}] 任务已创建, 等待执行\n",
+    )
+    session.add(task)
+    await session.commit()
+    await session.refresh(task)
+    return task
+
+
+async def get_task(session: AsyncSession, task_id: str) -> Task | None:
+    """Query a single task by ID.
+
+    Args:
+        session: Async database session.
+        task_id: The task's unique identifier.
+
+    Returns:
+        The Task instance, or None if not found.
+    """
+    result = await session.execute(select(Task).where(Task.id == task_id))
+    return result.scalar_one_or_none()
+
+
+async def list_tasks(
+    session: AsyncSession,
+    *,
+    page: int = 1,
+    page_size: int = 20,
+    status: TaskStatus | None = None,
+    task_type: str | None = None,
+) -> tuple[list[Task], int]:
+    """List tasks with pagination and optional filters.
+
+    Args:
+        session: Async database session.
+        page: 1-based page number.
+        page_size: Number of items per page.
+        status: Optional status filter.
+        task_type: Optional task type filter.
+
+    Returns:
+        Tuple of (task list, total count).
+    """
+    query = select(Task)
+    count_query = select(func.count()).select_from(Task)
+
+    if status is not None:
+        query = query.where(Task.status == status)
+        count_query = count_query.where(Task.status == status)
+    if task_type is not None:
+        query = query.where(Task.task_type == task_type)
+        count_query = count_query.where(Task.task_type == task_type)
+
+    # Total count
+    total_result = await session.execute(count_query)
+    total = total_result.scalar_one()
+
+    # Paginated items
+    offset = (max(page, 1) - 1) * page_size
+    query = query.order_by(Task.created_at.desc()).offset(offset).limit(page_size)
+    result = await session.execute(query)
+    items = list(result.scalars().all())
+
+    return items, total
+
+
+async def update_task_status(
+    session: AsyncSession,
+    task_id: str,
+    status: TaskStatus,
+    result: dict | None = None,
+) -> None:
+    """Update a task's status and optionally its result.
+
+    Args:
+        session: Async database session.
+        task_id: The task's unique identifier.
+        status: New status to set.
+        result: Optional result data to store.
+    """
+    task = await get_task(session, task_id)
+    if not task:
+        return
+    task.status = status
+    if result is not None:
+        task.result = result
+    task.updated_at = dt.now()
+    await session.commit()
+
+
+async def update_task_progress(session: AsyncSession, task_id: str, progress: int) -> None:
+    """Update a task's progress value (0-100).
+
+    Args:
+        session: Async database session.
+        task_id: The task's unique identifier.
+        progress: Progress percentage, clamped to 0-100.
+    """
+    task = await get_task(session, task_id)
+    if not task:
+        return
+    task.progress = max(0, min(100, progress))
+    await session.commit()
+
+
+async def append_task_log(session: AsyncSession, task_id: str, message: str) -> None:
+    """Append a timestamped log entry to a task.
+
+    Args:
+        session: Async database session.
+        task_id: The task's unique identifier.
+        message: Log message to append.
+    """
+    task = await get_task(session, task_id)
+    if not task:
+        return
+    task.logs += f"[{_now_str()}] {message}\n"
+    await session.commit()
+
+
+def _now_str() -> str:
+    """Return current time formatted as a string."""
+    return dt.now_str()

dwyeapi/tasks/worker.py

@@ -0,0 +1,118 @@
+"""Worker configuration factory.
+
+Generates an ARQ ``WorkerSettings`` class from eapi's ``BaseSettings``,
+bridging configuration between the two systems.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from dwyeapi.config import BaseSettings
+from dwyeapi.logger import get_logger
+from dwyeapi.tasks.pool import _parse_redis_url
+
+_log = get_logger(__name__)
+
+
+def create_worker_settings(
+    settings: BaseSettings,
+    session_factory: Any = None,
+) -> type:
+    """Create an ARQ WorkerSettings class from eapi BaseSettings.
+
+    The returned class can be used directly with ``arq`` CLI::
+
+        # app/worker.py
+        import app.tasks  # trigger @register decorators
+        from app.settings import settings
+        from dwyeapi.tasks import create_worker_settings
+        from dwyeapi.database import create_async_engine_factory, create_session_factory
+
+        engine = create_async_engine_factory(settings.database_url)
+        sf = create_session_factory(engine)
+        WorkerSettings = create_worker_settings(settings, session_factory=sf)
+
+        # Run: arq app.worker.WorkerSettings
+
+    Args:
+        settings: An eapi BaseSettings instance (or subclass) with
+            redis_url, task_max_jobs, task_job_timeout, task_failure_ttl.
+        session_factory: Async SQLAlchemy session factory for TaskContext
+            database access inside worker tasks.
+
+    Returns:
+        A class suitable as ARQ WorkerSettings.
+    """
+    from dwyeapi.tasks.context import run_task_with_context
+    from dwyeapi.tasks.registry import registry
+
+    _redis_settings = _parse_redis_url(settings.redis_url)
+    _session_factory = session_factory
+
+    async def _task_executor(ctx: dict, task_id: str, task_type: str, params: dict) -> None:
+        """ARQ entry point — dispatches to the registered task function.
+
+        Args:
+            ctx: ARQ worker context dict (contains 'redis').
+            task_id: Unique task identifier.
+            task_type: Registered task type string.
+            params: Task input parameters.
+        """
+        func = registry.get(task_type)
+        if func is None:
+            msg = f"Unknown task type: {task_type}"
+            raise ValueError(msg)
+
+        await run_task_with_context(
+            task_id=task_id,
+            task_type=task_type,
+            params=params,
+            func=func,
+            session_factory=_session_factory,
+            redis=ctx["redis"],
+        )
+
+    from arq.worker import func as arq_func
+
+    async def _on_startup(ctx: dict) -> None:
+        """Worker 启动时恢复未完成的任务。
+
+        扫描 PostgreSQL 中 pending/running 状态的任务，重新入队到 ARQ。
+        running 状态的任务说明上次 Worker 中断，重置为 pending 后重新执行。
+        """
+        from sqlalchemy import select
+
+        from dwyeapi.tasks.model import Task, TaskStatus
+        from dwyeapi.tasks.service import append_task_log, update_task_status
+
+        redis = ctx["redis"]
+        async with _session_factory() as session:
+            result = await session.execute(
+                select(Task).where(Task.status.in_([TaskStatus.PENDING, TaskStatus.RUNNING]))
+            )
+            stale_tasks = list(result.scalars().all())
+
+        if not stale_tasks:
+            return
+
+        for task in stale_tasks:
+            if task.status == TaskStatus.RUNNING:
+                async with _session_factory() as session:
+                    await update_task_status(session, task.id, TaskStatus.PENDING)
+                    await append_task_log(session, task.id, "Worker 重启，任务重新入队")
+
+            await redis.enqueue_job("_task_executor", task.id, task.task_type, task.params)
+
+        _log.info("恢复了 {count} 个未完成的任务", count=len(stale_tasks))
+
+    class WorkerSettings:
+        """ARQ WorkerSettings generated from eapi BaseSettings."""
+
+        functions = [arq_func(_task_executor, name="_task_executor")]
+        max_jobs = settings.task_max_jobs
+        job_timeout = settings.task_job_timeout
+        on_startup = _on_startup
+        redis_settings = _redis_settings
+
+    return WorkerSettings

dwyeapi-0.4.0.dist-info/METADATA

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: dwyeapi
+Version: 0.4.0
+Summary: Lightweight FastAPI infrastructure — exceptions, database, config, security, cache, pagination, logger
+License: MIT
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: sqlalchemy[asyncio]>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Requires-Dist: bcrypt>=4.0.0
+Requires-Dist: redis>=5.0.0
+Requires-Dist: loguru>=0.7.3
+Provides-Extra: tasks
+Requires-Dist: arq>=0.26.0; extra == "tasks"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
+Requires-Dist: httpx>=0.27.0; extra == "dev"
+Requires-Dist: aiosqlite>=0.20.0; extra == "dev"
+Requires-Dist: ruff>=0.6.0; extra == "dev"
+Requires-Dist: arq>=0.26.0; extra == "dev"

dwyeapi-0.4.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+dwyeapi/__init__.py,sha256=jXW4AJVfYV_vWtQWd1UJmgMkBdbF8iEL3ovBvLxRwoQ,848
+dwyeapi/cache.py,sha256=uMxe5PLPPlOQuErtUp4e8sObD7eUC8y80aXvBjvBcCw,834
+dwyeapi/config.py,sha256=Ok7te4m8052cPk2MkURlh282SW8H4-qSmErbDaWONr0,1149
+dwyeapi/database.py,sha256=Irgmm5KRzBLJmf0SjDvvOa3UspR9GcyIJlMkYdgfp7Y,1330
+dwyeapi/dependencies.py,sha256=yKAER6zm24VKNfey_ieBQeTNIuc3xG3GKWIoQAY0jKU,525
+dwyeapi/dt.py,sha256=3YQ_wk4WE40KeWzfu45RcLCVKWePw8JL_l7bSfhKOmE,1633
+dwyeapi/exceptions.py,sha256=ltXrso0YNbL71CFucG5dPypZsey6lPF5I8vrt_GG4Ow,2549
+dwyeapi/logger.py,sha256=McL9beGzqM9cDLDFm1Pi0mDpZJBUJACoXRbdemp2xnQ,7142
+dwyeapi/masking.py,sha256=xwCmH9g5gBsRI_72SZyrPR56ErD3PkPYr-0vwWIeKFU,2966
+dwyeapi/pagination.py,sha256=udvjNfzQeB8YDimD27Dz53gCRHEN9pEPEJZE4cvjHvU,708
+dwyeapi/response.py,sha256=Jw3faYmMGT58oTpAOGUWeKzWQFM4fi8tkDgeaHFALX4,714
+dwyeapi/security.py,sha256=aqs4CaRy7XnESHYMuSeN3FnJdEvbf3mUKWkBt-CJGDY,1367
+dwyeapi/tasks/__init__.py,sha256=1b-HT81KvHIRhtqLr4GwXEbIGI5bB7dCAidLivZU6nk,2990
+dwyeapi/tasks/context.py,sha256=zlXmShu-zZzrF9Dkw-Vu8j5wSpYvP3IDbkqxpHLKjCY,6180
+dwyeapi/tasks/model.py,sha256=HtzRRC-V7uGIPjTpejHVxMXzhyy33zBg3QUPlwOe3jQ,1297
+dwyeapi/tasks/pool.py,sha256=tW_YSJAVbZ0O4kJdhWZb9sH1ykDnqKzOd5D5v7YIjBA,2064
+dwyeapi/tasks/registry.py,sha256=nUS3k2J1WUtYddUFVAprw9NyszRagaR2xRVjNuLhs7k,2249
+dwyeapi/tasks/router.py,sha256=Pq_6kPdzej3SLdlfFTK7qSWZp8oHjauPF5mQRDDcXFw,6492
+dwyeapi/tasks/schema.py,sha256=tZlG486_kgM_jq6bxthqA9-KT4tYNIzJCCR6i-yxTcw,798
+dwyeapi/tasks/service.py,sha256=eK6bZDGX3PFkYkJaMBZGQMoX0irQPR4_Aj9yNj6uIqE,4064
+dwyeapi/tasks/worker.py,sha256=P12fBgmvMgwMbDNdWYvjZe3D_WVs-xSCGDTeblvJwJM,4161
+dwyeapi-0.4.0.dist-info/METADATA,sha256=1RJjGIuPRlpoeCHkNd4ZROAiAAWYwlRORhKtGHOftW0,847
+dwyeapi-0.4.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+dwyeapi-0.4.0.dist-info/top_level.txt,sha256=92XFFm-WEEOa91KThjNTbNoSdFnhqu0Wtl1UHD0tPW0,8
+dwyeapi-0.4.0.dist-info/RECORD,,

dwyeapi-0.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dwyeapi-0.4.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+dwyeapi