Skip to main content

Lemony LRC Parser

Python License: MIT PyPI

柠檬味的 Python LRC 歌词解析器.

Lemon-flavored LRC Parser for Python.

Features

  • 解析标准 LRC 歌词文件
  • 支持 EnhancedLRC / SPL 的逐字歌词标签
  • 支持 metadata 标签
  • 支持折叠时间标签
  • 支持参照行
  • 支持歌词合并
  • 与简单字幕格式 (SRT / WebVTT) 互转
  • 时间偏移 (apply_delta / << / >> 运算符)
  • 字典序列化 (to_dict() / from_dict())
  • 深拷贝方法链 (.copy())
  • 可配置解析与序列化选项
  • 数据一致性验证 API (validate_lyrics / Lyrics.validate())
  • 文本查找 (contains_text() / find_text())
  • 往返保真度不变量测试 (解析结果必过校验 / dumps 一轮收敛 / 行结构稳定)
  • CLI 命令行工具 (lemonyrics / python -m lemony_lrc_parser)
  • 解析错误附带行号与原始行 (InvalidLyricsError.line_no / .raw_line)
  • 完整的类型注解

Installation

推荐使用 uv.

It's recommended to use uv.

uv add lemony-lrc-parser

用 pip 也行.

It's okay to use pip.

pip install lemony-lrc-parser

可以使用 git 仓库来源来第一时间体验到最新最热的 bug feature.

You can use git repo as a source to catch the newest bugs features.

uv add https://github.com/NingmengLemon/lemony-lrc-parser.git

Usage

Quick Start

json, marshal or pickle -like usages

import lemony_lrc_parser as llp

lrc_text = """[ti: Never Gonna Give You Up]
[ar: Rick Astley]

[00:18.684]We're no strangers to love
[00:18.684]我们都是情场老手

[00:22.657]You know the rules and so do I
[00:22.657]你和我都知道爱情的规则

[00:27.070]A full commitment's what I'm thinking of
[00:27.070]我在想的正是一份实打实的承诺

[00:31.459]You wouldn't get this from any other guy
[00:31.459]你从其他人那里得不到的
"""

# 解析
lyrics = llp.loads(lrc_text)

# 访问 metadata
print(lyrics.metadata["ti"])  # "Never Gonna Give You Up"
print(lyrics.metadata["ar"])  # "Rick Astley"

# 遍历歌词行
for line in lyrics:
    print(f"{line.start}ms: {line.text}")

# 序列化回 LRC 格式
output = llp.dumps(lyrics)

OOP Interface

Lyrics 类提供面向对象的解析和序列化入口, 也推荐使用面向对象接口:

from lemony_lrc_parser import Lyrics

lyrics = Lyrics.loads(lrc_text)

# Lyrics 同时是序列容器
print(len(lyrics))  # 行数
print(lyrics[0].text)  # 第一行文本
print(lyrics[-1].text)

# 切片访问
first_three = lyrics[0:3]

# 序列化
lrc_output = lyrics.dumps()

# __str__ 等价于 dumps()
print(lyrics)

Word-level Lyrics

解析逐字 (Enhanced LRC / SPL) 歌词:

lrc_text = "[00:01.00]<00:01.00>Never <00:01.50>gonna <00:02.00>give <00:02.50>you <00:03.00>up[00:03.50]"

lyrics = llp.loads(lrc_text)
line = lyrics[0]

for word in line.content:
    print(f"  [{word.start} -> {word.end}] {word.content!r}")
    # [1000 -> 1500] 'Never '
    # [1500 -> 2000] 'gonna '
    # [2000 -> 2500] 'give '
    # [2500 -> 3000] 'you '
    # [3000 -> 3500] 'up'

# 行级时间: line.start=1000, line.end=3500
# (行尾的 [00:03.50] 会被当作该行的结束时间, 并反写到最后一个词元的 end)

Search (contains_text / find_text)

按文本查找请使用显式方法 —— in 在四个模型上的历史语义各不相同 (LyricToken / BasicLyricLine 是子串, LyricLine 是词元相等, Lyrics 是行相等), 所以 "xxx" in <模型> 保留旧行为但会发 DeprecationWarning:

from lemony_lrc_parser import Lyrics

lyrics = Lyrics.loads(lrc_text)

lyrics.contains_text("strangers")  # 任一行 (含参考行) 是否包含该子串
matching = lyrics.find_text("strangers")  # 命中的行对象列表
line = lyrics[0]
line.contains_text("strangers")  # 只搜主行
line.contains_text("情场老手", include_reference_lines=True)  # 连参考行一起搜

子串判定区分大小写; 需要忽略大小写时请自行 casefold() 后再比较.

Reference Lines (Translation / Transliteration)

LRC 文件中, 紧跟在带时间标签行后面的无标签行, 或与主行的时间戳相同的行, 会被解析为参考行, 常用于存放翻译或音译:

