1
0

feat: 添加内联模板支持

支持在 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 字段时行为不变。
This commit is contained in:
2026-03-03 15:59:55 +08:00
parent 2ba1bd7272
commit 01eacb0b97
15 changed files with 1277 additions and 25 deletions

View File

@@ -58,6 +58,37 @@ class Template:
# 元素列表
self.elements = self.data.get('elements', [])
@classmethod
def from_data(cls, template_data, template_name):
"""从字典创建模板(内联模板)
Args:
template_data: 模板数据字典
template_name: 模板名称
Returns:
Template 对象
"""
obj = cls.__new__(cls)
obj.data = template_data
# 解析变量定义
obj.vars_def = {}
for var in template_data.get('vars', []):
obj.vars_def[var['name']] = var
# 元素列表
obj.elements = template_data.get('elements', [])
return obj
def _external_template_exists(self, template_name):
"""检查外部模板文件是否存在"""
if not hasattr(self, 'templates_dir') or not self.templates_dir:
return False
template_path = Path(self.templates_dir) / f"{template_name}.yaml"
return template_path.exists()
def resolve_value(self, value, vars_values):
"""
解析单个值中的变量引用
@@ -155,8 +186,16 @@ class Template:
list: 渲染后的元素列表
Raises:
YAMLError: 缺少必需变量
YAMLError: 缺少必需变量,内联模板相互引用
"""
# 检测内联模板相互引用(禁止)
for elem in self.elements:
if isinstance(elem, dict) and 'template' in elem:
raise YAMLError(
f"内联模板不支持相互引用:元素中包含 'template' 字段\n"
f"提示: 内联模板只能包含元素定义,不能引用其他模板"
)
# 填充所有变量的默认值(如果用户未提供)
for var_name, var_def in self.vars_def.items():
if var_name not in vars_values: