涛哥聊Python | voluptuous，一个非常厉害的 Python 库！

本文来源公众号“涛哥聊Python”，仅用于学术分享，侵权删，干货满满。

原文链接：voluptuous，一个非常厉害的 Python 库！

大家好，今天为大家分享一个超级厉害的 Python 库 - voluptuous。

Github地址：https://github.com/alecthomas/voluptuous

Python Voluptuous库是一个用于数据验证的Python库，它的设计目标是简单、易用，并且可以灵活地处理各种数据验证需求。本文将介绍Voluptuous库的安装方法、特性、基本功能、高级功能、实际应用场景，并最终总结该库的优势和适用性。

1 安装

可以通过pip工具来安装Voluptuous库：

pip install voluptuous

安装完成后，就可以开始使用Voluptuous库进行数据验证了。

2 特性

• 支持定义数据验证规则，包括数据类型、长度、范围等。

• 可以进行嵌套验证，支持复杂数据结构的验证。

• 提供了丰富的错误信息提示，便于定位验证失败的原因。

3 基本功能

3.1. 定义验证规则

在Voluptuous中，可以使用Schema对象来定义数据验证规则。这些规则可以包括数据类型、长度、范围等要求。

示例代码：

from voluptuous import Schema, Required, Length, Range

# 定义验证规则
schema = Schema({
    Required('name'): str,
    Required('age'): int,
    'email': str,
    'phone': Length(min=8, max=12),
    'score': Range(min=0, max=100)
})

在这个示例中，定义了一个包含姓名、年龄、邮箱、电话和分数的验证规则。其中，姓名和年龄是必需的字段，姓名必须为字符串类型，年龄必须为整数类型，电话号码长度必须在8到12之间，分数必须在0到100之间。

3.2. 进行数据验证

定义了验证规则后，可以使用这些规则来对数据进行验证。如果数据符合规则，则验证通过；否则，会抛出相应的错误信息。

示例代码：

data = {
    'name': 'Alice',
    'age': 30,
    'email': 'alice@example.com',
    'phone': '12345678',
    'score': 85
}

# 进行数据验证
validated_data = schema(data)
print(validated_data)

在这个示例中，将数据data传入验证规则schema中进行验证。如果数据符合规则，则返回经过验证的数据；否则，会抛出ValidationError异常。

4 高级功能

4.1. 自定义验证函数

除了使用内置的验证规则外，Voluptuous还支持用户自定义验证函数，以满足更复杂的验证需求。

示例代码：

from voluptuous import Schema, Required, Length, Range, All, Invalid

# 自定义验证函数
def validate_email(email):
    if not email.endswith('@example.com'):
        raise Invalid("邮箱必须以@example.com结尾")
    return email

# 定义验证规则，包含自定义验证函数
schema = Schema({
    Required('name'): str,
    Required('email'): All(str, validate_email),
})

# 进行数据验证
data = {
    'name': 'Bob',
    'email': 'bob@example.com',
}

validated_data = schema(data)
print(validated_data)

在这个示例中，定义了一个自定义验证函数validate_email，用于验证邮箱是否以@example.com结尾。然后，将这个验证函数应用于验证规则中的邮箱字段，以确保邮箱符合特定的格式要求。

4.2. 嵌套验证

Voluptuous还支持对嵌套数据进行验证，例如对字典中的嵌套字典或列表进行验证。

示例代码：

from voluptuous import Schema, Required

# 定义嵌套验证规则
nested_schema = Schema({
    Required('nested_key1'): str,
    Required('nested_key2'): int,
})

schema = Schema({
    Required('name'): str,
    Required('nested_data'): nested_schema,
})

# 进行数据验证
data = {
    'name': 'Alice',
    'nested_data': {
        'nested_key1': 'value1',
        'nested_key2': 123
    }
}

validated_data = schema(data)
print(validated_data)

在这个示例中，定义了一个嵌套的验证规则nested_schema，然后将其应用于主验证规则中的嵌套数据字段nested_data，以实现对嵌套数据的验证。

4.3. 错误信息定制

Voluptuous还允许用户定制验证失败时的错误信息，以提供更友好和清晰的错误提示。

示例代码：

from voluptuous import Schema, Required, Invalid

# 自定义错误信息
def custom_error_msg(err):
    raise Invalid(f"验证失败：{err}")

# 定义验证规则，包含自定义错误信息
schema = Schema({
    Required('name'): str,
    Required('age'): int,
}, error=custom_error_msg)

