Tartube插件开发：如何扩展功能支持更多视频网站

Tartube插件开发：如何扩展功能支持更多视频网站

【免费下载链接】tartubeA GUI front-end for youtube-dl, partly based on youtube-dl-gui and written in Python 3 / Gtk 3项目地址: https://gitcode.com/gh_mirrors/ta/tartube

Tartube作为一款基于youtube-dl和yt-dlp的GUI前端工具，默认支持众多视频网站，但开发者可能需要扩展其功能以支持更多平台。本文将详细介绍如何为Tartube开发插件，实现对新视频网站的支持，包括配置文件修改、自定义提取器开发以及集成测试等关键步骤。

了解Tartube的视频网站支持机制

Tartube通过集成youtube-dl/yt-dlp的提取器来支持各种视频网站。这些提取器定义了不同网站的视频解析规则。要添加新网站支持，需理解Tartube如何加载和使用这些提取器。

在Tartube的代码中，formats.py文件定义了增强型网站（Enhanced Sites）的配置，包括检测规则、URL模板等。例如，YouTube的配置如下：

{ 'name': 'youtube', 'pretty_name': 'YouTube', 'detect_list': [r'^https?://(www\.)?youtube\.com/'], 'extract_vid_list': [r'^https?://(www\.)?youtube\.com/watch\?v=([^/]+)'], 'rss_channel_list': ['https://www.youtube.com/feeds/videos.xml?channel_id= ci '], # 其他配置... }

这段代码定义了YouTube的URL检测正则表达式、视频ID提取规则以及RSS订阅模板。

Tartube默认支持的部分视频网站，通过扩展可添加更多平台

步骤一：修改配置文件添加网站定义

最简单的扩展方式是通过修改formats.py文件，为新网站添加配置。以下是添加示例网站（如"ExampleVideo"）的步骤：

1. 定义网站检测规则：在enhanced_setup_list中添加新条目，包含网站名称、检测正则表达式等。

   { 'name': 'examplevideo', 'pretty_name': 'Example Video Site', 'detect_list': [r'^https?://(www\.)?examplevideo\.com/'], 'extract_vid_list': [r'^https?://(www\.)?examplevideo\.com/watch\?v=([^/]+)'], 'rss_channel_list': ['https://www.examplevideo.com/feeds/videos.xml?channel_id= ci '], }

2. 添加URL模板：定义视频、频道、播放列表的URL转换模板，使用占位符如vi（视频ID）、ci（频道ID）。

3. 更新语言支持：在language_setup_list中添加网站名称的翻译（如果需要）。

步骤二：开发自定义提取器（高级）

对于复杂网站，可能需要编写自定义提取器。Tartube依赖youtube-dl/yt-dlp的提取器架构，因此可参考其开发规范：

1. 创建提取器类：新建Python文件（如example_extractor.py），定义继承自InfoExtractor的类。

   from yt_dlp.extractor.common import InfoExtractor class ExampleVideoIE(InfoExtractor): _VALID_URL = r'https?://(www\.)?examplevideo\.com/watch\?v=(?P<id>[a-zA-Z0-9]+)' def _real_extract(self, url): video_id = self._match_id(url) # 解析网页，提取视频标题、URL等信息 return { 'id': video_id, 'title': 'Example Video Title', 'url': 'https://examplevideo.com/api/video/' + video_id, }

2. 注册提取器：在Tartube的提取器加载逻辑中注册新提取器。修改ttutils.py中的generate_ytdl_system_cmd函数，确保自定义提取器被包含。

3. 测试提取器：使用yt-dlp命令行测试提取器功能：

   yt-dlp --extractor-descriptions ExampleVideoIE https://examplevideo.com/watch?v=12345

步骤三：集成与测试

1. 配置Tartube使用自定义提取器：

   • 将提取器文件放入Tartube的extractors目录（需创建）。
   • 修改ttutils.py中的generate_ytdl_system_cmd函数，添加--load-info-extractors参数指向自定义提取器目录：

     mod_options_list.append('--load-info-extractors') mod_options_list.append('/path/to/custom/extractors')

2. 测试网站支持：

   • 在Tartube中添加新网站的视频URL，检查是否能正确解析和下载。
   • 查看日志文件（~/.config/tartube/logs/tartube.log）排查错误。

在Tartube中添加新支持的视频网站URL

步骤四：打包与分享插件

1. 创建插件结构：按以下结构组织文件：

   example_plugin/ ├── extractors/ │ └── example_extractor.py ├── formats.patch # 修改formats.py的补丁 └── README.md

2. 编写安装脚本：提供自动应用补丁和复制提取器的脚本：

   # 应用formats.py补丁 patch /path/to/tartube/formats.py < formats.patch # 复制提取器 cp extractors/*.py /path/to/tartube/extractors/

3. 发布插件：在GitHub等平台分享插件，提供安装说明。

常见问题与解决方案

• 提取器不被加载：检查提取器类是否正确继承InfoExtractor，并确保Tartube的启动命令包含--load-info-extractors。
• 视频解析失败：使用yt-dlp -v调试，检查正则表达式是否匹配URL，网页结构是否变化。
• 依赖冲突：确保自定义提取器与Tartube使用的youtube-dl/yt-dlp版本兼容。

通过以上步骤，开发者可以为Tartube扩展对新视频网站的支持，丰富其功能生态。Tartube的模块化设计使得插件开发相对简单，同时也支持通过配置文件快速添加简单网站的支持。

【免费下载链接】tartubeA GUI front-end for youtube-dl, partly based on youtube-dl-gui and written in Python 3 / Gtk 3项目地址: https://gitcode.com/gh_mirrors/ta/tartube