lrc_text = """[00:01.00]Hello
    你好
[00:02.00]World
[00:02.00]世界
"""

lyrics = llp.loads(lrc_text)

line = lyrics[0]
print(line.text)  # "Hello"
print(line.reference_lines[0][0].content)  # "你好"

Combining Lyrics

将两份歌词 (如原文和翻译) 按时间标签合并:

main = llp.loads("[00:01.00]Hello\n[00:02.00]World\n")
translation = llp.loads("[00:01.00]你好\n[00:02.00]世界\n")

# combine 方法: 翻译行挂到同时间点的 reference_lines 中
combined = main.combine(translation)

# 也可以用 + 运算符; 注意 + 固定使用 other_as_refline_only=False,
# 即另一方中时间戳对不上的行会作为新行保留, 不会被丢弃
combined = main + translation

for line in combined:
    print(line.text)  # 主歌词
    for ref in line.reference_lines:
        ref_text = "".join(w.content for w in ref)
        print(f"  -> {ref_text}")  # 参考行

# other_as_refline_only=False 时, 翻译中找不到对应时间点的行会作为新行保留
combined = main.combine(translation, other_as_refline_only=False)

Dict Serialization (to_dict / from_dict)

所有数据模型都支持字典序列化, 方便 JSON 传输和 API 对接:

import lemony_lrc_parser as llp
from lemony_lrc_parser import Lyrics

lyrics = llp.loads("[00:01.00]Hello\n[00:02.00]World\n")

# Lyrics → dict
data = lyrics.to_dict()
# {"metadata": {}, "lines": [{"start": 1000, ...}, ...]}

# dict → Lyrics
restored = Lyrics.from_dict(data)

# 也可以对单行、单行内容、单个词元分别操作
line = lyrics[0]
line_dict = line.to_dict()
token_dict = line.content[0].to_dict()

Copy

所有数据模型都提供 .copy() 深拷贝方法, 返回独立的副本:

import lemony_lrc_parser as llp

lyrics = llp.loads("[00:01.00]Hello\n")

# 深拷贝
clone = lyrics.copy()
clone.metadata["ti"] = "New Title"

# 原始对象不受影响
print(lyrics.metadata.get("ti"))  # None

Options

Parsing Options

import re
from lemony_lrc_parser import Lyrics, ParseOptions

lrc_text = "[00:01.000]Hello\n[00:05.000]World\n"

lyrics = Lyrics.loads(
    lrc_text,
    options=ParseOptions(
        fill_implicit_line_end=True,  # 是否填充隐式行尾时间
        line_filter=r"纯音乐.*?请欣赏",  # 黑名单过滤 (统一按正则理解, str 会被自动 compile)
        # line_filter=re.compile(r"纯音乐.*?请欣赏"),  # 也可直接传入已编译的正则
    ),
)

# lyrics[0].end == lyrics[1].start == 5000

line_filter 的内容是正则表达式: 传入的字符串会被 re.compile 编译, 之后用 pattern.search 匹配每行文本, 命中的行会被丢弃. 若需要精确的子串匹配 (而非正则), 请用 re.escape(...) 包一层, 例如 line_filter=re.escape("a.c").

过滤只按主行文本判定: 与主行同一时间戳的参考行 (翻译/音译) 会随主行一起被 丢弃, 即使它自身的文本并不匹配.

Serialization Options

通过 SerializationOptions 控制序列化行为:

from lemony_lrc_parser import Lyrics, SerializationOptions

output = lyrics.dumps(
    options=SerializationOptions(
        with_metadata=True,  # 是否输出 metadata 段
        use_bracket_for_byword_tag=False,  # 逐字标签使用 [...] 还是 <...> (默认; True 不保证往返, 见下)
        line_tag_decimal_length=3,  # 行标签毫秒位数 (默认 3)
        word_tag_decimal_length=3,  # 逐字标签毫秒位数 (默认 3)
        line_separator="\n",  # 行间分隔字符串 (默认 "\n", 设为 "" 可省去空行)
    ),
)

Length of Decimal Part

默认 line_tag_decimal_length=3、word_tag_decimal_length=3, 输出格式如 [00:01.000]、<00:01.050>, 保留完整的毫秒精度. 若设为 2, 小数部分表示百分秒 (如 [00:01.00]), 属于有损截断 (例如 555ms 会被截断为 55, 解析回来变成 550ms), 需要按需权衡 (部分老软件可能只支持百分秒).

往返保真度

dumps() 的输出在重新解析后应当尽量还原原对象. 以下三种写法是 LRC 格式本身的 歧义所致, 本库采取"照常写出 + warning"的策略 (与 metadata 的处理一致), 不会静默 丢弃数据, 但重新解析的结果会与原对象不同:

