Modulo di convalida

Questo modulo contiene la classe Validator per la convalida di vari tipi di parametri. Ogni metodo accetta un nome parametro, un valore e argomenti di parole chiave facoltativi. Le funzioni generano l'errore ParameterValidationError se il valore parametro non è valido.

Le funzioni di convalida restituiscono il valore fornito nel tipo convalidato.

Esempio:

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)

Base: object

Una classe che contiene funzioni di convalida dei parametri.

validate_csv

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

Convalida una stringa con valori separati da virgola (CSV).

Parametri
param_name	str Il nome del parametro.
csv_string	str La stringa CSV da convalidare.
delimiter	str Il carattere che separa i valori nella stringa CSV.
possible_values	list Un elenco di valori possibili.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando la stringa CSV non è valida.

Restituisce

L'elenco dei valori nella stringa CSV.

Tipo restituito

list

validate_ddl

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

Convalida una stringa DDL.

Parametri
param_name	str Il nome del parametro.
value	str La stringa DDL da convalidare.
ddl_values	list Un elenco di valori DDL validi.
case_sensitive	bool Definisci se eseguire o meno una convalida sensibile alle maiuscole.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Restituisce

La stringa DDL convalidata.

Rialzi

ParameterValidationError: quando la stringa DDL non è valida.

validate_email

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

Convalida una stringa email.

Parametri
param_name	str Il nome del parametro.
email	str La stringa dell'indirizzo email da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando la stringa dell'indirizzo email non è valida.

Restituisce

La stringa dell'indirizzo email.

Tipo restituito

str

validate_float

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

Convalida una stringa float.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore non è un numero in virgola mobile.

Restituisce

Il valore convalidato.

Tipo restituito

float

validate_integer

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

Convalida una stringa di numeri interi.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore non è un numero intero.

Restituisce

Il valore convalidato.

Tipo restituito

int

validate_json

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

Convalida una stringa JSON.

Parametri
param_name	str Il nome del parametro.
json_string	str La stringa JSON da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.
**kwrags	dict Argomenti delle parole chiave per la funzione json.loads().

Rialzi

ParameterValidationError: quando la stringa JSON non è valida.

Restituisce

L'oggetto JSON analizzato.

validate_lower_limit

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

Convalida una stringa di limite inferiore.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
limit	int Il limite inferiore.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore è inferiore al limite.

Restituisce

Il valore convalidato.

Tipo restituito

int

validate_non_negative

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

Valida una stringa di numeri interi non negativi.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore è negativo.

Restituisce

Il valore convalidato.

Tipo restituito

int

validate_non_zero

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

Valida una stringa di numeri interi non nulli.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore è zero.

Restituisce

Il valore convalidato.

Tipo restituito

int

validate_percentage

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

Convalida una stringa di percentuale.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore non è una percentuale.

Restituisce

Il valore convalidato.

Tipo restituito

int

validate_positive

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

Convalida una stringa di numeri interi positivi.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore non è positivo.

Restituisce

Il valore convalidato.

Tipo restituito

int

validate_range

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

Convalida una stringa di intervallo.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
min_limit	int Il limite inferiore.
max_limit	int Il limite superiore.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore non rientra nell'intervallo.

Restituisce

Il valore convalidato.

Tipo restituito

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)

Convalida una stringa di gravità.

Parametri
param_name	str Il nome del parametro.
severity	str Il valore di gravità da convalidare.
min_limit	int Il limite inferiore.
max_limit	int Il limite superiore.
possible_values	list Un elenco di valori possibili.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore non è valido.

Restituisce

Il valore convalidato.

Tipo restituito

int

validate_upper_limit

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

Convalida una stringa di limite superiore.

Parametri
param_name	str Il nome del parametro.
value	str Il valore da convalidare.
limit	int Il limite superiore.
default_value	any Il valore predefinito da restituire in caso di errore di convalida.
print_value	bool Definisci se stampare il valore parametro come parte del messaggio.
print_error	bool Definisci se stampare l'errore di eccezione come parte del messaggio.

Rialzi

ParameterValidationError: quando il valore supera il limite.

Restituisce

Il valore convalidato.

Tipo restituito

int

Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.