如果存在字段，则对规则进行两种不同的验证

Question

我需要解析很多yml文件。 我有一个类似的例子，在某些情况下存在一个值，因此我需要更改另一个规则的regex。 我找不到正确的方法来验证它

yaml1级：

email: someone@company.com

yaml2：

email: otherguy@home.com
contract_type: external

架构：

schema = {
  'email': {
    'required': True,
    'type': 'string',
    'regex': '^([a-zA-Z0-9_\-\.]+)@company\.com$'
  }

Answer 1

快速回答（TL；DR）

• “复合验证”方法允许使用条件（上下文感知）验证规则。你知道吗
• pythoncerberus包支持“开箱即用”的复合验证。你知道吗

详细答案

上下文

• python 2.7版
• cerberus验证包
• jmespath查询语言（使验证规则更加紧凑和可读）

问题

• 开发人员NamenMalkavCreator希望应用条件验证规则。你知道吗
• 条件验证规则将根据数据集中其他字段的存在或值激活。你知道吗
• 条件验证规则需要足够灵活，以便根据源数据中的任意状态或关系“动态”更改。你知道吗

解决方案

• 这种方法可以通过复合数据验证来实现。你知道吗
• 在此用例下，复合验证只是指创建验证规则的顺序列表，例如：
  • 每个单独的规则操作一个复合数据变量
  • 每个单独的规则都指定了规则应用时的“触发条件”
  • 每个规则产生三个互斥验证结果中的一个：validation-success、validation-fail或validation-skipped

示例

• 下面的示例假设有多个YAML文档
• 这里显示了一些示例文档

示例文档

aadocuments = []
aadocuments.append(yaml.safe_load('''
    person_fname:         homer
    person_lname:         himpson
    person_age:           33
    prize_caption:        free beer for life
    prize_email:          prizes@abcbooze.com
    prize_category:       alchohol
'''))
aadocuments.append(yaml.safe_load('''
    person_fname:         helen
    person_lname:         himpson
    person_age:           16
    prize_caption:        free ammo for life
    prize_email:          prizes@zzzguns.com
    prize_category:       firearms
  '''))

样本验证规则

- rule_caption:     check-underage-minor
  rule_vpath:       '[@]|[? @.person_age < `18`]'
  validation_schema:
    prize_category:
      type: string
      allowed: ['pets','toys','candy']
    prize_email:
      type:     string
      regex:    '[\w]+@.*'

• 上面的代码是从规则列表中获取的单个验证规则的YAML格式表示。你知道吗
• 简单地说，这条规则规定：
  • 如果我们在数据集中遇到一条person_age小于18的记录，那么：
    • 断言prize_category字段存在
    • 断言prize_category字段的类型为string
    • 断言prize_category的值是pets或toys或candy
    • 断言prize_email字段存在，类型为string
    • 断言prize_email字段匹配特定的正则表达式

结果示例

• 上面例子中helen himpson的结果是validation-fail。
  • check-underage-minor验证规则触发，因为person_age == 16
  • prize_cateogry具有值firearms，这是不允许的，因此验证失败

基本原理

• 这种方法可以扩展到任何复杂程度。你知道吗
• 这种方法很容易被人类理解（尽管jmespath语法可能是一个挑战）
• 使用这种方法可以建立任意复杂的条件和约束集。你知道吗

陷阱

• 上面的示例使用jmespath语法指定rule_vpath，它告诉系统在person_age存在且小于18时触发此特定规则。这增加了对jmespath的依赖性。你知道吗

另见

• complete code example on github