验证者

验证是一种确保我们的数据库只接收适合每个属性的信息类型的方法。毕竟，我们不希望意外类型的数据进入我们的代码并导致意外行为。幸运的是，SQLAlchemy 有一个包可以使验证变得快速而简单！

让我们看一些简单的例子。假设我们有一个简单的模型，Sandwich。这里我们已经初始化了数据库，并从配置文件中导入它。

from config import db

class Sandwich(db.Model):
    __tablename__ = 'sandwiches'

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String)
    description = db.Column(db.String)
    price = db.Column(db.Float)

如果我们想对这些属性中的任何一个添加验证，我们需要首先导入验证包。

`从 sqlalchemy.orm 导入验证`

然后，使用模型内的“@validates”装饰器编写我们的函数。

@validates('name')
    def validate_name(self, key, value):
        if not value:
            raise ValueError('Name cannot be empty.')
        if type(value) != str:
            raise ValueError('Name must be a string.')
        return value

那么这里发生了什么？让我们分解一下。@validates 是一个装饰器，它让我们的 ORM 知道在将任何使用“name”键接收的值添加到数据库之前，先通过我们的验证函数传递它们。我们返回的值是最终提供给数据库的值。“key”参数是正在评估的键，在本例中为“name”，值是该键的值，因此是我们尝试添加的实际名称（希望是文本）。所以在这里我们检查以确保传入的 name 属性不为空，并且实际上是一个字符串。如果不是，我们会引发错误。

我们还可以通过将多个属性添加到其参数中来通过同一个装饰器运行它们。

@validates('name', 'description')
    def validate_text(self, key, value):
        if not value:
            raise ValueError(f'{key} cannot be empty.')
        if type(value) != str:
            raise ValueError(f'{key} must be a string.')
        return value

此函数验证我们的名称和描述属性，但我们通常不会对不同的属性执行相同的验证。根据我们拥有的验证的不同程度和数量，我们可以用几种不同的方式进行验证。我们可以为其他属性运行单独的验证器，让我们也为描述和价格验证添加长度验证：

@validates('name')
    def validate_name(self, key, value):
        if not value:
            raise ValueError('Name cannot be empty.')
        if type(value) != str:
            raise ValueError('Name must be a string.')
        return value

    @validates('description')
        def validate_description(self, key, value):
        if not value:
            raise ValueError('Description cannot be empty.')
        if type(value) != str:
            raise ValueError('Description must be a string.')
        if not 10 <= len(value) <= 200:
                raise ValueError('Description must be between 10 and 200 characters.')
        return value

    @validates('price')
    def validate_price(self, key, value):
        if type(value) != float:
            raise ValueError('Price must be a float.')
        if not 1 <= value <= 15:
            raise ValueError('Price must be between 1 and 15')

或者，我们可以对两者保留相同的验证器，并使用传入的关键参数来调整针对每个属性运行的验证。

@validates('name', 'description', 'price')
    def validate(self, key, value):
        if key != 'price:
            if not value:
                raise ValueError(f'{key} cannot be empty.')
            if type(value) != str:
                raise ValueError(f'{key} must be string.')
            if key == 'description':
                if not 10 <= len(value) <= 200:
                    raise ValueError('Description must be between 10 and 200 characters.')
        else:
            if type(value) != float:
                raise ValueError(f'{key} must be a float.')
            if not 1 <= value <= 15:
                raise ValueError('Price must be between 1 and 15')
        return value

嗯，这有点混乱，让我们重构为两个独立的验证器。

@validates('name', 'description')
    def validate_text(self, key, value):
       if not value:
            raise ValueError(f'{key} cannot be empty.')
        if type(value) != str:
            raise ValueError(f'{key} must be string.')
        if key == 'description':
            if not 10 <= len(value) <= 200:
                raise ValueError('Description must be between 10 and 200 characters.')

    @validates('price')
    def validate_price(self, key, value):
        if type(value) != float:
            raise ValueError('Price must be a float.')
        if not 1 <= value <= 15:
            raise ValueError('Price must be between 1 and 15')

好多了！这是我们完成的模型：

from sqlalchemy.orm import validates
from config import db

class Sandwich(db.Model):
    __tablename__ = 'sandwiches'

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String)
    description = db.Column(db.String)
    price = db.Column(db.Float)

    @validates('name', 'description')
    def validate_text(self, key, value):
        if not value:
            raise ValueError(f'{key} cannot be empty.')
        if type(value) != str:
            raise ValueError(f'{key} must be string.')
        if key == 'description':
            if not 10 <= len(value) <= 200:
                raise ValueError('Description must be between 10 and 200 characters.')

    @validates('price')
    def validate_price(self, key, value):
        if type(value) != float:
            raise ValueError('Price must be a float.')
        if not 1 <= value <= 15:
            raise ValueError('Price must be between 1 and 15')

就是这样！验证是确保您的数据库保持正确和适当的一种简单工具。

CLIS.CC

验证者