Modul validasi
Modul ini berisi class Validator untuk memvalidasi berbagai jenis parameter. Setiap metode menggunakan nama parameter, nilai, dan argumen kata kunci opsional. Fungsi ini akan memunculkan error ParameterValidationError jika nilai parameter tidak valid.
Fungsi validasi menampilkan nilai yang diberikan dalam jenis yang divalidasinya.
Contoh:
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)
Dasar: object
Class yang berisi fungsi validasi parameter.
validate_csv
validate_csv(param_name, csv_string, delimiter=', ', possible_values=None, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string nilai yang dipisahkan koma (CSV).
| Parameter | |
|---|---|
param_name |
strNama parameter. |
csv_string |
str
String CSV yang akan divalidasi. |
delimiter |
str
Karakter yang memisahkan nilai dalam string CSV. |
possible_values |
listDaftar kemungkinan nilai. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika string CSV tidak valid.
Hasil
Daftar nilai dalam string CSV.
Jenis hasil yang ditampilkan
list
validate_ddl
validate_ddl(param_name, value, ddl_values, case_sensitive=False, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string DDL.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strString DDL yang akan divalidasi. |
ddl_values |
listDaftar nilai DDL yang valid. |
case_sensitive |
bool
Tentukan apakah akan melakukan validasi peka huruf besar/kecil atau tidak. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Hasil
String DDL yang divalidasi.
Meningkatkan
ParameterValidationError - Jika string DDL tidak valid.
validate_email
validate_email(param_name, email, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string email.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
email |
strString alamat email yang akan divalidasi. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika string alamat email tidak valid.
Hasil
String alamat email.
Jenis hasil yang ditampilkan
str
validate_float
validate_float(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string float.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilai bukan float.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
float
validate_integer
validate_integer(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string bilangan bulat.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilainya bukan bilangan bulat.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
validate_json
validate_json(param_name, json_string, default_value=<object object>, print_value=True, print_error=False, **kwargs)
Memvalidasi string JSON.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
json_string |
strString JSON yang akan divalidasi. |
default_value |
anyNilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
boolTentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
boolMenentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
**kwrags |
dictArgumen kata kunci untuk fungsi |
Meningkatkan
ParameterValidationError - Jika string JSON tidak valid.
Hasil
Objek JSON yang diuraikan.
validate_lower_limit
validate_lower_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string batas bawah.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
limit |
intBatas bawah. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilai kurang dari batas.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
validate_non_negative
validate_non_negative(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string bilangan bulat non-negatif.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilainya negatif.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
validate_non_zero
validate_non_zero(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string bilangan bulat non-nol.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilainya nol.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
validate_percentage
validate_percentage(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string persentase.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilai bukan persentase.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
validate_positive
validate_positive(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string bilangan bulat positif.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilai tidak positif.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
validate_range
validate_range(param_name, value, min_limit, max_limit, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string rentang.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
min_limit |
intBatas bawah. |
max_limit |
intBatas atas. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilai berada di luar rentang.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
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)
Memvalidasi string tingkat keparahan.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
severity |
strNilai tingkat keparahan yang akan divalidasi. |
min_limit |
intBatas bawah. |
max_limit |
intBatas atas. |
possible_values |
listDaftar kemungkinan nilai. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
bool
Tentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
bool
Menentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilai tidak valid.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
validate_upper_limit
validate_upper_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)
Memvalidasi string batas atas.
| Parameter | |
|---|---|
param_name |
strNama parameter. |
value |
strNilai yang akan divalidasi. |
limit |
intBatas atas. |
default_value |
any
Nilai default yang akan ditampilkan jika terjadi error validasi. |
print_value |
boolTentukan apakah akan mencetak nilai parameter sebagai bagian dari pesan. |
print_error |
boolMenentukan apakah akan mencetak error pengecualian sebagai bagian dari pesan. |
Meningkatkan
ParameterValidationError - Jika nilai melebihi batas.
Hasil
Nilai yang divalidasi.
Jenis hasil yang ditampilkan
int
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.