유효성 검사 모듈
이 모듈에는 다양한 유형의 매개변수를 검증하는 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
클래스 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
|
발생 오류
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)
0이 아닌 정수 문자열의 유효성을 검사합니다.
매개변수 | |
---|---|
param_name |
str 매개변수의 이름입니다. |
value |
str 검증할 값입니다. |
default_value |
any
유효성 검사 오류가 발생할 경우 반환할 기본값입니다. |
print_value |
bool
매개변수 값을 메시지의 일부로 인쇄할지 여부를 정의합니다. |
print_error |
bool
메시지의 일부로 예외 오류를 출력할지 여부를 정의합니다. |
발생 오류
ParameterValidationError - 값이 0인 경우
반환
검증된 값입니다.
반환 유형
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 전문가로부터 답변을 받으세요.