Marshmallow内建函数Validator

分手后的思念是犯贱 2022-05-14 10:37 206阅读 0赞

# Validator #

#### 各种类型数据的验证类。 ####

## `class marshmallow.validate.ContainsOnly` ##

成功的验证器if value是一个序列，序列中的每个元素也在传递的序列中choices。空输入被认为有效。
    
    参数： 
    选择（可迭代） - 与...相同OneOf。
    标签（可迭代） - 与...相同OneOf。
    错误（str） - 与...相同OneOf。
    版本3.0.0b2中已更改：重复值被视为有效。
    版本3.0.0b2中已更改：空输入被视为有效。使用 验证对空输入。validate.Length(min=1)

## `class marshmallow.validate.Email` ##

验证电子邮件地址。
    
    参数： error（str） - 出现验证错误时引发的错误消息。可以用插值进行插值{input}。

## `class marshmallow.validate.Equal` ##

value传递给它的成功的验证器等于comparable。
    
    参数： 
    - 可比较 - 要比较的对象。
    error（str） - 出现验证错误时引发的错误消息。可以用{input}和插值{other}。

## `class （min = None，max = None，error = None，equal = None)marshmallow.validate.Length` ##

如果传递给它的值具有最小值和最大值之间的长度，则验证器成功 。使用len（），因此它可以用于字符串，列表或任何长度的东西。
    
    参数： 
    min（int） - 最小长度。如果未提供，则不会检查最小长度。
    max（int） - 最大长度。如果未提供，则不会检查最大长度。
    equal（int） - 确切的长度。如果提供，则不会检查最大和最小长度。
    error（str） - 出现验证错误时引发的错误消息。可以插入{input}，{min}和{max}。

## `class marshmallow.validate.NoneOf（iterable，error = None ）` ##

验证者如果value是成员则失败iterable。
    
    参数： 
    iterable（iterable） - 一系列无效值。
    error（str） - 出现验证错误时引发的错误消息。可以使用{input}和插值{values}。

## `class marshmallow.validate.OneOf` ##

成功的验证者是否value是成员choices。
    
    参数： 
    选项（可迭代） - 一系列有效值。
    labels（iterable） - 与选项配对的可选标签序列。
    error（str） - 出现验证错误时引发的错误消息。可以插入{input}，{choices}和{labels}。
    options（valuegetter = <class'str'> ）[source] 在（value，label）对上返回一个生成器，其中value是与每个选择关联的字符串。例如，这种便利方法可用于填充表单选择字段。 参数： valuegetter - 可以是可调用的或字符串。在前一种情况下，它必须是单参数可调用的，它返回一个选择的值。在后一种情况下，字符串指定选择对象的属性的名称。默认为str() 或unicode()。

## `class marshmallow.validate.Predicate` ##

调用指定method的value对象。如果被调用的方法在布尔上下文中返回一个计算结果为True的对象，则验证器会成功。任何其他关键字参数都将传递给该方法。
    
    参数： 
    method（str） - 要调用的方法的名称。
    error（str） - 出现验证错误时引发的错误消息。可以用{input}和插值{method}。
    kwargs - 传递给方法的其他关键字参数。

## `class marshmallow.validate.Range（min = None，max = None，error = None ）` ##

如果传递的值大于或等于min且小于或等于max，则验证器成功。如果min 未指定或指定为None，则不存在下限。如果max未指定或指定为None，则不存在上限。
    
    参数： 
    min - 最小值（下限）。如果未提供，则不会检查最小值。
    max - 最大值（上限）。如果未提供，则不会检查最大值。
    error（str） - 出现验证错误时引发的错误消息。可以插入{input}，{min}和{max}。

## `class marshmallow.validate.Regexp（regex，flags = 0，error = None ）` ##

验证value提供的正则表达式。
    
    参数： 
    regex - 要使用的正则表达式字符串。也可以是编译正则表达式模式。
    flags - 要使用的regexp标志，例如re.IGNORECASE。如果regex不是字符串，则忽略。
    error（str） - 出现验证错误时引发的错误消息。可以用{input}和插值{regex}。

## `class marshmallow.validate.URL（relative = False，error = None，schemes = None，require_tld = True ）` ##

验证URL。
    
    参数： 
    relative（bool） - 是否允许相对URL。
    error（str） - 出现验证错误时引发的错误消息。可以用插值进行插值{input}。
    方案（集） - 有效方案。默认情况下，http，https， ftp，和ftps是允许的。
    require_tld（bool） - 是否拒绝非FQDN主机名

## `class marshmallow.validate.Validator` ##

验证器的基本抽象类。
    
    注意
    此类不提供任何行为。它仅用于__repr__为验证器添加有用的实现。