cronapi-py 0.1.0__py3-none-any.whl

api/v1/__init__.py

@@ -0,0 +1,15 @@
+from fastapi import APIRouter
+
+from api.v1.etcd import router as etcd_router
+from api.v1.mongo import router as mongo_router
+
+# 后续其他路由模块导入到这里
+# from api.v1.jobs import router as jobs_router
+# from api.v1.workers import router as workers_router
+
+api_router = APIRouter()
+
+api_router.include_router(mongo_router, prefix="/mongo")
+api_router.include_router(etcd_router, prefix="/etcd")
+# api_router.include_router(jobs_router, prefix="/jobs")
+# api_router.include_router(workers_router, prefix="/workers")

api/v1/etcd.py

@@ -0,0 +1,182 @@
+import json
+from typing import Any, Dict, List, Optional, Union
+
+from fastapi import APIRouter, Body, HTTPException, Query
+from fastapi.responses import JSONResponse
+from google.protobuf.json_format import MessageToDict
+from pydantic import BaseModel, Field
+
+from services.etcd import EtcdClient
+
+router = APIRouter()
+
+
+@router.get("/")
+async def get_etcd_value(
+    key: str = Query("", min_length=1, description="etcd key"),
+    prefix: bool = Query(True, description="是否使用前缀匹配模式"),
+):
+    """
+    通过key获取etcd中的值
+
+    参数:
+        key: etcd中的键名
+
+    返回:
+        包含键值对的JSON响应
+    """
+    with EtcdClient() as client:
+        try:
+            if prefix:
+                results = [
+                    {
+                        "key": metadata.key.decode("utf-8"),
+                        "value": value.decode("utf-8")
+                        if isinstance(value, bytes)
+                        else value,
+                        "metadata": {
+                            "version": metadata.version,
+                            "create_revision": metadata.create_revision,
+                            "mod_revision": metadata.mod_revision,
+                        },
+                    }
+                    for value, metadata in client.get_prefix(key)
+                ]
+                if not results:
+                    raise HTTPException(
+                        status_code=404, detail=f"未找到前缀为 '{key}' 的键"
+                    )
+                return JSONResponse(results)
+            else:
+                # 获取单个key的值
+                value, metadata = client.get(key)
+                if value is None or metadata is None:
+                    raise HTTPException(
+                        status_code=404, detail=f"Key '{key}' not found"
+                    )
+
+                if isinstance(value, bytes):
+                    value = value.decode("utf-8")
+
+                return JSONResponse(
+                    {
+                        "key": key,
+                        "value": value,
+                        "metadata": {
+                            "version": metadata.version,
+                            "create_revision": metadata.create_revision,
+                            "mod_revision": metadata.mod_revision,
+                        },
+                    }
+                )
+        except Exception as e:
+            raise HTTPException(
+                status_code=500, detail=f"Error getting value from etcd: {str(e)}"
+            )
+
+
+# 添加请求体模型
+class EtcdValue(BaseModel):
+    key: str = Field(..., description="etcd key")
+    value: Union[str, Dict[str, Any], List[Any]] = Field(..., description="要设置的值")
+    lease: Optional[int] = Field(None, ge=1, description="lease TTL in seconds")
+
+
+@router.put("/")
+async def put_etcd_value(
+    data: EtcdValue = Body(..., description="要设置的键值对"),
+):
+    """
+    设置etcd中的值
+
+    参数:
+        data: 包含key和value的请求体
+
+    返回:
+        设置成功的响应
+    """
+    with EtcdClient() as client:
+        try:
+            # 使用更简洁的序列化方式
+            value_str = (
+                json.dumps(data.value)
+                if isinstance(data.value, (dict, list))
+                else str(data.value)
+            )
+
+            lease_id = None
+            lease = None
+            if data.lease:
+                try:
+                    lease = client.lease(data.lease)
+                    lease_id = lease.id
+                except Exception as e:
+                    raise HTTPException(
+                        status_code=400, detail=f"创建lease失败: {str(e)}"
+                    )
+
+            try:
+                metadata = client.put(data.key, value_str, lease=lease_id)
+            except Exception:
+                if lease_id:
+                    # 如果put失败，尝试撤销lease
+                    if lease is not None:
+                        try:
+                            lease.revoke()
+                        except Exception:
+                            pass
+                raise
+
+            return JSONResponse(
+                {
+                    "key": data.key,
+                    "value": data.value,
+                    "lease_id": lease_id,
+                    "metadata": MessageToDict(metadata) if metadata else None,
+                    "message": "设置成功",
+                }
+            )
+        except HTTPException:
+            raise
+        except Exception as e:
+            raise HTTPException(
+                status_code=500, detail=f"设置etcd值时发生错误: {str(e)}"
+            )
+
+
+@router.delete("/")
+async def delete_etcd_value(
+    key: str = Query(..., description="要删除的etcd key"),
+    prefix: bool = Query(False, description="是否使用前缀删除模式"),
+):
+    """
+    删除etcd中的键值
+
+    参数:
+        key: 要删除的键名
+        prefix: 是否使用前缀删除模式,如果为True则删除所有匹配前缀的键
+
+    返回:
+        删除成功的响应
+    """
+    with EtcdClient() as client:
+        try:
+            if prefix:
+                deleted = client.delete_prefix(key)
+                return JSONResponse(
+                    {
+                        "message": f"已删除所有前缀为 '{key}' 的键值",
+                        "deleted_count": deleted,
+                    }
+                )
+            else:
+                deleted = client.delete(key)
+                if not deleted:
+                    raise HTTPException(status_code=404, detail=f"未找到键 '{key}'")
+                return JSONResponse(
+                    {"message": f"成功删除键 '{key}'", "deleted_count": 1}
+                )
+        except Exception as e:
+            raise HTTPException(
+                status_code=500, detail=f"从etcd删除值时发生错误: {str(e)}"
+            )

