1
0

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

主要变更:
- 将 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

View File

@@ -23,18 +23,18 @@ class TestPresentationInit:
assert pres.pres_file == sample_yaml
def test_init_with_templates_dir(self, sample_yaml, sample_template):
"""测试带模板目录初始化"""
"""测试带模板库文件初始化"""
pres = Presentation(str(sample_yaml), str(sample_template))
assert pres.templates_dir == str(sample_template)
assert isinstance(pres.template_cache, dict)
assert pres.template_file == Path(sample_template)
assert pres.template_library is not None
def test_init_without_templates_dir(self, sample_yaml):
"""测试不带模板目录初始化"""
"""测试不带模板库文件初始化"""
pres = Presentation(str(sample_yaml))
assert pres.templates_dir is None
assert isinstance(pres.template_cache, dict)
assert pres.template_file is None
assert pres.template_library is None
@patch("core.presentation.load_yaml_file")
@patch("core.presentation.validate_presentation_yaml")
@@ -118,67 +118,6 @@ slides:
assert pres.size == "16:9"
class TestGetTemplate:
"""get_template 方法测试类"""
@patch("core.presentation.Template")
def test_get_template_caches_template(self, mock_template_class, sample_template):
"""测试模板被缓存"""
mock_template = Mock()
mock_template_class.return_value = mock_template
# 创建一个使用模板的 YAML
yaml_content = """
slides:
- elements: []
"""
yaml_path = sample_template / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
# 第一次获取
template1 = pres.get_template("test_template")
# 第二次获取
template2 = pres.get_template("test_template")
# 应该是同一个实例
assert template1 is template2
@patch("core.presentation.Template")
def test_get_template_creates_new_template(
self, mock_template_class, sample_template
):
"""测试创建新模板"""
mock_template = Mock()
mock_template_class.return_value = mock_template
yaml_content = """
slides:
- elements: []
"""
yaml_path = sample_template / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
# 获取模板
template = pres.get_template("new_template")
# 应该创建模板
mock_template_class.assert_called_once()
assert template == mock_template
def test_get_template_without_templates_dir(self, sample_yaml):
"""测试无模板目录时获取模板"""
pres = Presentation(str(sample_yaml))
# 应该在调用 Template 时失败,而不是 get_template
with patch("core.presentation.Template") as mock_template_class:
mock_template_class.side_effect = YAMLError("No template dir")
with pytest.raises(YAMLError):
pres.get_template("test")
class TestRenderSlide:
@@ -200,38 +139,6 @@ class TestRenderSlide:
assert len(result["elements"]) == 1
assert result["elements"][0].content == "Test"
@patch("core.presentation.Template")
def test_render_slide_with_template(
self, mock_template_class, temp_dir, sample_template
):
"""测试渲染使用模板的幻灯片"""
mock_template = Mock()
mock_template.render.return_value = [
{
"type": "text",
"content": "Template Title",
"box": [0, 0, 1, 1],
"font": {},
}
]
mock_template_class.return_value = mock_template
yaml_content = """
slides:
- elements: []
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
slide_data = {"template": "title-slide", "vars": {"title": "My Title"}}
result = pres.render_slide(slide_data)
# 模板应该被渲染
mock_template.render.assert_called_once_with({"title": "My Title"})
assert "elements" in result
def test_render_slide_with_background(self, sample_yaml):
"""测试渲染带背景的幻灯片"""
@@ -275,35 +182,6 @@ slides:
mock_create_element.assert_called()
assert result["elements"][0] == mock_elem
def test_render_slide_with_template_merges_background(
self, mock_template_class, temp_dir, sample_template
):
"""测试使用模板时合并背景"""
mock_template = Mock()
mock_template.render.return_value = [
{"type": "text", "content": "Title", "box": [0, 0, 1, 1], "font": {}}
]
mock_template_class.return_value = mock_template
yaml_content = """
slides:
- elements: []
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
slide_data = {
"template": "test",
"vars": {},
"background": {"color": "#ff0000"},
}
result = pres.render_slide(slide_data)
# 背景应该被保留
assert result["background"] == {"color": "#ff0000"}
def test_render_slide_empty_elements_list(self, sample_yaml):
"""测试空元素列表"""
@@ -341,79 +219,6 @@ slides:
class TestRenderSlideHybridMode:
"""render_slide 混合模式测试类"""
@patch("core.presentation.Template")
def test_hybrid_mode_basic(self, mock_template_class, temp_dir, sample_template):
"""测试混合模式基本功能template + elements"""
mock_template = Mock()
mock_template.render.return_value = [
{"type": "text", "content": "From Template", "box": [0, 0, 1, 1], "font": {}}
]
mock_template.resolve_element.side_effect = lambda elem, vars: elem
mock_template_class.return_value = mock_template
yaml_content = """
slides:
- elements: []
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
slide_data = {
"template": "test-template",
"vars": {"title": "Test"},
"elements": [
{"type": "text", "content": "Custom Element", "box": [2, 2, 1, 1], "font": {}}
]
}
result = pres.render_slide(slide_data)
# 应该有 2 个元素1 个来自模板1 个自定义
assert len(result["elements"]) == 2
assert result["elements"][0].content == "From Template"
assert result["elements"][1].content == "Custom Element"
@patch("core.presentation.Template")
def test_hybrid_mode_variable_sharing(self, mock_template_class, temp_dir, sample_template):
"""测试自定义元素访问模板变量"""
mock_template = Mock()
mock_template.render.return_value = []
# 模拟 resolve_element 解析变量
def resolve_element_mock(elem, vars):
resolved = elem.copy()
if "content" in resolved and "{" in resolved["content"]:
resolved["content"] = resolved["content"].replace("{theme_color}", vars.get("theme_color", ""))
if "fill" in resolved and "{" in resolved["fill"]:
resolved["fill"] = resolved["fill"].replace("{theme_color}", vars.get("theme_color", ""))
return resolved
mock_template.resolve_element.side_effect = resolve_element_mock
mock_template_class.return_value = mock_template
yaml_content = """
slides:
- elements: []
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
slide_data = {
"template": "test-template",
"vars": {"theme_color": "#3949ab"},
"elements": [
{"type": "shape", "fill": "{theme_color}", "box": [0, 0, 1, 1]}
]
}
result = pres.render_slide(slide_data)
# 自定义元素应该使用模板变量
assert result["elements"][0].fill == "#3949ab"
def test_hybrid_mode_empty_elements(self, temp_dir, sample_template):
"""测试空 elements 列表"""
@@ -529,84 +334,6 @@ templates:
assert result["elements"][0].content == "Inline Template"
assert result["elements"][1].content == "Custom"
@patch("core.presentation.Template")
def test_hybrid_mode_with_external_template(self, mock_template_class, temp_dir, sample_template):
"""测试外部模板与自定义元素混合使用"""
mock_template = Mock()
mock_template.render.return_value = [
{"type": "text", "content": "External", "box": [0, 0, 1, 1], "font": {}}
]
mock_template.resolve_element.side_effect = lambda elem, vars: elem
mock_template_class.return_value = mock_template
yaml_content = """
slides:
- elements: []
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
slide_data = {
"template": "external-template",
"vars": {},
"elements": [
{"type": "text", "content": "Custom", "box": [2, 2, 1, 1], "font": {}}
]
}
result = pres.render_slide(slide_data)
# 应该有 2 个元素
assert len(result["elements"]) == 2
assert result["elements"][0].content == "External"
assert result["elements"][1].content == "Custom"
@patch("core.presentation.Template")
def test_hybrid_mode_element_order(self, mock_template_class, temp_dir, sample_template):
"""测试元素顺序:模板元素在前,自定义元素在后"""
mock_template = Mock()
mock_template.render.return_value = [
{"type": "text", "content": "Template1", "box": [0, 0, 1, 1], "font": {}},
{"type": "text", "content": "Template2", "box": [1, 0, 1, 1], "font": {}}
]
mock_template.resolve_element.side_effect = lambda elem, vars: elem
mock_template_class.return_value = mock_template
yaml_content = """
slides:
- elements: []
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(sample_template))
slide_data = {
"template": "test-template",
"vars": {},
"elements": [
{"type": "text", "content": "Custom1", "box": [2, 0, 1, 1], "font": {}},
{"type": "text", "content": "Custom2", "box": [3, 0, 1, 1], "font": {}}
]
}
result = pres.render_slide(slide_data)
# 验证顺序:模板元素在前
assert len(result["elements"]) == 4
assert result["elements"][0].content == "Template1"
assert result["elements"][1].content == "Template2"
assert result["elements"][2].content == "Custom1"
assert result["elements"][3].content == "Custom2"
# ============= Description 字段测试 =============
class TestPresentationDescription:
"""Presentation description 字段测试类"""
def test_metadata_with_description(self, temp_dir):
"""测试 metadata 包含 description 字段时正确加载"""

