此页面由 Cloud Translation API 翻译。

验证模块

此模块包含用于验证各种类型参数的 Validator 类。每种方法都接受一个参数名称、一个值和可选的关键字实参。如果参数值无效，这些函数会引发 ParameterValidationError 错误。

验证函数会以验证后的类型返回所提供的值。

示例：

validator = ParameterValidator(siemplify) # siemplify SDK object 

validated_value = validator.validate_float(param_name='something', value='3.7') print(validated_value) # 3.7 as float

validated_value = validator.validate_int(param_name='something', validated_value) print(validated_value) # 3 as integer

类 TIPCommon.validation.ParameterValidator

类 TIPCommon.validation.ParameterValidator(siemplify)

代码库：对象

包含参数验证函数的类。

validate_csv

validate_csv(param_name, csv_string, delimiter=', ', possible_values=None, default_value=<object object>, print_value=True, print_error=False)

验证以英文逗号分隔的值 (CSV) 字符串。

参数
`param_name`	`str` 参数的名称。
`csv_string`	`str` 要验证的 CSV 字符串。
`delimiter`	`str` 用于分隔 CSV 字符串中的值的字符。
`possible_values`	`list` 可能值的列表。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当 CSV 字符串无效时。

返回值

CSV 字符串中的值列表。

返回类型

list

validate_ddl

validate_ddl(param_name, value, ddl_values, case_sensitive=False, default_value=<object object>, print_value=True, print_error=False)

验证 DDL 字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的 DDL 字符串。
`ddl_values`	`list` 有效 DDL 值的列表。
`case_sensitive`	`bool` 定义是否执行区分大小写的验证。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

返回值

经过验证的 DDL 字符串。

可能引发的错误

ParameterValidationError - 当 DDL 字符串无效时。

validate_email

validate_email(param_name, email, default_value=<object object>, print_value=True, print_error=False)

验证电子邮件字符串。

参数
`param_name`	`str` 参数的名称。
`email`	`str` 要验证的电子邮件地址字符串。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当电子邮件地址字符串无效时。

返回值

电子邮件地址字符串。

返回类型

str

validate_float

validate_float(param_name, value, default_value=<object object>, print_value=True, print_error=False)

验证浮点数字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值不是浮点数时。

返回值

经过验证的值。

返回类型

float

validate_integer

validate_integer(param_name, value, default_value=<object object>, print_value=True, print_error=False)

验证整数字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值不是整数时。

返回值

经过验证的值。

返回类型

int

validate_json

validate_json(param_name, json_string, default_value=<object object>, print_value=True, print_error=False, **kwargs)

验证 JSON 字符串。

参数
`param_name`	`str` 参数的名称。
`json_string`	`str` 要验证的 JSON 字符串。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。
`**kwrags`	`dict` `json.loads()` 函数的关键字实参。

可能引发的错误

ParameterValidationError - 当 JSON 字符串无效时。

返回值

已解析的 JSON 对象。

validate_lower_limit

validate_lower_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)

验证下限字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`limit`	`int` 下限。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值小于限制时。

返回值

经过验证的值。

返回类型

int

validate_non_negative

validate_non_negative(param_name, value, default_value=<object object>, print_value=True, print_error=False)

验证非负整数字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值为负数时。

返回值

经过验证的值。

返回类型

int

validate_non_zero

validate_non_zero(param_name, value, default_value=<object object>, print_value=True, print_error=False)

验证非零整数字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值为零时。

返回值

经过验证的值。

返回类型

int

validate_percentage

validate_percentage(param_name, value, default_value=<object object>, print_value=True, print_error=False)

验证百分比字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值不是百分比时。

返回值

经过验证的值。

返回类型

int

validate_positive

validate_positive(param_name, value, default_value=<object object>, print_value=True, print_error=False)

验证正整数字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值不是正数时。

返回值

经过验证的值。

返回类型

int

validate_range

validate_range(param_name, value, min_limit, max_limit, default_value=<object object>, print_value=True, print_error=False)

验证范围字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`min_limit`	`int` 下限。
`max_limit`	`int` 上限。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值超出范围时。

返回值

经过验证的值。

返回类型

int

validate_severity

validate_severity(param_name, severity, min_limit=None, max_limit=None, possible_values=None, default_value=<object object>, print_value=True, print_error=False)

验证严重程度字符串。

参数
`param_name`	`str` 参数的名称。
`severity`	`str` 要验证的严重程度值。
`min_limit`	`int` 下限。
`max_limit`	`int` 上限。
`possible_values`	`list` 可能值的列表。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值无效时。

返回值

经过验证的值。

返回类型

int

validate_upper_limit

validate_upper_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)

验证上限字符串。

参数
`param_name`	`str` 参数的名称。
`value`	`str` 要验证的值。
`limit`	`int` 上限。
`default_value`	`any` 出现验证错误时要返回的默认值。
`print_value`	`bool` 定义是否将参数值作为消息的一部分进行打印。
`print_error`	`bool` 定义是否将异常错误作为消息的一部分进行打印。

可能引发的错误

ParameterValidationError - 当值超出限制时。

返回值

经过验证的值。

返回类型

int