# 进行数据验证
data = {
    'name': 'Alice',
    'age': '30'  # 故意传入字符串类型的年龄，触发验证失败
}

try:
    validated_data = schema(data)
except Invalid as e:
    print(e)

在这个示例中，定义了一个自定义错误信息函数custom_error_msg，用于定制验证失败时的错误提示。然后将这个函数应用于验证规则中，以提供更加清晰和友好的错误信息。

5 实际应用场景

当谈到Voluptuous库的实际应用场景时，它在各种数据验证和清洗的情境下都能发挥作用。

5.1. Web表单验证

在Web开发中，表单数据的验证是非常重要的一环。Voluptuous可以用于验证用户提交的表单数据，确保数据的完整性和准确性。

示例代码：

from flask import Flask, request
from voluptuous import Schema, Required, Length, Email

app = Flask(__name__)

# 定义表单验证规则
form_schema = Schema({
    Required('username'): str,
    Required('email'): Email(),
    Required('password'): Length(min=6)
})

@app.route('/submit_form', methods=['POST'])
def submit_form():
    form_data = request.form.to_dict()
    try:
        validated_data = form_schema(form_data)
        # 数据验证通过，继续处理逻辑
        return '表单验证通过'
    except Exception as e:
        return f'表单验证失败：{str(e)}'

if __name__ == '__main__':
    app.run(debug=True)

在这个示例中，使用Flask框架来接收用户提交的表单数据，并使用Voluptuous来定义表单验证规则。如果数据验证通过，则继续处理逻辑；否则，返回验证失败的错误信息。

5.2. 配置文件验证

在应用程序开发中，通常会有配置文件来存储各种参数和设置。Voluptuous可以用于验证配置文件中的数据，防止配置错误导致程序异常。

示例代码：

from voluptuous import Schema, Required, Coerce

# 定义配置文件验证规则
config_schema = Schema({
    Required('database_host'): str,
    Required('database_port'): Coerce(int),
    Required('debug_mode'): Coerce(bool)
})

# 加载配置文件数据
config_data = {
    'database_host': 'localhost',
    'database_port': '3306',
    'debug_mode': 'True'
}

try:
    validated_config = config_schema(config_data)
    # 配置文件验证通过，继续加载配置
    print('配置文件验证通过')
except Exception as e:
    print(f'配置文件验证失败：{str(e)}')

在这个示例中，定义了一个配置文件验证规则config_schema，然后使用Voluptuous对配置文件数据进行验证。如果配置文件数据符合规则，则继续加载配置；否则，输出验证失败的错误信息。

5.3. 数据清洗

有时候，需要对原始数据进行清洗和处理，以确保数据的质量和准确性。Voluptuous可以用于对原始数据进行验证和清洗操作。

示例代码：

from voluptuous import Schema, Required, All, Coerce, Invalid

# 自定义清洗函数
def clean_age(value):
    try:
        age = int(value)
        if age < 0:
            raise ValueError()
        return age
    except ValueError:
        raise Invalid('年龄必须为非负整数')

# 定义数据清洗规则
data_cleaning_schema = Schema({
    Required('name'): str,
    Required('age'): All(Coerce(clean_age), int)
})

# 原始数据
raw_data = {
    'name': 'Alice',
    'age': '-30'  # 故意传入错误的年龄数据
}

try:
    cleaned_data = data_cleaning_schema(raw_data)
    # 数据清洗通过，继续处理逻辑
    print(cleaned_data)
except Invalid as e:
    print(f'数据清洗失败：{str(e)}')

在这个示例中，定义了一个自定义清洗函数clean_age，用于将年龄数据转换为非负整数。然后，使用Voluptuous对原始数据进行验证和清洗操作，确保数据符合要求。

6 总结

Voluptuous库是一个强大的Python数据验证库，适用于各种场景，如Web表单验证、配置文件验证和数据清洗。通过定义验证规则和自定义验证函数，Voluptuous可以轻松应对复杂的数据验证需求，并提供友好的错误提示。其支持嵌套验证和错误信息定制，使得数据验证工作更加灵活和可靠。总之，Voluptuous是Python开发中不可或缺的一部分，可以帮助开发者确保数据的完整性和准确性，提高代码的可维护性和可靠性。

THE END !

文章结束，感谢阅读。您的点赞，收藏，评论是我继续更新的动力。大家有推荐的公众号可以评论区留言，共同学习，一起进步。