Python使用PyYAML加载YAML时如何保留别名获取原始引用信息

PyYAML默认加载逻辑会在解析到别名引用时直接替换为锚点对应的实际对象，要获取原始别名信息，不需要更换解析库，通过自定义加载器重写节点构造逻辑、跟踪解析路径即可实现，完全不影响原有YAML解析结果。

实现思路 #

PyYAML解析过程中，*xxx格式的别名引用会被识别为yaml.nodes.AliasNode类型节点，节点的value属性存储的就是别名字符串（不带前缀*）。我们只需要在构造YAML对象时跟踪当前解析的节点路径，遇到AliasNode时就把路径和对应别名记录下来，后续直接查记录就能完成校验。

完整实现代码 #

import yaml
from yaml.loader import SafeLoader

class AliasCheckLoader(SafeLoader):
    def __init__(self, stream):
        super().__init__(stream)
        # 存储别名引用映射：键为节点路径，值为对应的别名名称
        self.alias_records = {}
        # 维护当前解析的路径栈
        self._path_stack = []

    def construct_mapping(self, node, deep=False):
        mapping = super().construct_mapping(node, deep=deep)
        # 遍历字典节点的所有键值对，跟踪路径
        for key_node, val_node in node.value:
            key = self.construct_object(key_node, deep=deep)
            self._path_stack.append(str(key))
            # 识别别名引用节点，记录信息
            if isinstance(val_node, yaml.nodes.AliasNode):
                self.alias_records["/".join(self._path_stack)] = val_node.value
            # 递归构造值节点
            self.construct_object(val_node, deep=deep)
            self._path_stack.pop()
        return mapping

    def construct_sequence(self, node, deep=False):
        sequence = super().construct_sequence(node, deep=deep)
        # 适配列表类型节点，用索引作为路径段
        for idx, item_node in enumerate(node.value):
            self._path_stack.append(str(idx))
            if isinstance(item_node, yaml.nodes.AliasNode):
                self.alias_records["/".join(self._path_stack)] = item_node.value
            self.construct_object(item_node, deep=deep)
            self._path_stack.pop()
        return sequence


# 加载YAML文件
if __name__ == "__main__":
    # 替换为实际文件读取逻辑
    with open("your_config.yaml", "r", encoding="utf-8") as f:
        loader = AliasCheckLoader(f)
        config_data = loader.get_single_data()
    
    # 打印捕获到的所有别名引用
    print(loader.alias_records)

校验逻辑示例 #

针对给出的YAML样例，上述代码运行后loader.alias_records输出如下：

{
    'networks/first/address': 'dummyname',
    'networks/second/address': 'dummyname'
}

直接读取对应路径的别名值做判断即可：

expected_alias = "dummyname"
check_targets = ["networks/first/address", "networks/second/address"]

check_pass = True
for path in check_targets:
    current_alias = loader.alias_records.get(path)
    if current_alias != expected_alias:
        check_pass = False
        print(f"校验失败：{path} 未使用期望别名 *{expected_alias}")

if check_pass:
    print("所有目标字段别名校验通过")

补充说明 #

• 自定义加载器返回的config_data和原生yaml.safe_load()返回的结构完全一致，不会影响后续配置读取逻辑
• 上述实现已兼容字典、列表嵌套的YAML结构，如果需要更灵活的路径匹配，可以把路径存储为元组格式，避免键名包含/时的匹配冲突
• 该方案不需要引入第三方依赖，基于官方PyYAML即可运行

内容的提问来源于stack exchange，提问作者David Pascual