lanyuanxiaoyao
01eacb0b97
支持在 YAML 源文件中直接定义模板，无需单独的模板文件。 简化单文档编写流程，降低模板系统使用门槛。 核心功能： - 在 YAML 顶层新增 templates 字段定义内联模板 - 支持变量替换、条件渲染、默认值等完整模板功能 - 内联模板优先于外部模板查找 - 同名冲突检测：禁止内联和外部模板同名 - 相互引用检测：禁止内联模板之间相互引用 - 完整的错误处理和验证机制 代码变更： - core/template.py: 新增 from_data() 类方法 - core/presentation.py: 支持内联模板查找和冲突检测 - loaders/yaml_loader.py: 新增 validate_templates_yaml() 验证 - validators/: 扩展验证器支持内联模板 测试： - 新增 9 个内联模板专项测试 - 修复 1 个变量验证测试 - 所有 333 个测试通过 文档： - README.md: 添加内联模板使用指南和最佳实践 - README_DEV.md: 说明实现细节和设计决策 完全向后兼容，不使用 templates 字段时行为不变。
55 lines
3.8 KiB
Markdown
55 lines
3.8 KiB
Markdown
## 1. 核心功能实现
|
|
|
|
- [x] 1.1 在 `core/template.py` 中新增 `from_data()` 类方法，支持从字典创建模板实例
|
|
- [x] 1.2 修改 `core/presentation.py` 的 `__init__` 方法，解析并保存 `templates` 字段到 `self.inline_templates`
|
|
- [x] 1.3 修改 `core/presentation.py` 的 `get_template()` 方法，实现同名模板检测并抛出 ERROR 错误
|
|
- [x] 1.4 在 `loaders/yaml_loader.py` 中新增 `validate_templates_yaml()` 函数，验证 `templates` 字段结构
|
|
- [x] 1.5 修改 `loaders/yaml_loader.py` 的 `validate_presentation_yaml()` 函数，调用 `validate_templates_yaml()` 进行验证
|
|
|
|
## 2. 验证逻辑实现
|
|
|
|
- [x] 2.1 实现 `validate_templates_yaml()` 中的模板结构验证：检查 `templates` 是否为字典
|
|
- [x] 2.2 实现 `validate_templates_yaml()` 中的模板元素验证：检查每个模板是否有必需的 `elements` 字段
|
|
- [x] 2.3 实现 `validate_templates_yaml()` 中的变量定义验证：检查每个变量是否有必需的 `name` 字段
|
|
- [x] 2.4 实现 `validate_templates_yaml()` 中的默认值验证：检测默认值中引用不存在的变量
|
|
|
|
## 3. 错误处理实现
|
|
|
|
- [x] 3.1 在 `core/presentation.py` 的 `get_template()` 中添加同名模板检测逻辑，抛出 ERROR 错误
|
|
- [x] 3.2 在 `core/template.py` 的 `render()` 方法中添加内联模板相互引用的检测逻辑
|
|
- [x] 3.3 优化错误消息格式，包含模板名称和具体位置信息（已在上述实现中完成）
|
|
- [x] 3.4 实现循环引用检测：防止内联模板自引用（已在任务 3.2 中实现）
|
|
|
|
## 4. 测试用例实现
|
|
|
|
- [x] 4.1 在 `tests/unit/test_template.py` 中新增 `from_data()` 方法的单元测试
|
|
- [x] 4.2 在 `tests/unit/test_presentation.py` 中新增内联模板查找的单元测试
|
|
- [x] 4.3 在 `tests/unit/test_loaders/test_yaml_loader.py` 中新增 `validate_templates_yaml()` 的测试用例
|
|
- [x] 4.4 在 `tests/integration/test_presentation.py` 中新增内联模板集成测试
|
|
- [x] 4.5 新增内联模板基本使用场景测试：定义、引用、变量替换、条件渲染
|
|
- [x] 4.6 新增同名模板报错测试：验证内联和外部模板同名时系统抛出 ERROR
|
|
- [x] 4.7 新增内联模板错误处理测试：验证各种错误场景的错误消息和级别
|
|
- [x] 4.8 新增向后兼容性测试：验证不使用 `templates` 字段时系统行为不变
|
|
- [x] 4.2 在 `tests/unit/test_presentation.py` 中新增内联模板查找的单元测试
|
|
- [x] 4.3 在 `tests/unit/test_loaders/test_yaml_loader.py` 中新增 `validate_templates_yaml()` 的测试用例
|
|
- [x] 4.4 在 `tests/integration/test_presentation.py` 中新增内联模板集成测试
|
|
- [x] 4.5 新增内联模板基本使用场景测试：定义、引用、变量替换、条件渲染
|
|
- [x] 4.6 新增同名模板报错测试：验证内联和外部模板同名时系统抛出 ERROR
|
|
- [x] 4.7 新增内联模板错误处理测试：验证各种错误场景的错误消息和级别
|
|
- [x] 4.8 新增向后兼容性测试：验证不使用 `templates` 字段时系统行为不变
|
|
|
|
## 5. 文档更新
|
|
|
|
- [x] 5.1 更新 `README.md`，添加内联模板的语法说明和使用示例
|
|
- [x] 5.2 更新 `README_DEV.md`，说明内联模板的实现细节和设计决策
|
|
- [x] 5.3 添加内联模板的最佳实践指南，说明何时使用内联模板 vs 外部模板
|
|
|
|
## 6. 验证和收尾
|
|
|
|
- [x] 6.1 运行完整的测试套件，确保所有测试通过
|
|
- [x] 6.2 使用 `uv run pytest -v` 验证新增测试用例
|
|
- [x] 6.3 手动测试：创建包含内联模板的示例 YAML 文件，验证转换功能正常
|
|
- [x] 6.4 手动测试：创建混合使用内联和外部模板的示例，验证优先级规则
|
|
- [x] 6.5 使用 `uv run pytest --cov=. --cov-report=html` 检查测试覆盖率
|
|
- [x] 6.6 使用 `uv run yaml2pptx.py check` 验证 YAML 验证功能正常
|