驗證模組

這個模組包含 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

class TIPCommon.validation.ParameterValidator

class TIPCommon.validation.ParameterValidator(siemplify)

基底：object

包含參數驗證函式的類別。

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

還有其他問題嗎？向社群成員和 Google SecOps 專業人員尋求答案。