情形 写出的文本 重新解析的结果
空正文 + 显式行尾 [00:01.000][00:02.000] 两个空占位行 (行数翻倍)
use_bracket_for_byword_tag=True 且首词元晚于行首 [00:01.000][00:01.500]hello 两行, 文本重复
正文只有空白且不带行尾 [00:01.000] 正文变为空

另外, 行尾时间若由逐字标签推断而来且与行首时间矛盾 (end <= start), 该推断会被 丢弃 (line.end 置回 None) 并产生 warning —— 解析器不会产出 validate() 判为 error 的行.

Metadata 语法

[key: value] 只有整行都由该形式构成时才算 metadata: 正文中间的 [key: value] 不会把整行吞掉 (例如 Return [to: sender] now 仍是一行歌词或参考行).

value 里的方括号必须配对:

import lemony_lrc_parser as llp

llp.loads("[al: Album [Deluxe]]\n[00:01.000]x\n").metadata
# {'al': 'Album [Deluxe]'}   ← 原样保留 (取"配对的第一个 ]"作为边界)

不平衡的写法 (如 [ti: 50% ]off]、[ti: a [b]) 无法确定 value 边界, 整行按普通 正文处理, 写出这类 value 时也会 warning. 本库不采用反斜杠转义: LRC 家族没有 标准转义语法, 转义会自造方言并破坏含反斜杠的既有 value (调研结论见 docs/feature-ideas.md 的"已关闭 / 不计划").

常见 key 的类型提示见 MetadataKey / MetadataDict / COMMON_METADATA_KEYS —— 它们只是提示, 库既不校验也不限制其它 key (真实语料里常见 ly、mu、total、tool).

Offset

使用 Lyrics.apply_delta(ms) 应用时间偏移, ms 会直接加到每个标签的时间戳上, 这意味着传入正数偏移值会导致歌词整体延后出现, 反之同理.

也可以使用重载的 >> / << 运算, 私以为这样会更好理解一些.

如果应用 offset 会导致时间戳变为负数, 将抛出 TimestampUnderflowError, 由调用方自行处理.

Applying Offset

通过 Lyrics.apply_delta(ms) 对时间戳应用偏移, 返回一个新对象:

from lemony_lrc_parser import Lyrics

lyrics = Lyrics.loads(lrc_text)

# 正数 → 歌词延后出现 (等价于 lyrics >> 500)
shifted = lyrics.apply_delta(500)

# 负数 → 歌词提前出现 (等价于 lyrics << 500)
shifted = lyrics.apply_delta(-500)

# 使用 << / >> 运算符
shifted = lyrics >> 500  # 延后 500ms
shifted = lyrics << 500  # 提前 500ms

# shifted 的时间戳已被整体偏移, 原始 lyrics 不受影响

如果偏移会导致时间戳变为负数, 将抛出 TimestampUnderflowError.

如需在序列化前偏移时间戳, 请先调用 apply_delta() 再序列化返回的副本. 如果你的偏移量来自歌词文件元数据, 你可能还需要记得手动清理 lyrics.metadata 中的偏移值.

与 LRC [offset:...] 的符号差异

注意两者符号相反, 混用会让歌词往反方向跑:

  • LRC 的 [offset: +N] 按社区文档与主流实现是"歌词整体提前 N 毫秒", 即时间戳 -= N(调研);
  • 本库的 apply_delta(+ms) 是"时间戳 += ms", 即歌词延后。

所以从 metadata 应用 offset 的正确写法是取负号:

from lemony_lrc_parser import Lyrics

lyrics = Lyrics.loads("[offset: 500]\n[00:10.000]hello\n")
shifted = lyrics.apply_delta(-int(lyrics.metadata["offset"]))
print(shifted[0].start)  # 9500 —— 提前了 500ms

本库不会自动应用 offset(显式优于隐式, 而且有播放器完全忽略它); 上面这条换算关系有专门的回归测试 (tests/test_offset.py::TestLrcOffsetConvention).

也可以通过 min_timestamp / max_timestamp 快速检查歌词的时间范围:

from lemony_lrc_parser.offset import min_timestamp, max_timestamp

lyrics = Lyrics.loads(lrc_text)
print(min_timestamp(lyrics))  # 最小时间戳 (ms), 无时间戳时为 None
print(max_timestamp(lyrics))  # 最大时间戳 (ms), 无时间戳时为 None

Validation

使用 lyrics.validate() 检查歌词数据一致性:

from lemony_lrc_parser import Lyrics, ValidationOptions

lyrics = Lyrics.loads(lrc_text)

# 返回问题列表
issues = lyrics.validate()
for issue in issues:
    print(f"[{issue.severity}] {issue.code}: {issue.message}")

# strict 模式: 遇到 error 级问题时抛出 InvalidLyricsError
issues = lyrics.validate(options=ValidationOptions(strict=True))

