lanyuanxiaoyao/PPTX
1
0
Fork 0
Code Activity

refactor: 重构外部模板系统，改为单文件模板库模式

Browse Source 
主要变更：
- 将 templates_dir 参数改为 template_file，支持单个模板库 YAML 文件
- 添加模板库 YAML 验证功能
- 为模板添加 base_dir 支持，正确解析相对路径资源
- 内联模板与外部模板同名时改为警告（内联优先）
- 移除模板缓存机制，直接使用模板库字典
- 更新所有相关测试以适配新的模板加载方式

此重构简化了模板管理，使模板资源的路径解析更加清晰明确。
This commit is contained in:
兰缘小妖
2026-03-05 13:26:29 +08:00
parent bd12fce14b
commit f1aae96a04
27 changed files with 2141 additions and 1988 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
tests/unit/test_validators/test_resource.py
View File

@@ -16,13 +16,12 @@ class TestResourceValidator:
"""测试初始化"""
validator = ResourceValidator(yaml_dir=temp_dir)
assert validator.yaml_dir == temp_dir
assert validator.template_dir is None
assert validator.template_file is None
def test_init_with_template_dir(self, temp_dir):
"""测试带模板目录初始化"""
template_dir = temp_dir / "templates"
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=template_dir)
assert validator.template_dir == template_dir
def test_init_with_template_dir(self, temp_dir, sample_template):
"""测试带模板文件初始化"""
validator = ResourceValidator(yaml_dir=temp_dir, template_file=sample_template)
assert validator.template_file == sample_template
class TestValidateImage:
@@ -76,59 +75,57 @@ class TestValidateTemplate:
issues = validator.validate_template(slide_data, 1)
assert len(issues) == 0
def test_template_with_dir_not_specified(self, temp_dir):
"""测试使用模板但未指定模板目录"""
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=None)
def test_template_with_file_not_specified(self, temp_dir):
"""测试使用模板但未指定模板文件"""
validator = ResourceValidator(yaml_dir=temp_dir, template_file=None)
slide_data = {"template": "title-slide"}
issues = validator.validate_template(slide_data, 1)
assert len(issues) == 1
assert issues[0].level == "ERROR"
assert issues[0].code == "TEMPLATE_DIR_NOT_SPECIFIED"
assert issues[0].code == "TEMPLATE_FILE_NOT_SPECIFIED"
def test_nonexistent_template_file(self, temp_dir):
"""测试不存在的模板文件"""
template_dir = temp_dir / "templates"
template_dir.mkdir()
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=template_dir)
slide_data = {"template": "nonexistent"}
"""测试模板库文件不存在"""
template_file = temp_dir / "nonexistent.yaml"
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
slide_data = {"template": "title-slide"}
issues = validator.validate_template(slide_data, 1)
assert len(issues) == 1
assert issues[0].level == "ERROR"
assert issues[0].code == "TEMPLATE_FILE_NOT_FOUND"
assert issues[0].code == "TEMPLATE_LIBRARY_FILE_NOT_FOUND"
def test_valid_template_file(self, sample_template):
"""测试有效的模板文件"""
validator = ResourceValidator(
yaml_dir=sample_template.parent, template_dir=sample_template
yaml_dir=sample_template.parent, template_file=sample_template
)
slide_data = {"template": "title-slide"}
issues = validator.validate_template(slide_data, 1)
assert len(issues) == 0
def test_template_with_yaml_extension(self, temp_dir):
"""测试带 .yaml 扩展名的模板"""
template_dir = temp_dir / "templates"
template_dir.mkdir()
(template_dir / "test.yaml").write_text("vars: []\nelements: []")
"""测试模板名称在模板库中不存在"""
template_file = temp_dir / "templates.yaml"
template_file.write_text("templates:\n test-template:\n vars: []\n elements: []")
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=template_dir)
slide_data = {"template": "test.yaml"}
issues = validator.validate_template(slide_data, 1)
assert len(issues) == 0
def test_invalid_template_structure(self, temp_dir):
"""测试无效的模板结构"""
template_dir = temp_dir / "templates"
template_dir.mkdir()
# 创建缺少 elements 字段的无效模板
(template_dir / "invalid.yaml").write_text("vars: []")
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=template_dir)
slide_data = {"template": "invalid"}
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
slide_data = {"template": "nonexistent"}
issues = validator.validate_template(slide_data, 1)
assert len(issues) == 1
assert issues[0].level == "ERROR"
assert issues[0].code == "TEMPLATE_STRUCTURE_ERROR"
assert issues[0].code == "TEMPLATE_NOT_FOUND_IN_LIBRARY"
def test_invalid_template_structure(self, temp_dir):
"""测试模板库文件格式错误（缺少 templates 字段）"""
template_file = temp_dir / "invalid.yaml"
template_file.write_text("vars: []") # 缺少 templates 字段
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
slide_data = {"template": "test"}
issues = validator.validate_template(slide_data, 1)
# 模板库加载失败，会报 TEMPLATE_LIBRARY_FILE_NOT_FOUND 或其他错误
assert len(issues) >= 1
assert issues[0].level == "ERROR"
class TestValidateTemplateVars:
@@ -141,9 +138,9 @@ class TestValidateTemplateVars:
issues = validator.validate_template_vars(slide_data, 1)
assert len(issues) == 0
def test_template_with_dir_not_specified(self, temp_dir):
"""测试使用模板但未指定模板目录"""
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=None)
def test_template_with_file_not_specified(self, temp_dir):
"""测试使用模板但未指定模板文件"""
validator = ResourceValidator(yaml_dir=temp_dir, template_file=None)
slide_data = {"template": "title-slide"}
issues = validator.validate_template_vars(slide_data, 1)
assert len(issues) == 0
@@ -151,7 +148,7 @@ class TestValidateTemplateVars:
def test_provide_all_required_vars(self, sample_template):
"""测试提供所有必需变量时验证通过"""
validator = ResourceValidator(
yaml_dir=sample_template.parent, template_dir=sample_template
yaml_dir=sample_template.parent, template_file=sample_template
)
slide_data = {
"template": "title-slide",
@@ -163,7 +160,7 @@ class TestValidateTemplateVars:
def test_missing_required_var(self, sample_template):
"""测试缺少必需变量时验证失败"""
validator = ResourceValidator(
yaml_dir=sample_template.parent, template_dir=sample_template
yaml_dir=sample_template.parent, template_file=sample_template
)
slide_data = {"template": "title-slide", "vars": {"subtitle": "World"}}
issues = validator.validate_template_vars(slide_data, 1)
@@ -174,20 +171,21 @@ class TestValidateTemplateVars:
def test_multiple_required_vars_partial_missing(self, temp_dir):
"""测试多个必需变量部分缺失"""
template_dir = temp_dir / "templates"
template_dir.mkdir()
template_content = """vars:
- name: title
required: true
- name: subtitle
required: true
- name: author
required: false
elements: []
template_file = temp_dir / "templates.yaml"
template_content = """templates:
multi-var:
vars:
- name: title
required: true
- name: subtitle
required: true
- name: author
required: false
elements: []
"""
(template_dir / "multi-var.yaml").write_text(template_content)
template_file.write_text(template_content)
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=template_dir)
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
slide_data = {"template": "multi-var", "vars": {"title": "Hello"}}
issues = validator.validate_template_vars(slide_data, 1)
assert len(issues) == 1
@@ -197,7 +195,7 @@ elements: []
def test_optional_var_missing(self, sample_template):
"""测试可选变量缺失时验证通过"""
validator = ResourceValidator(
yaml_dir=sample_template.parent, template_dir=sample_template
yaml_dir=sample_template.parent, template_file=sample_template
)
slide_data = {"template": "title-slide", "vars": {"title": "Hello"}}
issues = validator.validate_template_vars(slide_data, 1)
@@ -205,25 +203,25 @@ elements: []
def test_template_with_no_required_vars(self, temp_dir):
"""测试模板没有必需变量时"""
template_dir = temp_dir / "templates"
template_dir.mkdir()
template_content = """vars:
- name: subtitle
required: false
elements: []
template_file = temp_dir / "templates.yaml"
template_content = """templates:
optional-only:
vars:
- name: subtitle
required: false
elements: []
"""
(template_dir / "optional-only.yaml").write_text(template_content)
template_file.write_text(template_content)
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=template_dir)
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
slide_data = {"template": "optional-only", "vars": {}}
issues = validator.validate_template_vars(slide_data, 1)
assert len(issues) == 0
def test_nonexistent_template_file(self, temp_dir):
"""测试模板文件不存在时不报错（由 validate_template 处理）"""
template_dir = temp_dir / "templates"
template_dir.mkdir()
validator = ResourceValidator(yaml_dir=temp_dir, template_dir=template_dir)
template_file = temp_dir / "nonexistent.yaml"
validator = ResourceValidator(yaml_dir=temp_dir, template_file=template_file)
slide_data = {"template": "nonexistent"}
issues = validator.validate_template_vars(slide_data, 1)
assert len(issues) == 0
@@ -231,7 +229,7 @@ elements: []
def test_error_location_contains_slide_number(self, sample_template):
"""测试错误信息包含幻灯片位置"""
validator = ResourceValidator(
yaml_dir=sample_template.parent, template_dir=sample_template
yaml_dir=sample_template.parent, template_file=sample_template
)
slide_data = {"template": "title-slide", "vars": {}}
issues = validator.validate_template_vars(slide_data, 5)