View File

@@ -63,44 +63,6 @@ slides:
# 默认应该启用
assert slides_data[0].get('enabled', True) is True
def test_slide_enabled_with_template(self, temp_dir):
"""测试 enabled 与模板共存"""
# 创建模板
template_dir = temp_dir / "templates"
template_dir.mkdir()
template_file = template_dir / "title-slide.yaml"
template_content = """
vars:
- name: title
required: true
elements:
- type: text
box: [1, 2, 8, 1]
content: "{title}"
font:
size: 44
"""
template_file.write_text(template_content)
yaml_content = """
slides:
- template: title-slide
enabled: false
vars:
title: "Disabled Title"
- template: title-slide
vars:
title: "Enabled Title"
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(template_dir))
slides_data = pres.data.get('slides', [])
# 第一个禁用,第二个启用
assert slides_data[0].get('enabled', True) is False
assert slides_data[1].get('enabled', True) is True
def test_slide_enabled_with_custom_slide(self, temp_dir):
"""测试 enabled 与自定义幻灯片共存"""
@@ -127,55 +89,6 @@ slides:
assert slides_data[0].get('enabled', True) is False
assert slides_data[1].get('enabled', True) is True
def test_slide_enabled_with_element_visible(self, temp_dir):
"""测试 enabled 和 visible 共存"""
# 创建模板
template_dir = temp_dir / "templates"
template_dir.mkdir()
template_file = template_dir / "title-slide.yaml"
template_content = """
vars:
- name: title
required: true
- name: subtitle
required: false
default: ""
elements:
- type: text
box: [1, 2, 8, 1]
content: "{title}"
font:
size: 44
- type: text
box: [1, 3.5, 8, 0.5]
content: "{subtitle}"
visible: "{subtitle != ''}"
font:
size: 24
"""
template_file.write_text(template_content)
yaml_content = """
slides:
- template: title-slide
enabled: true
vars:
title: "Title"
subtitle: ""
"""
yaml_path = temp_dir / "test.yaml"
yaml_path.write_text(yaml_content)
pres = Presentation(str(yaml_path), str(template_dir))
slide_data = pres.data['slides'][0]
# 页面启用
assert slide_data.get('enabled', True) is True
# 渲染幻灯片,元素级 visible 会隐藏空副标题
rendered = pres.render_slide(slide_data)
# 只有标题元素,副标题被 visible 隐藏
assert len(rendered['elements']) == 1
def test_slide_enabled_count(self, temp_dir):
"""测试渲染统计准确"""

File diff suppressed because it is too large Load Diff

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)