支持在 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 字段时行为不变。
203 lines
6.1 KiB
Python
203 lines
6.1 KiB
Python
"""
|
|
资源验证器
|
|
|
|
验证 YAML 文件引用的外部资源是否存在。
|
|
"""
|
|
|
|
from pathlib import Path
|
|
from validators.result import ValidationIssue
|
|
from loaders.yaml_loader import load_yaml_file, validate_template_yaml
|
|
|
|
|
|
class ResourceValidator:
|
|
"""资源验证器"""
|
|
|
|
def __init__(self, yaml_dir: Path, template_dir: Path = None, yaml_data: dict = None):
|
|
"""
|
|
初始化资源验证器
|
|
|
|
Args:
|
|
yaml_dir: YAML 文件所在目录
|
|
template_dir: 模板文件目录(可选)
|
|
yaml_data: YAML 数据(用于检查内联模板)
|
|
"""
|
|
self.yaml_dir = yaml_dir
|
|
self.template_dir = template_dir
|
|
self.yaml_data = yaml_data or {}
|
|
|
|
def validate_image(self, element, slide_index: int, elem_index: int) -> list:
|
|
"""
|
|
验证图片文件是否存在
|
|
|
|
Args:
|
|
element: 图片元素对象
|
|
slide_index: 幻灯片索引(从 1 开始)
|
|
elem_index: 元素索引(从 1 开始)
|
|
|
|
Returns:
|
|
验证问题列表
|
|
"""
|
|
issues = []
|
|
location = f"幻灯片 {slide_index}, 元素 {elem_index}"
|
|
|
|
if not hasattr(element, "src"):
|
|
return issues
|
|
|
|
src = element.src
|
|
if not src:
|
|
return issues
|
|
|
|
# 解析路径(支持相对路径和绝对路径)
|
|
src_path = Path(src)
|
|
if not src_path.is_absolute():
|
|
src_path = self.yaml_dir / src
|
|
|
|
# 检查文件是否存在
|
|
if not src_path.exists():
|
|
issues.append(
|
|
ValidationIssue(
|
|
level="ERROR",
|
|
message=f"图片文件不存在: {src}",
|
|
location=location,
|
|
code="IMAGE_FILE_NOT_FOUND",
|
|
)
|
|
)
|
|
|
|
return issues
|
|
|
|
def validate_template(self, slide_data: dict, slide_index: int) -> list:
|
|
"""
|
|
验证模板文件是否存在且结构正确
|
|
|
|
Args:
|
|
slide_data: 幻灯片数据字典
|
|
slide_index: 幻灯片索引(从 1 开始)
|
|
|
|
Returns:
|
|
验证问题列表
|
|
"""
|
|
issues = []
|
|
location = f"幻灯片 {slide_index}"
|
|
|
|
if "template" not in slide_data:
|
|
return issues
|
|
|
|
template_name = slide_data["template"]
|
|
if not template_name:
|
|
return issues
|
|
|
|
# 检查是否为内联模板
|
|
inline_templates = self.yaml_data.get("templates", {})
|
|
if template_name in inline_templates:
|
|
# 内联模板已在 validate_presentation_yaml 中验证,这里不需要额外验证
|
|
return issues
|
|
|
|
# 检查是否提供了模板目录(外部模板)
|
|
if not self.template_dir:
|
|
issues.append(
|
|
ValidationIssue(
|
|
level="ERROR",
|
|
message=f"使用了模板但未指定模板目录: {template_name}",
|
|
location=location,
|
|
code="TEMPLATE_DIR_NOT_SPECIFIED",
|
|
)
|
|
)
|
|
return issues
|
|
|
|
# 解析模板文件路径
|
|
template_path = self.template_dir / template_name
|
|
if not template_path.suffix:
|
|
template_path = template_path.with_suffix(".yaml")
|
|
|
|
# 检查模板文件是否存在
|
|
if not template_path.exists():
|
|
issues.append(
|
|
ValidationIssue(
|
|
level="ERROR",
|
|
message=f"模板文件不存在: {template_name}",
|
|
location=location,
|
|
code="TEMPLATE_FILE_NOT_FOUND",
|
|
)
|
|
)
|
|
return issues
|
|
|
|
# 验证模板文件结构
|
|
try:
|
|
template_data = load_yaml_file(template_path)
|
|
validate_template_yaml(template_data, str(template_path))
|
|
except Exception as e:
|
|
issues.append(
|
|
ValidationIssue(
|
|
level="ERROR",
|
|
message=f"模板文件结构错误: {template_name} - {str(e)}",
|
|
location=location,
|
|
code="TEMPLATE_STRUCTURE_ERROR",
|
|
)
|
|
)
|
|
|
|
return issues
|
|
|
|
def validate_template_vars(self, slide_data: dict, slide_index: int) -> list:
|
|
"""
|
|
验证模板变量是否满足要求
|
|
|
|
Args:
|
|
slide_data: 幻灯片数据字典
|
|
slide_index: 幻灯片索引(从 1 开始)
|
|
|
|
Returns:
|
|
验证问题列表
|
|
"""
|
|
issues = []
|
|
location = f"幻灯片 {slide_index}"
|
|
|
|
if "template" not in slide_data:
|
|
return issues
|
|
|
|
template_name = slide_data["template"]
|
|
if not template_name:
|
|
return issues
|
|
|
|
# 检查是否为内联模板
|
|
inline_templates = self.yaml_data.get("templates", {})
|
|
if template_name in inline_templates:
|
|
template_data = inline_templates[template_name]
|
|
else:
|
|
# 外部模板
|
|
if not self.template_dir:
|
|
return issues
|
|
|
|
template_path = self.template_dir / template_name
|
|
if not template_path.suffix:
|
|
template_path = template_path.with_suffix(".yaml")
|
|
|
|
if not template_path.exists():
|
|
return issues
|
|
|
|
try:
|
|
template_data = load_yaml_file(template_path)
|
|
validate_template_yaml(template_data, str(template_path))
|
|
except Exception:
|
|
return issues
|
|
|
|
template_vars = template_data.get("vars", [])
|
|
required_vars = [v["name"] for v in template_vars if v.get("required", False)]
|
|
|
|
if not required_vars:
|
|
return issues
|
|
|
|
user_vars = slide_data.get("vars", {})
|
|
missing_vars = [v for v in required_vars if v not in user_vars]
|
|
|
|
if missing_vars:
|
|
issues.append(
|
|
ValidationIssue(
|
|
level="ERROR",
|
|
message=f"缺少模板必需变量: {', '.join(missing_vars)}",
|
|
location=location,
|
|
code="MISSING_TEMPLATE_REQUIRED_VARS",
|
|
)
|
|
)
|
|
|
|
return issues
|