📦 安装

CLI 安装

uv tool install "parsehub[cli]"
ph -v

Python 库安装

# uv
uv add parsehub

# 需要完整 CLI 能力时，可安装 `cli` 扩展
uv add "parsehub[cli]"

🚀 快速开始

CLI

解析链接或分享文案

parsehub "https://example.com/post/1"

# 短命令等价写法
ph "https://example.com/post/1"

下载媒体

ph d "https://example.com/post/1"

常用命令

配置会自动按平台应用到后续解析和下载; 临时覆盖时仍可直接传参数:

ph "https://example.com/post/1" --proxy http://127.0.0.1:7890
ph d "https://example.com/post/1" --parse-proxy http://127.0.0.1:7890 --cookie "key=value"

Python API

同步解析

from parsehub import ParseHub

ph = ParseHub()
result = ph.parse_sync("https://www.xiaoheihe.cn/app/bbs/link/174972336")
print(result)

dr = result.download_sync()
print(dr)

异步解析

import asyncio
from parsehub import ParseHub


async def main():
    ph = ParseHub()
    result = await ph.parse("https://tieba.baidu.com/p/9939510114")
    print(result)

    dr = await result.download()
    print(dr)


asyncio.run(main())

下载媒体

from parsehub import ParseHub

ph = ParseHub()
result = ph.download_sync("https://www.xiaoheihe.cn/app/bbs/link/174972336")
print(result)

🔑 高级用法

Cookie 登录与代理

需要登录态的平台可传 Cookie, 解析入口使用 cookie / proxy, 下载入口使用 parse_cookie / parse_proxy 作为解析阶段参数

当前支持 Cookie 的平台:

• Twitter / X
• Instagram
• Threads
• YouTube
• Bilibili
• 抖音
• TikTok
• 快手
• 小红书
• 知乎
• 豆瓣

from parsehub import ParseHub

ph = ParseHub()
result = ph.parse_sync(
    "https://example.com",
    cookie="key1=value1; key2=value2",
    proxy="http://127.0.0.1:7890",
)

Cookie 支持多种格式:

# Cookie header 字符串
ph.parse_sync("https://example.com", cookie="key1=value1; key2=value2")

# JSON 字符串
ph.parse_sync("https://example.com", cookie='{"key1": "value1", "key2": "value2"}')

# 字典
ph.parse_sync("https://example.com", cookie={"key1": "value1", "key2": "value2"})

下载进度回调

from parsehub import ParseHub
from parsehub.types import ProgressUnit


class ProgressTracker:
    async def __call__(self, current: int, total: int, unit: ProgressUnit, *args, task_name: str = "", **kwargs):
        print(f"[{task_name}] {current}/{total} ({unit})")


result = ParseHub().download_sync(
    "https://example.com",
    path="./downloads",
    callback=ProgressTracker(),
    callback_args=("extra_arg",),
    callback_kwargs={"task_name": "demo"},
)

unit 值:

• bytes: 单文件下载时的字节进度
• count: 多文件下载时的文件数量进度

保存 metadata.json

from parsehub import ParseHub

result = ParseHub().download_sync(
    "https://example.com",
    path="./downloads",
    save_metadata=True,
)

print(result.output_dir / "metadata.json")

全局配置

from pathlib import Path
from parsehub.config import GlobalConfig

GlobalConfig.default_save_dir = Path("./downloads")

错误处理

from parsehub import ParseHub
from parsehub.errors import ParseError, UnknownPlatform

try:
    result = ParseHub().parse_sync("https://example.com")
except UnknownPlatform:
    print("暂不支持该平台")
except ParseError as exc:
    print(f"解析失败: {exc}")

启用日志

from loguru import logger

logger.enable('parsehub')

🤝 参与贡献

欢迎提交 Pull Request 或 Issue!

• Bug 反馈请附上相关 URL 和日志信息

开发规范

提交代码前请至少执行:

ruff format && ruff check --fix && uv run mypy
uv run pytest

🤝 参考项目

• Evil0ctal/Douyin_TikTok_Download_API
• yt-dlp/yt-dlp
• instaloader/instaloader
• SocialSisterYi/bilibili-API-collect
• Nemo2011/bilibili-api
• cv-cat/ZhihuApis
• ucmao/media-parser

📜 开源协议

本项目基于 MIT License 开源