使用多个YAML锚点合并时pre-commit-hooks的yml校验失败如何解决

安全阿岳

2026-9-24

解决方案

你需要自定义ruamel.yaml的映射构造逻辑，仅对<<合并键开放重复允许权限，其他普通重复键依旧触发校验错误，具体实现如下：

1. 核心实现逻辑

ruamel.yaml的重复键检测发生在映射构造阶段，我们可以通过重写构造器的重复键处理逻辑实现针对性放行：

from ruamel.yaml import YAML
from ruamel.yaml.constructor import SafeConstructor

class CustomSafeConstructor(SafeConstructor):
    def construct_mapping(self, node, deep=False):
        # 先处理键去重逻辑，仅放行<<
        existing_keys = set()
        for key_node, value_node in node.value:
            key = self.construct_object(key_node, deep=deep)
            if key == '<<':
                continue
            if key in existing_keys:
                raise ValueError(f"发现重复键 {key}，位于行 {key_node.start_mark.line + 1}")
            existing_keys.add(key)
        # 正常走合并逻辑，多个<<会自动合并
        return super().construct_mapping(node, deep=deep)

# 初始化yaml实例使用自定义构造器
yaml = YAML(typ='safe')
yaml.Constructor = CustomSafeConstructor
# 关闭全局重复键检测，交给我们自定义的逻辑处理
yaml.allow_duplicate_keys = True

# 测试加载你的.gitlab-ci.yml
with open('.gitlab-ci.yml', 'r', encoding='utf-8') as f:
    content = yaml.load(f)

2. 适配pre-commit-hooks的修改方案

默认的pre-commit-hooks的check_yaml没有提供单独放行<<的配置，你可以按以下两种方式处理：

方式一：fork pre-commit-hooks仓库，修改pre_commit_hooks/check_yaml.py文件，将上述自定义构造器替换原有的默认构造器，之后在你的pre-commit配置中指向你fork后的仓库地址即可。
方式二：单独编写一个自定义的YAML校验hook，使用上述自定义逻辑，替换掉官方的check_yaml hook。