api/v1/mongo.py

@@ -0,0 +1,108 @@
+from datetime import datetime, timedelta
+from typing import List, Optional
+
+from fastapi import APIRouter, Query
+from pydantic import BaseModel, Field
+
+from models.log import Log
+from services.mongodb import MongoDB
+
+router = APIRouter()
+
+
+class PaginatedLogs(BaseModel):
+    """分页响应模型"""
+
+    total: int = Field(..., description="总记录数")
+    items: List[Log] = Field(..., description="日志列表")
+    page: int = Field(..., description="当前页码")
+    page_size: int = Field(..., description="每页大小")
+    pages: int = Field(..., description="总页数")
+
+
+@router.get("/logs", response_model=PaginatedLogs)
+async def get_logs(
+    page: int = Query(1, description="页码", ge=1),
+    page_size: int = Query(1000, description="每页记录数", ge=1, le=10000),
+    job_name: Optional[str] = Query(None, description="任务名称"),
+    command: Optional[str] = Query(None, description="命令"),
+    start_time: Optional[int] = Query(
+        None,
+        description="开始时间戳(毫秒)",
+        example=int((datetime.now() - timedelta(hours=1)).timestamp() * 1000),
+    ),
+    end_time: Optional[int] = Query(
+        None,
+        description="结束时间戳(毫秒)",
+        example=int(datetime.now().timestamp() * 1000),
+    ),
+    has_error: Optional[bool] = Query(None, description="是否有错误"),
+    sort_field: str = Query(
+        "startTime",
+        description="排序字段",
+        enum=["planTime", "scheduleTime", "startTime", "endTime"],
+    ),
+    sort_order: str = Query(
+        "desc",
+        description="排序方向",
+        enum=["asc", "desc"],
+    ),
+):
+    """
+     获取任务执行日志
+
+    - 支持分页查询
+    - 支持按任务名称过滤
+    - 支持按命令过滤
+    - 支持时间范围过滤
+    - 支持筛选有错误的记录
+    - 支持自定义排序字段和方向
+    """
+    async with MongoDB() as mongo:
+        # 构建查询条件
+        query = {}
+
+        if job_name:
+            query["jobName"] = {
+                "$regex": job_name,
+                "$options": "i",
+            }  # i表示不区分大小写
+
+        if command:
+            query["command"] = {"$regex": command, "$options": "i"}  # i表示不区分大小写
+
+        if start_time or end_time:
+            query["startTime"] = {}
+            if start_time:
+                query["startTime"]["$gte"] = start_time
+            if end_time:
+                query["startTime"]["$lte"] = end_time
+
+        if has_error is not None:
+            if has_error:
+                query["err"] = {"$ne": ""}
+            else:
+                query["err"] = ""
+
+        # 计算总记录数
+        total = await mongo.db["log"].count_documents(query)
+        pages = (total + page_size - 1) // page_size
+        skip = (page - 1) * page_size
+
+        cursor = mongo.db["log"].find(
+            query,
+            sort=[(sort_field, -1 if sort_order == "desc" else 1)],
+            skip=skip,
+            limit=page_size,
+        )
+
+        # 转换为列表
+        logs = await cursor.to_list(length=page_size)
+
+        return {
+            "total": total,
+            "items": logs,
+            "page": page,
+            "page_size": page_size,
+            "pages": pages,
+        }

