原文： http://zetcode.com/python/cerberus/

Python Cerberus 教程展示了如何在 Python 中使用 Cerberus 验证数据。

Cerberus

Cerberus 是一个 Python 验证库，它提供了功能强大而又简单轻巧的数据验证功能。 它被设计为易于扩展，允许自定义验证。

Cerberus 通过定义数据验证模式来工作。 该模式将传递到Validator并使用validate()进行验证。 它具有适用于数据的一组规则，例如required，min或max。

可以将多个规则应用于数据字段。 如果验证失败，我们可以获得带有errors属性的错误消息。

Cerberus 类型

以下是 Cerberus 的简单演示。 使用type规则，我们可以设置字段的预期数据类型。

simple.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  5. schema = {'name': {'type': 'string'}}
  6. v = Validator(schema)
  8. document = {'name': 'john doe'}
  10. if v.validate(document):
  11.     print('data is valid')
  12. else:
  13.     print('invalid data')

在示例中，我们验证name字段； 我们希望它是一个字符串值。

  1. from cerberus import Validator

我们导入Validator类。

  1. schema = {'name': {'type': 'string'}}

我们定义模式。 这是 Python 字典。 我们指定名称字段必须为字符串。

  1. document = {'name': 'john doe'}

这是我们的数据。

  1. if v.validate(document):
  2.     print('data is valid')
  3. else:
  4.     print('invalid data')

我们使用validate()验证数据。

  1. $ ./simple.py
  2. data is valid

这是输出。

在第二个示例中，我们检查字符串和列表类型。

types.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  5. v = Validator()
  6. v.schema = {'words': {'type': ['string', 'list']}}
  8. if v.validate({'words': 'falcon'}):
  9.     print('valid data')
  10. else:
  11.     print('invalid data')
  13. if v.validate({'words': ['falcon', 'sky', 'cloud']}):
  14.     print('valid data')
  15. else:
  16.     print('invalid data')

该示例验证words字段是字符串还是列表。

Cerberus 法则

required规则使该字段为必填字段。

required.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  5. v = Validator()
  6. v.schema = {'name': {'required': True, 'type': 'string'},
  7.             'age': {'type': 'integer'}}
  9. if v.validate({'age': 34}):
  10.     print('valid data')
  11. else:
  12.     print('invalid data')
  13.     print(v.errors)

该示例有两个数据字段：name和age。 name是必填字段。

  1. $ ./required.py
  2. invalid data
  3. {'name': ['required field']}

我们省略了name字段； 因此，验证失败。

Cerberus 最小和最大规则

min和max规则设置整数，浮点数和数字类型所允许的最小值和最大值。

对于字符串类型，我们可以使用minlength和maxlength。

min_max.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  5. v = Validator()
  6. v.schema = {'name': { 'type': 'string', 'minlength': 2},
  7.     'age': {'type': 'integer', 'min': 18, 'max': 65}}
  9. if v.validate({'name': 'J', 'age': 4}):
  10.     print('valid data')
  11. else:
  12.     print('invalid data')
  13.     print(v.errors)

在示例中，我们为字符串设置了最小长度，为整数设置了最小和最大大小。

  1. $ ./min_max.py
  2. invalid data
  3. {'age': ['min value is 18'], 'name': ['min length is 2']}

我们有两个验证错误。

Cerberus 正则表达式规则

我们可以使用正则表达式定义更复杂的规则。

regex.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  5. v = Validator()
  6. v.schema = {"contact_details": {
  7.     "type": "dict",
  8.     "schema": {
  9.         "phone": {
  10.             "type": "string",
  11.             "minlength": 10,
  12.             "maxlength": 10,
  13.             "regex": "^0[0-9]{9}$"
  14.         },
  15.         "email": {
  16.             "type": "string",
  17.             "minlength": 8,
  18.             "maxlength": 255,
  19.             "required": True,
  20.             "regex": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$"
  21.         }
  22.     }
  23. }}
  25. if v.validate({'contact_details': {'phone': '0901123123',
  26.                                    'email': 'john.doe@example.com'}}):
  27.     print('valid data')
  28. else:
  29.     print('invalid data')
  30.     print(v.errors)

在示例中，我们使用正则表达式为phone和email字段定义验证规则。

Cerberus 值强制转换

值强制使我们可以在数据验证之前将可调用对象应用于值。 可调用对象的返回值替换文档中的新值。 在验证之前，可以使用强制转换数据或清除数据。

coercing.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  4. from datetime import datetime
  6. def to_date(s):
  7.     return datetime.strptime(s, '%Y-%m-%d')
  9. v = Validator()
  10. v.schema = {'start_date': {'type': 'datetime', 'coerce': to_date}}
  12. if v.validate({'start_date': '2019-12-11'}):
  13.     print('valid data')
  14. else:
  15.     print('invalid data')
  16.     print(v.errors)
  18. if v.validate({'start_date': '2019/12/11'}):
  19.     print('valid data')
  20. else:
  21.     print('invalid data')
  22.     print(v.errors)

在示例中，我们使用自定义to_date()函数将数据时间值转换为选定的格式。

  1. $ ./coercing.py
  2. valid data
  3. invalid data
  4. {'start_date': ["field 'start_date' cannot be coerced: time data '2019/12/11' does not
  5. match format '%Y-%m-%d'", 'must be of datetime type']}

这是输出。

使用 YAML 文件

在下一个示例中，我们将数据存储在 YAML 文件中。

cities.yaml

  1. cities:
  2.   - Bratislava
  3.   - Kosice
  4.   - Trnava
  5.   - Moldava
  6.   - Trencin

该文件包含城市列表。

from_yaml.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  4. import yaml
  6. v = Validator()
  7. v.schema = {'cities': {'type': 'list', 'schema': {'type': 'string'}}}
  9. with open('cities.yaml') as f:
  11.     data = yaml.load(f, Loader=yaml.FullLoader)
  12.     print(data)
  14.     if v.validate({'cities': data['cities']}):
  15.         print('valid data')
  16.     else:
  17.         print('invalid data')
  18.         print(v.errors)

我们从 YAML 文件中读取数据并进行验证。 schema规则设置针对列表的所有元素验证定义的规则。

  1. v = Validator()
  2. v.schema = {'cities': {'type': 'list', 'schema': {'type': 'string'}}}

cities字段必须是一个列表，并且其所有元素都必须是字符串。

Cerberus 定制验证器

我们可以通过从Validator类扩展来创建自定义验证器。

custom_validator.py

  1. #!/usr/bin/env python3
  3. from cerberus import Validator
  4. from dataclasses import dataclass
  6. @dataclass
  7. class Person:
  8.     name: str
  9.     age: int
  11. class PersonValidator(Validator):
  13.      def validate_person(self, obj):
  15.          return self.validate(obj.__dict__)
  17. schema = {'name': { 'type': 'string', 'minlength': 2},
  18.     'age': {'type': 'integer', 'min': 18, 'max': 65}}
  20. v = PersonValidator(schema)
  22. p = Person('John Doe', 2)
  24. if v.validate_person(p):
  25.     print('valid data')
  26. else:
  27.     print('invalid data')
  28.     print(v.errors)

在示例中，我们为Person对象定义了一个自定义验证器。

在本教程中，我们展示了如何使用 Cerberus 在 Python 中验证数据。

您可能也对以下相关教程感兴趣： Python 字符串， Python Jinja 教程和 Python 教程，或列出所有 Python 教程 。