## 功能特性 - 建立统一的项目结构,包含 core/、readers/、utils/、tests/ 模块 - 迁移 lyxy-reader-office 的所有解析器(docx、xlsx、pptx、pdf) - 迁移 lyxy-reader-html 的所有解析器(html、url 下载) - 统一 CLI 入口为 lyxy_document_reader.py - 统一 Markdown 后处理逻辑 - 按文件类型组织 readers,每个解析器独立文件 - 依赖分组按文件类型细分(docx、xlsx、pptx、pdf、html、http) - PDF OCR 解析器优先,无参数控制 - 使用 logging 模块替代简单 print - 设计完整的单元测试结构 - 重写项目文档 ## 新增目录/文件 - core/ - 核心模块(异常体系、Markdown 工具、解析调度器) - readers/ - 格式阅读器(base.py + docx/xlsx/pptx/pdf/html) - utils/ - 工具函数(文件类型检测) - tests/ - 测试(conftest.py + test_core/ + test_readers/ + test_utils/) - lyxy_document_reader.py - 统一 CLI 入口 ## 依赖分组 - docx - DOCX 文档解析支持 - xlsx - XLSX 文档解析支持 - pptx - PPTX 文档解析支持 - pdf - PDF 文档解析支持(含 OCR) - html - HTML/URL 解析支持 - http - HTTP/URL 下载支持 - office - Office 格式组合(docx/xlsx/pptx/pdf) - web - Web 格式组合(html/http) - full - 完整功能 - dev - 开发依赖
95 lines
3.1 KiB
Markdown
95 lines
3.1 KiB
Markdown
## ADDED Requirements
|
|
|
|
### Requirement: XLSX 文档解析
|
|
系统 SHALL 支持解析 XLSX 格式文档,按优先级尝试多个解析器。
|
|
|
|
#### Scenario: 按优先级尝试解析器
|
|
- **WHEN** 解析 XLSX 文档
|
|
- **THEN** 系统按 docling → unstructured → markitdown → pandas → XML原生解析的顺序尝试
|
|
|
|
#### Scenario: 成功解析
|
|
- **WHEN** 任一解析器成功
|
|
- **THEN** 系统返回解析结果
|
|
|
|
#### Scenario: 所有解析器失败
|
|
- **WHEN** 所有解析器均失败
|
|
- **THEN** 系统返回失败列表并退出非零状态码
|
|
|
|
### Requirement: docling 解析器
|
|
系统 SHALL 支持使用 docling 库解析 XLSX。
|
|
|
|
#### Scenario: docling 解析成功
|
|
- **WHEN** docling 库可用且文档有效
|
|
- **THEN** 系统返回 Markdown 内容
|
|
|
|
#### Scenario: docling 库未安装
|
|
- **WHEN** docling 库未安装
|
|
- **THEN** 系统尝试下一个解析器
|
|
|
|
### Requirement: unstructured 解析器
|
|
系统 SHALL 支持使用 unstructured 库解析 XLSX。
|
|
|
|
#### Scenario: unstructured 解析成功
|
|
- **WHEN** unstructured 库可用且文档有效
|
|
- **THEN** 系统返回 Markdown 内容
|
|
|
|
#### Scenario: unstructured 库未安装
|
|
- **WHEN** unstructured 库未安装
|
|
- **THEN** 系统尝试下一个解析器
|
|
|
|
### Requirement: markitdown 解析器
|
|
系统 SHALL 支持使用 markitdown 库解析 XLSX。
|
|
|
|
#### Scenario: markitdown 解析成功
|
|
- **WHEN** markitdown 库可用且文档有效
|
|
- **THEN** 系统返回 Markdown 内容
|
|
|
|
#### Scenario: markitdown 库未安装
|
|
- **WHEN** markitdown 库未安装
|
|
- **THEN** 系统尝试下一个解析器
|
|
|
|
### Requirement: pandas 解析器
|
|
系统 SHALL 支持使用 pandas 库解析 XLSX。
|
|
|
|
#### Scenario: pandas 解析成功
|
|
- **WHEN** pandas 和 tabulate 库可用且文档有效
|
|
- **THEN** 系统返回 Markdown 内容,每个工作表用二级标题分隔,数据以表格形式展示
|
|
|
|
#### Scenario: pandas 库未安装
|
|
- **WHEN** pandas 或 tabulate 库未安装
|
|
- **THEN** 系统尝试下一个解析器
|
|
|
|
### Requirement: XML 原生解析器
|
|
系统 SHALL 支持使用 XML 原生解析 XLSX。
|
|
|
|
#### Scenario: XML 原生解析成功
|
|
- **WHEN** 文档有效
|
|
- **THEN** 系统返回 Markdown 内容,每个工作表用二级标题分隔,数据以表格形式展示,过滤全空列
|
|
|
|
#### Scenario: XML 原生解析失败
|
|
- **WHEN** XML 原生解析失败
|
|
- **THEN** 系统返回失败信息
|
|
|
|
### Requirement: 每个解析器独立文件
|
|
系统 SHALL 将每个解析器实现为独立的单文件模块。
|
|
|
|
#### Scenario: docling 解析器在独立文件
|
|
- **WHEN** 使用 docling 解析器
|
|
- **THEN** 从 readers/xlsx/docling.py 导入
|
|
|
|
#### Scenario: unstructured 解析器在独立文件
|
|
- **WHEN** 使用 unstructured 解析器
|
|
- **THEN** 从 readers/xlsx/unstructured.py 导入
|
|
|
|
#### Scenario: markitdown 解析器在独立文件
|
|
- **WHEN** 使用 markitdown 解析器
|
|
- **THEN** 从 readers/xlsx/markitdown.py 导入
|
|
|
|
#### Scenario: pandas 解析器在独立文件
|
|
- **WHEN** 使用 pandas 解析器
|
|
- **THEN** 从 readers/xlsx/pandas.py 导入
|
|
|
|
#### Scenario: XML 原生解析器在独立文件
|
|
- **WHEN** 使用 XML 原生解析器
|
|
- **THEN** 从 readers/xlsx/native_xml.py 导入
|