core/config.py

@@ -0,0 +1,23 @@
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    # API配置
+    API_V1_STR: str = "/api/v1"
+    PROJECT_NAME: str = "Cron API"
+
+    ETCD_HOSTS: str = ""
+    MONGO_URL: str = ""
+    MONGO_DB_NAME: str = "cron"
+
+    class Config:
+        env_prefix = "CRON_API_"  # 添加环境变量前缀
+        case_sensitive = True
+
+    def reload(self):
+        new_settings = Settings()
+        for field in self.model_fields:
+            setattr(self, field, getattr(new_settings, field))
+
+
+settings = Settings()

core/consts.py

@@ -0,0 +1,5 @@
+CONF_DIR = "/conf/"
+JOB_SAVE_DIR = "/cron/jobs/"
+JOB_KILLER_DIR = "/cron/killer/"
+JOB_WORKER_DIR = "/cron/workers/"
+JOB_LOCK_DIR = "/cron/lock/"

cron_api/main.py

@@ -0,0 +1,81 @@
+from contextlib import asynccontextmanager
+
+import typer
+import uvicorn
+from dotenv import load_dotenv
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import PlainTextResponse
+
+from api.v1 import api_router
+from core.config import settings
+from services.etcd import EtcdClient
+from services.mongodb import MongoDB
+
+cli = typer.Typer()
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    # 启动时执行
+    async with MongoDB() as mongo:
+        with EtcdClient() as etcd:
+            await mongo.test_connection()
+            etcd.test_connection()
+            yield
+
+
+app = FastAPI(
+    title=settings.PROJECT_NAME,
+    openapi_url=f"{settings.API_V1_STR}/openapi.json",
+    lifespan=lifespan,
+)
+
+# 注册 v1 版本的所有路由
+app.include_router(api_router, prefix=settings.API_V1_STR)
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],  # 允许所有源，生产环境建议设置具体的源
+    # allow_credentials=True,
+    allow_methods=["*"],  # 允许所有 HTTP 方法
+    # allow_methods=["GET", "POST", "OPTIONS"],
+    allow_headers=["*"],  # 允许所有 headers
+)
+
+
+@app.get("/")
+async def root():
+    return {"message": "Welcome to Cron API"}
+
+
+@app.get("/ping", response_class=PlainTextResponse)
+async def pingpong():
+    return "pong"
+
+
+@cli.command()
+def run_app(
+    dotenv_path: str = "d:/.env",
+    host: str = "0.0.0.0",
+    port: int = 443,
+    ssl_keyfile: str | None = None,
+    ssl_certfile: str | None = None,
+    etcd_hosts: str | None = None,
+    mongo_url: str | None = None,
+):
+    load_dotenv(dotenv_path)
+    settings.reload()
+
+    if etcd_hosts is not None:
+        settings.ETCD_HOSTS = etcd_hosts
+    if mongo_url is not None:
+        settings.MONGO_URL = mongo_url
+
+    uvicorn.run(
+        "cron_api.main:app",
+        host=host,
+        port=port,
+        reload=False,
+        ssl_keyfile=ssl_keyfile,
+        ssl_certfile=ssl_certfile,
+    )