检查项包括:

  • 歌词行是否按时间升序排列 (unsorted)
  • 是否存在重复时间戳 (duplicate-start)
  • 行结束时间是否晚于开始时间 (end-not-after-start)
  • 逐字 token 时间是否单调递增 (token-nonmonotonic)
  • 逐字 token 自身区间是否合法 (token-end-not-after-start)
  • 逐字 token 是否在所属行的时间范围内 (token-before-line-start / token-after-line-end)
  • metadata key 格式合法性 (invalid-metadata-key)
  • offset 元数据是否可解析为整数 (offset-not-int)

error 与 warning 的分工: 由解析器写出的数据不会包含任何 error 级问题 (见 tests/test_roundtrip_matrix.py 的不变量测试), 因此出现 error 通常意味着 调用方手工构造了自相矛盾的对象.

CLI Usage

安装后可通过命令行直接使用:

# 验证 LRC 文件数据一致性
lemonyrics validate song.lrc
lemonyrics validate --strict song.lrc    # 有 error 时退出码为 1

# 整体时间偏移 (毫秒)
lemonyrics offset --delta 500 song.lrc           # 输出到 stdout
lemonyrics offset --delta -200 song.lrc -o out.lrc  # 输出到文件

# 转换为字幕格式
lemonyrics to-srt song.lrc
lemonyrics to-webvtt song.lrc -o song.vtt

也可以使用 python -m lemony_lrc_parser 作为入口.

Subtitle Conversion (SRT / WebVTT)

Lyrics 可与常见的简单字幕格式互相转换, 便于把歌词用于视频字幕制作, 或把已有字幕导入为歌词:

from lemony_lrc_parser import Lyrics, SubtitleOptions

lyrics = Lyrics.loads("[00:01.000]Hello\n[00:03.000]World\n")

# LRC → SRT / WebVTT
srt_text = lyrics.to_srt()
vtt_text = lyrics.to_webvtt()

# SRT / WebVTT → LRC
lyrics2 = Lyrics.from_srt(srt_text)
lyrics3 = Lyrics.from_webvtt(vtt_text)

# 顶层便捷函数也可用
import lemony_lrc_parser as llp

srt_text = llp.dump_srt(lyrics)
vtt_text = llp.dump_webvtt(lyrics)
lyrics2 = llp.parse_srt(srt_text)
lyrics3 = llp.parse_webvtt(vtt_text)

字幕以 [start, end] 时间区间为单位, 与 LRC 存在语义差异, 转换时的行为可通过 SubtitleOptions 控制:

options = SubtitleOptions(
    fill_end_from_next=True,  # 缺少行尾时间时, 用下一行的 start 补齐
    default_duration_ms=5000,  # 无法推断时长时使用的默认时长 (也用于修正非法区间)
    include_reference_lines=True,  # 是否把参考行 (翻译/音译) 作为 cue 附加文本输出
)

srt_text = lyrics.to_srt(options=options)

转换注意事项:

  • LRC 的逐字标签与 metadata 不会写入字幕 (会被拍平/丢弃).
  • 导出时若某行缺少 end, 会依次尝试用下一行 start 或 default_duration_ms 补齐; end <= start 的非法区间也会被修正.
  • 一条字幕 cue 可含多行文本: 导出时主行在前、参考行在后; 解析时 cue 首行作为主行, 其余行作为参考行.
  • 解析会自动跳过 WebVTT 的 WEBVTT 头部以及 NOTE / STYLE / REGION 块.

References

UwU?

UwU!

License

MIT License

Metadata

Release files for lemony-lrc-parser 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lemony-lrc-parser 0.4.0
File Size Uploaded
lemony_lrc_parser-0.4.0.tar.gz 215.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lemony-lrc-parser 0.4.0
File Interpreter ABI Platform
lemony_lrc_parser-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 264.8 kB

Release files / lemony_lrc_parser-0.4.0.tar.gz

Download URL lemony_lrc_parser-0.4.0.tar.gz
Size 215.4 kB
Tags Source
SHA-256 checksum
How to use checksums
ab7f489296b5499273f68b58d5a08a33328d56808249d004212aa022c582ba8e
BLAKE2b-256 checksum
How to use checksums
650f5fc755f2acd38a629d73de33e4f559f03287d86106c46455cef641d60d31
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.3

Release files / lemony_lrc_parser-0.4.0-py3-none-any.whl

Download URL lemony_lrc_parser-0.4.0-py3-none-any.whl
Size 49.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b899aa72214f8ddd673439e9737f793b9e210a7b2ea28ff5db9b5fe999c8f7ef
BLAKE2b-256 checksum
How to use checksums
f0e7d93340fc11dbe1b745da104f0c3de14c2541ffb2cd40fcd5a6b62af6cc56
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page