pysrt 项目技术文档

1. 安装指南

pysrt 是一个用于编辑或创建 SubRip 文件的 Python 库。它可以通过 pip 或 easy_install 进行安装。

使用 pip 安装

$ sudo pip install pysrt

使用 easy_install 安装

$ sudo easy_install pysrt

pysrt 兼容 Python 2.6 及以上版本以及 Python 3。

2. 项目的使用说明

pysrt 主要设计为一个库，但也提供了一些命令行工具来处理字幕文件。以下是一些常见的使用场景：

命令行工具

时间偏移

$ srt -i shift 2s500ms movie.srt

分割字幕

$ srt split 58m26s movie.srt

调整帧率

$ srt -i rate 23.9 25 movie.srt

库的使用

导入库

>>> import pysrt

解析字幕文件

>>> subs = pysrt.open('some/file.srt')
# 如果遇到 UnicodeDecodeError，可以指定编码
>>> subs = pysrt.open('some/file.srt', encoding='iso-8859-1')

操作字幕

SubRipFile 对象类似于列表，包含多个 SubRipItem 实例。

>>> len(subs)
>>> first_sub = subs[0]

SubRipItem 实例是可编辑的，类似于纯 Python 对象。

>>> first_sub.text = "Hello World !"
>>> first_sub.start.seconds = 20
>>> first_sub.end.minutes = 5

时间偏移

>>> subs.shift(seconds=-2)  # 将所有字幕提前 2 秒
>>> subs.shift(minutes=1)   # 将所有字幕延后 1 分钟
>>> subs.shift(ratio=25/23.9)  # 将 23.9 fps 的字幕转换为 25 fps
>>> first_sub.shift(seconds=1)  # 将第一个字幕延后 1 秒
>>> first_sub.start += {'seconds': -1}  # 将第一个字幕提前 1 秒

删除字幕

>>> del subs[12]

切片操作

>>> part = subs.slice(starts_after={'minutes': 2, 'seconds': 30}, ends_before={'minutes': 3, 'seconds': 40})
>>> part.shift(seconds=-2)

保存更改

>>> subs.save('other/path.srt', encoding='utf-8')

3. 项目API使用文档

主要类和方法

pysrt.open(file_path, encoding=None)

• 功能: 打开并解析一个 SubRip 文件。
• 参数:
  • file_path: 字幕文件的路径。
  • encoding: 文件编码，可选。
• 返回值: 返回一个 SubRipFile 对象。

SubRipFile

• 属性:
  • shift(seconds=0, minutes=0, hours=0, ratio=None): 对所有字幕进行时间偏移。
  • slice(starts_after=None, ends_before=None): 对字幕进行切片操作。
  • save(file_path, encoding=None): 保存字幕文件。

SubRipItem

• 属性:
  • text: 字幕文本。
  • start: 字幕开始时间。
  • end: 字幕结束时间。
  • shift(seconds=0, minutes=0, hours=0, ratio=None): 对单个字幕进行时间偏移。

4. 项目安装方式

pysrt 可以通过以下两种方式进行安装：

使用 pip 安装

$ sudo pip install pysrt

使用 easy_install 安装

$ sudo easy_install pysrt

安装完成后，即可在 Python 脚本中导入并使用 pysrt 库。