## Purpose 文件编码自动检测能力,支持多种编码格式的自动识别和回退机制。 ## Requirements ### Requirement: 文件编码自动检测 系统 SHALL 使用 chardet 库自动检测文件编码,支持多种常见编码格式。 #### Scenario: 使用 chardet 检测编码 - **WHEN** 需要读取文本文件 - **THEN** 系统使用 chardet 库检测文件编码 #### Scenario: 检测成功返回编码 - **WHEN** chardet 成功检测编码 - **THEN** 系统返回检测到的编码名称 #### Scenario: chardet 库未安装 - **WHEN** chardet 库未安装 - **THEN** 系统返回错误信息 "chardet 库未安装" #### Scenario: 检测失败返回错误 - **WHEN** chardet 检测失败 - **THEN** 系统返回错误信息包含失败原因 ### Requirement: 编码回退机制 系统 SHALL 在 chardet 检测失败时,按配置的编码列表依次尝试读取文件。 #### Scenario: chardet 失败时尝试回退编码 - **WHEN** chardet 检测失败或返回错误 - **THEN** 系统按 Config.FALLBACK_ENCODINGS 列表依次尝试编码 #### Scenario: 回退编码成功 - **WHEN** 某个回退编码成功读取文件 - **THEN** 系统返回文件内容 #### Scenario: 所有编码均失败 - **WHEN** 所有回退编码均无法读取文件 - **THEN** 系统返回错误信息 "无法识别文件编码" ### Requirement: 统一文本文件读取接口 系统 SHALL 提供统一的文本文件读取函数,自动处理编码检测和回退。 #### Scenario: 调用 read_text_file 读取文件 - **WHEN** 调用 read_text_file(file_path) - **THEN** 系统自动检测编码并返回文件内容 #### Scenario: 读取成功返回内容 - **WHEN** 文件读取成功 - **THEN** 系统返回 (content, None) #### Scenario: 读取失败返回错误 - **WHEN** 文件读取失败 - **THEN** 系统返回 (None, error_message) ### Requirement: 支持常见中文编码 系统 SHALL 在回退编码列表中包含常见中文编码格式。 #### Scenario: 回退编码包含 UTF-8 - **WHEN** 使用回退编码列表 - **THEN** 列表包含 'utf-8' #### Scenario: 回退编码包含 GBK - **WHEN** 使用回退编码列表 - **THEN** 列表包含 'gbk' #### Scenario: 回退编码包含 GB2312 - **WHEN** 使用回退编码列表 - **THEN** 列表包含 'gb2312' #### Scenario: 回退编码包含 Latin-1 - **WHEN** 使用回退编码列表 - **THEN** 列表包含 'latin-1' ### Requirement: 编码检测模块独立 系统 SHALL 将编码检测功能实现为独立模块,便于复用。 #### Scenario: 编码检测在独立文件 - **WHEN** 使用编码检测功能 - **THEN** 从独立的 encoding_detection.py 模块导入 #### Scenario: 提供 detect_encoding 函数 - **WHEN** 需要仅检测编码不读取内容 - **THEN** 系统提供 detect_encoding(file_path) 函数 #### Scenario: 提供 read_text_file 函数 - **WHEN** 需要检测编码并读取内容 - **THEN** 系统提供 read_text_file(file_path) 函数