cronapi_py-0.1.0.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: cronapi-py
+Version: 0.1.0
+Summary: 定时任务api
+Requires-Python: >=3.10
+Requires-Dist: etcd3>=0.12.0
+Requires-Dist: fastapi>=0.115.5
+Requires-Dist: motor>=3.6.0
+Requires-Dist: protobuf<=3.20.0
+Requires-Dist: pydantic-settings>=2.6.1
+Requires-Dist: pydantic>=2.9.2
+Requires-Dist: typer>=0.13.1
+Requires-Dist: uvicorn>=0.32.0
+Description-Content-Type: text/markdown
+
+# Cron API
+
+自用 fastapi 项目,提供对应接口,通过命令行启动
+
+- etcd 配置定时任务
+- mongodb 查看任务执行日志
+
+#### 安装
+
+`pipx install cron-api` 或 `uv tool install cron-api`
+
+#### 运行
+
+`cron-api --help`
+
+```shell
+# CRON_API_MONGO_DB_NAME="cron"
+# 指定环境变量文件,环境变量文件需提供以上参数
+cron-api --dotenv-path .env
+# 还可以通过 --host, --port 指定fastapi启动地址和端口
+uv run cron-api --host 0.0.0.0 --port 8000 --ssl-keyfile d:/.ssh/mkcert/key.pem --ssl-certfile d:/.ssh/mkcert/cert.pem
+```

cronapi_py-0.1.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+api/v1/__init__.py,sha256=RdDWZw0DV_QzMVRH4umAgcjfFpgz6c-kQnnuYFutMjg,544
+api/v1/etcd.py,sha256=OMfdAZ-vEYka9e6_XiTFFLeArSXXnzsDQ2aWCGfGGOE,6133
+api/v1/mongo.py,sha256=hNGd4ZYE-rP5BxQZjlprGMUpe4FpcLk8HDFE8F7aYjQ,3371
+core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+core/config.py,sha256=N3jsPf-_Y2OgZTDjIxeUBgNFkVBkS_P7z-Vboh1Kab0,557
+core/consts.py,sha256=lEj7go5gihsRwXguuCAtTV_Rlh5snktp3Cl9kbPNiwY,150
+core/events.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cron_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cron_api/main.py,sha256=D0YmIZWO1dT3j3EpB3udhfUm23oL-_fhExJW_zj8eDs,2048
+models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+models/log.py,sha256=PtK3E5ZI0CXrG3N4l2sJwrO7ZkZi5OzYQ-tlA0rawFg,1134
+services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+services/etcd.py,sha256=yK1ryUwRpqSU64UQqa7_94_TTBQx2bcm6hKXP5LaXQM,2949
+services/mongodb.py,sha256=RoROeZkwACLxt8duO86IL9U6WKPjlsjOhZCmzsFkHyo,1553
+utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cronapi_py-0.1.0.dist-info/METADATA,sha256=yoX7iMmtkqbHebhkqxJRXj-L5BBUCvx3WdruY1g_9LQ,962
+cronapi_py-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+cronapi_py-0.1.0.dist-info/entry_points.txt,sha256=kYbNfD8jRGdHtFAEAecuybOQkwAA8EeACPkfYdnfer0,47
+cronapi_py-0.1.0.dist-info/RECORD,,

cronapi_py-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

cronapi_py-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cron-api = cron_api.main:cli

models/log.py

@@ -0,0 +1,29 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class Log(BaseModel):
+    jobName: str = Field(..., description="任务名称")
+    command: str = Field(..., description="执行的命令")
+    err: Optional[str] = Field(None, description="错误信息")
+    output: Optional[str] = Field(None, description="输出结果")
+    planTime: int = Field(..., description="计划执行时间")
+    scheduleTime: int = Field(..., description="实际调度时间")
+    startTime: int = Field(..., description="开始执行时间")
+    endTime: int = Field(..., description="执行结束时间")
+
+    class Config:
+        json_schema_extra = {
+            "example": {
+                "id": "job123456",
+                "jobName": "backup-task",
+                "command": "tar -czf backup.tar.gz /data",
+                "err": None,
+                "output": "backup completed successfully",
+                "planTime": 1711006245000,
+                "scheduleTime": 1711006245100,
+                "startTime": 1711006245200,
+                "endTime": 1711006248300,
+            }
+        }

