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

Question

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

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包支持“开箱即用”的复合验证。

详细解答

语境

• 蟒蛇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字段是字符串类型
    • 断言的值prize_category是pets或者toys或candy
    • 断言prize_email字段存在，字符串类型
    • 断言该prize_email字段匹配特定的正则表达式

示例结果

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

基本原理

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

陷阱

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

也可以看看

• github上的完整代码示例