简单的数据验证

时间:2012-09-02 10:15:41

标签: python python-module validation

我正在编写一个python模块,它将包含一些将操作mongodb数据库的函数。

如何在将数据保存到数据库之前验证传递给该函数的输入数据?

例如,假设模块中的一个函数是createUser(user),它接受​​python字典作为参数。该字典包含要保存在数据库中的用户信息。我想创建一个自动验证例程,它检查字典结构是否与数据库结构匹配。

1 个答案:

答案 0 :(得分:4)

我发布了#34; pyvaru" (https://github.com/daveoncode/pyvaru)几天前,它是一个简单,灵活且不显眼的Python 3(3.4+)数据验证库,基于验证规则的概念。

来自doc:

的引用
  

给定一个现有模型进行验证,如下所示(但它可以   是一个简单的字典或任何数据结构,因为pyvaru没有   对数据格式做出任何假设):

class User:
    def __init__(self, first_name: str, last_name: str, date_of_birth: datetime, sex: str):
        self.first_name = first_name
        self.last_name = last_name
        self.date_of_birth = date_of_birth
        self.sex = sex
     

我们必须通过实现get_rules()方法来定义验证器   对于我们要验证的每个字段,我们必须提供一个或多个   适当的规则。

from pyvaru import Validator
from pyvaru.rules import TypeRule, FullStringRule, ChoiceRule, PastDateRule

class UserValidator(Validator):
    def get_rules(self) -> list:
        user = self.data # type: User
        return [
            TypeRule(apply_to=user,
                     label='User',
                     valid_type=User,
                     error_message='User must be an instance of user model.',
                     stop_if_invalid=True),
            FullStringRule(user.first_name, 'First name'),
            FullStringRule(user.last_name, 'Last name'),
            ChoiceRule(user.sex, 'Sex', choices=('M', 'F')),
            PastDateRule(user.date_of_birth, 'Date of birth')
        ]
     

最后,我们有两个关于如何使用自定义验证器的选择:

     

作为上下文处理器:

with UserValidator(user):
    # do whatever you want with your valid model
     

在这种情况下,内部代码只有在执行时才会执行   验证成功,否则为ValidationException(包含   引发了带有相应报告的validation_result属性。

     

通过调用validate()方法(返回ValidationResult)

validation = UserValidator(user).validate()
if validation.is_successful():
    # do whatever you want with your valid model
else:
    # you can take a proper action and access validation.errors
    # in order to provide a useful message to the application user,
    # write logs or whatever
     

假设我们将User的实例配置为如下所示:

user = User(first_name=' ',
            last_name=None,
            date_of_birth=datetime(2020, 1, 1),
            sex='unknown')
     

通过使用先前定义的规则运行验证,我们将获得   ValidationResult具有以下错误:

{
    'First name': ['String is empty.'],
    'Last name': ['Not a string.'],
    'Sex': ['Value not found in available choices.'],
    'Date of birth': ['Not a past date.']
}