services/etcd.py

@@ -0,0 +1,109 @@
+import functools
+
+import etcd3
+
+from core.config import settings
+
+
+def require_connection(func):
+    """确保client已初始化的装饰器"""
+
+    @functools.wraps(func)
+    def wrapper(self, *args, **kwargs):
+        if self.client is None:
+            raise RuntimeError("Etcd client not initialized. Call connect() first.")
+        return func(self, *args, **kwargs)
+
+    return wrapper
+
+
+class EtcdClient:
+    def __init__(self):
+        self.client = None
+
+    def connect(self):
+        """初始化etcd连接"""
+        if self.client is None:
+            host, port = settings.ETCD_HOSTS.split(":")
+            self.client = etcd3.client(
+                host=host,
+                port=int(port),
+                timeout=5,
+            )
+        return self.client
+
+    @require_connection
+    def test_connection(self):
+        """测试连接是否成功"""
+        status = self.client.status()
+        print(f"✅ 成功连接到etcd服务器: {status}")
+
+    @require_connection
+    def get_client(self):
+        """获取etcd客户端实例"""
+        return self.client
+
+    @require_connection
+    def get_prefix(self, key_prefix: str):
+        """
+        获取指定前缀的所有键值对
+
+        返回: 包含(value, metadata)元组的列表，如果没有匹配项返回空列表
+        """
+        results = list(self.client.get_prefix(key_prefix))
+        return results if results else []
+
+    @require_connection
+    def lease(self, ttl: int):
+        """
+        创建一个具有指定TTL(秒)的lease
+
+        参数:
+            ttl: lease的存活时间(秒)
+
+        返回:
+            lease对象
+        """
+        return self.client.lease(ttl)
+
+    @require_connection
+    def put(self, key: str, value: str, lease=None):
+        """
+        设置键值对
+
+        参数:
+            key: 键
+            value: 值
+            lease: 可选的lease ID
+        """
+        return self.client.put(key, value, lease=lease)
+
+    @require_connection
+    def get(self, key: str):
+        """获取指定键的值"""
+        return self.client.get(key)
+
+    @require_connection
+    def delete(self, key: str) -> bool:
+        """删除指定的键值对,成功返回True,键不存在返回False"""
+        return self.client.delete(key)
+
+    @require_connection
+    def delete_prefix(self, prefix: str) -> int:
+        """删除所有指定前缀的键值对，返回删除的数量"""
+        return self.client.delete_prefix(prefix)
+
+    def close(self):
+        """关闭etcd连接"""
+        if self.client:
+            self.client.close()
+            self.client = None
+
+    def __enter__(self):
+        """支持上下文管理器"""
+        self.connect()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """退出时自动关闭连接"""
+        self.close()

services/mongodb.py

@@ -0,0 +1,48 @@
+from motor.motor_asyncio import AsyncIOMotorClient
+
+from core.config import settings
+
+
+class MongoDB:
+    def __init__(self):
+        self.client: AsyncIOMotorClient = None
+        self.db = None
+
+    async def connect(self):
+        """初始化MongoDB连接"""
+        if self.client is None:
+            self.client = AsyncIOMotorClient(
+                settings.MONGO_URL,
+                serverSelectionTimeoutMS=5000,  # 服务器选择超时
+                connectTimeoutMS=5000,  # 连接超时
+                socketTimeoutMS=5000,  # socket超时
+            )
+            self.db = self.client[settings.MONGO_DB_NAME]
+        return self.client
+
+    async def test_connection(self):
+        """测试连接是否成功"""
+
+        server_info = await self.client.server_info()
+        print(f"✅ 成功连接到MongoDB服务器: {server_info.get('version', 'unknown')}")
+
+    def get_client(self):
+        """获取MongoDB客户端实例"""
+        if self.client is None:
+            raise RuntimeError("MongoDB client not initialized. Call connect() first.")
+        return self.client
+
+    async def close(self):
+        """关闭MongoDB连接"""
+        if self.client:
+            self.client.close()
+            self.client = None
+
+    async def __aenter__(self):
+        """支持异步上下文管理器"""
+        await self.connect()
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        """退出时自动关闭连接"""
+        await self.close()