Cette page a été traduite par l'API Cloud Translation.

Module de validation

Ce module contient la classe Validator permettant de valider différents types de paramètres. Chaque méthode prend un nom de paramètre, une valeur et des arguments de mot clé facultatifs. Les fonctions génèrent l'erreur ParameterValidationError si la valeur du paramètre n'est pas valide.

Les fonctions de validation renvoient la valeur fournie dans son type validé.

Exemple :

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)

Bases : objet

Classe contenant des fonctions de validation des paramètres.

validate_csv

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

Valide une chaîne de valeurs séparées par une virgule (CSV).

Paramètres
`param_name`	`str` Nom du paramètre.
`csv_string`	`str` Chaîne CSV à valider.
`delimiter`	`str` Caractère qui sépare les valeurs dans la chaîne CSV.
`possible_values`	`list` Liste des valeurs possibles.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la chaîne CSV n'est pas valide.

Renvoie

Liste des valeurs dans la chaîne CSV.

Type renvoyé

list

validate_ddl

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

Valide une chaîne LDD.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Chaîne DDL à valider.
`ddl_values`	`list` Liste des valeurs LDD valides.
`case_sensitive`	`bool` Définissez si une validation sensible à la casse doit être effectuée ou non.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Renvoie

Chaîne LDD validée.

Génère

ParameterValidationError : lorsque la chaîne LDD'est pas valide.

validate_email

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

Valide une chaîne d'adresse e-mail.

Paramètres
`param_name`	`str` Nom du paramètre.
`email`	`str` Chaîne d'adresse e-mail à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la chaîne de l'adresse e-mail n'est pas valide.

Renvoie

Chaîne d'adresse e-mail.

Type renvoyé

str

validate_float

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

Valide une chaîne float.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur n'est pas un float.

Renvoie

Valeur validée.

Type renvoyé

float

validate_integer

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

Valide une chaîne d'entiers.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur n'est pas un nombre entier.

Renvoie

Valeur validée.

Type renvoyé

int

validate_json

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

Valide une chaîne JSON.

Paramètres
`param_name`	`str` Nom du paramètre.
`json_string`	`str` Chaîne JSON à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.
`**kwrags`	`dict` Arguments de mot clé pour la fonction `json.loads()`.

Génère

ParameterValidationError : lorsque la chaîne JSON n'est pas valide.

Renvoie

Objet JSON analysé.

validate_lower_limit

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

Valide une chaîne de limite inférieure.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`limit`	`int` Limite inférieure.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur est inférieure à la limite.

Renvoie

Valeur validée.

Type renvoyé

int

validate_non_negative

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

Valide une chaîne de nombre entier non négatif.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur est négative.

Renvoie

Valeur validée.

Type renvoyé

int

validate_non_zero

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

Valide une chaîne de nombre entier non nul.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur est égale à zéro.

Renvoie

Valeur validée.

Type renvoyé

int

validate_percentage

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

Valide une chaîne de pourcentage.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur n'est pas un pourcentage.

Renvoie

Valeur validée.

Type renvoyé

int

validate_positive

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

Valide une chaîne de nombre entier positif.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur n'est pas positive.

Renvoie

Valeur validée.

Type renvoyé

int

validate_range

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

Valide une chaîne de plage.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`min_limit`	`int` Limite inférieure.
`max_limit`	`int` Limite supérieure.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur est hors plage.

Renvoie

Valeur validée.

Type renvoyé

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)

Valide une chaîne de gravité.

Paramètres
`param_name`	`str` Nom du paramètre.
`severity`	`str` Valeur de gravité à valider.
`min_limit`	`int` Limite inférieure.
`max_limit`	`int` Limite supérieure.
`possible_values`	`list` Liste des valeurs possibles.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur n'est pas valide.

Renvoie

Valeur validée.

Type renvoyé

int

validate_upper_limit

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

Valide une chaîne de limite supérieure.

Paramètres
`param_name`	`str` Nom du paramètre.
`value`	`str` Valeur à valider.
`limit`	`int` Limite supérieure.
`default_value`	`any` Valeur par défaut à renvoyer en cas d'erreur de validation.
`print_value`	`bool` Définissez si la valeur du paramètre doit être imprimée dans le message.
`print_error`	`bool` Définissez si l'erreur d'exception doit être imprimée dans le message.

Génère

ParameterValidationError : lorsque la valeur dépasse la limite.

Renvoie

Valeur validée.

Type renvoyé

int

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.