Validierungsmodul
Dieses Modul enthält die Klasse Validator
zum Validieren verschiedener Arten von Parametern. Jede Methode akzeptiert einen Parameternamen, einen Wert und optionale Schlüsselwortargumente. Die Funktionen lösen den Fehler ParameterValidationError
aus, wenn der Parameterwert ungültig ist.
Die Validierungsfunktionen geben den bereitgestellten Wert in seinem validierten Typ zurück.
Beispiel:
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)
Basiert auf: object
Eine Klasse, die Funktionen zur Validierung von Parametern enthält.
validate_csv
validate_csv(param_name, csv_string, delimiter=', ', possible_values=None, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String mit kommagetrennten Werten (CSV).
Parameter | |
---|---|
param_name |
str Name des Parameters. |
csv_string |
str
Der zu validierende CSV-String. |
delimiter |
str
Das Zeichen, das die Werte im CSV-String trennt. |
possible_values |
list Eine Liste möglicher Werte. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Nachricht ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der CSV-String ungültig ist.
Gibt Folgendes zurück:
Die Liste der Werte im CSV-String.
Rückgabetyp
list
validate_ddl
validate_ddl(param_name, value, ddl_values, case_sensitive=False, default_value=<object object>, print_value=True, print_error=False)
Validiert einen DDL-String.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende DDL-String. |
ddl_values |
list Eine Liste gültiger DDL-Werte. |
case_sensitive |
bool
Legen Sie fest, ob eine Validierung mit Berücksichtigung der Groß-/Kleinschreibung durchgeführt werden soll. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Nachricht ausgegeben werden soll. |
Gibt Folgendes zurück:
Der validierte DDL-String.
Löst aus
ParameterValidationError: Wenn der DDL-String ungültig ist.
validate_email
validate_email(param_name, email, default_value=<object object>, print_value=True, print_error=False)
Validiert einen E‑Mail-String.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
email |
str Die zu validierende E-Mail-Adressen-String. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Nachricht ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der E‑Mail-Adressenstring ungültig ist.
Gibt Folgendes zurück:
Der E‑Mail-Adressstring.
Rückgabetyp
str
validate_float
validate_float(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String, der eine Gleitkommazahl enthält.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Nachricht ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert keine Gleitkommazahl ist.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
float
validate_integer
validate_integer(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String, der eine Ganzzahl enthält.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Nachricht ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert keine Ganzzahl ist.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
validate_json
validate_json(param_name, json_string, default_value=<object object>, print_value=True, print_error=False, **kwargs)
Validiert einen JSON-String.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
json_string |
str Der zu validierende JSON-String. |
default_value |
any Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool Gibt an, ob der Ausnahmefehler als Teil der Nachricht ausgegeben werden soll. |
**kwrags |
dict Keyword-Argumente für die Funktion |
Löst aus
ParameterValidationError: Wenn der JSON-String ungültig ist.
Gibt Folgendes zurück:
Das geparste JSON-Objekt.
validate_lower_limit
validate_lower_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String für die Untergrenze.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
limit |
int Die Untergrenze. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert unter dem Grenzwert liegt.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
validate_non_negative
validate_non_negative(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String, der eine nicht negative Ganzzahl enthält.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert negativ ist.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
validate_non_zero
validate_non_zero(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String, der eine Ganzzahl ungleich null enthält.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert null ist.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
validate_percentage
validate_percentage(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Validiert einen Prozentstring.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert keine Prozentangabe ist.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
validate_positive
validate_positive(param_name, value, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String, der eine positive Ganzzahl enthält.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert nicht positiv ist.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
validate_range
validate_range(param_name, value, min_limit, max_limit, default_value=<object object>, print_value=True, print_error=False)
Validiert einen Bereichsstring.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
min_limit |
int Die Untergrenze. |
max_limit |
int Die Obergrenze. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert außerhalb des gültigen Bereichs liegt.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
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)
Validiert einen Schweregradstring.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
severity |
str Der zu validierende Schweregradwert. |
min_limit |
int Die Untergrenze. |
max_limit |
int Die Obergrenze. |
possible_values |
list Eine Liste möglicher Werte. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool
Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool
Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert ungültig ist.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
validate_upper_limit
validate_upper_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)
Validiert einen String für die Obergrenze.
Parameter | |
---|---|
param_name |
str Name des Parameters. |
value |
str Der zu validierende Wert. |
limit |
int Die Obergrenze. |
default_value |
any
Der Standardwert, der im Falle eines Validierungsfehlers zurückgegeben werden soll. |
print_value |
bool Geben Sie an, ob der Parameterwert als Teil der Nachricht ausgegeben werden soll. |
print_error |
bool Gibt an, ob der Ausnahmefehler als Teil der Meldung ausgegeben werden soll. |
Löst aus
ParameterValidationError: Wenn der Wert das Limit überschreitet.
Gibt Folgendes zurück:
Der validierte Wert.
Rückgabetyp
int
Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten