spidermanager-sdk 0.1.5.dev0

极简 Python SDK，将爬虫采集数据通过 HTTP 异步中转至 SpiderManager 后端

SpiderManager SDK

极简 Python SDK，将爬虫采集数据通过 HTTP 异步中转至 SpiderManager 后端，实现爬虫逻辑与数据存储的完全解耦。

特性

• 零配置启动：自动从环境变量 TASK_ID / SPIDER_API_URL 读取配置
• 异步缓冲：内存 buffer 按阈值（20条）或时间窗口（3秒）批量上报，减少网络 IO
• 容器安全：通过 atexit + SIGTERM 双保险，确保 Docker 销毁前 flush 全部数据
• 最小依赖：仅依赖 httpx，不侵入爬虫业务代码

安装

pip install spidermanager-sdk

快速开始

from spidermanager_sdk import sdk

# 初始化（容器中自动读取环境变量，本地开发可手动指定）
sdk.init(api_url="http://localhost:8000", task_id="task-001")

# 上报数据（会自动缓冲、批量上报）
sdk.insert("articles", {"title": "Hello", "url": "https://example.com"})

# 批量上报
sdk.insert("articles", [
    {"title": "A", "url": "https://a.com"},
    {"title": "B", "url": "https://b.com"},
])

# 程序结束时自动 flush，也可手动触发
sdk.flush()

配置选项

参数	环境变量	默认值	说明
api_url	SPIDER_API_URL	—	后端地址
task_id	TASK_ID	—	任务 ID
buffer_size	—	20	缓冲条数阈值
flush_interval	—	3.0	时间窗口（秒）

异步 API (Asyncio)

由于爬虫开发经常使用 httpx, aiohttp, Playwright 等异步工具，SDK 也提供了原生的 Async 接口。 推荐使用 async with 上下文管理器，离开上下文时将自动触发 flush。

import asyncio
from spidermanager_sdk.aio import async_sdk

async def main():
    # 自动读取环境变量并初始化，退出时自动 flush
    async with async_sdk:
        await async_sdk.insert("articles", {"title": "Async Data", "url": "https://a.com"})
        
        # 批量插入
        await async_sdk.insert("articles", [
            {"title": "B", "url": "https://b.com"},
            {"title": "C", "url": "https://c.com"},
        ])

if __name__ == "__main__":
    asyncio.run(main())

架构

sdk.insert()
    ↓
FlushBuffer (内存缓冲, 线程安全)
    ↓  条数阈值 / 定时器触发
HttpTransport.send_batch()
    ↓
POST /api/tasks/data/ingest?task_id=xxx