Module Utils

TIPCommon.utils.camel_to_snake_case

TIPCommon.utils.camel_to_snake_case(string)

Convertit une chaîne camel case en snake case.

Paramètres
string str

Chaîne à convertir.

Renvoie

Chaîne convertie.

Type renvoyé

str

TIPCommon.utils.cast_keys_to_int

TIPCommon.utils.cast_keys_to_int(data)

Convertit les clés d'un dictionnaire en entiers.

Paramètres
data dict

Données dont les clés sont converties en entiers.

Renvoie

Un nouveau dict avec ses clés sous forme d'entiers.

Type renvoyé

dict

TIPCommon.utils.clean_result

TIPCommon.utils.clean_result(value)

Supprime les espaces inutiles avant ou après la valeur.

Paramètres
value str

Valeur dont les espaces doivent être supprimés.

Renvoie

Version brute de la valeur d'origine.

Type renvoyé

str

TIPCommon.utils.create_and_write_to_tempfile

TIPCommon.utils.create_and_write_to_tempfile(content: str | bytes)→ Path

Crée un fichier temporaire et y écrit du contenu.

Paramètres

Paramètres
content str | bytes

Contenu à écrire dans le fichier temporaire.

Renvoie

Chemin d'accès au fichier temporaire créé.

Type renvoyé

Path

TIPCommon.utils.get_entity_original_identifier

TIPCommon.utils.get_entity_original_identifier(entity)

Fonction d'assistance permettant d'obtenir l'identifiant d'origine de l'entité.

Paramètres
entity Entity

Entité à partir de laquelle la fonction obtient l'identifiant d'origine.

Renvoie

Identifiant d'origine.

Type renvoyé

str

TIPCommon.utils.get_function_arg_names

TIPCommon.utils.get_function_arg_names(func)

Récupère tous les noms d'arguments d'une fonction spécifique.

Paramètres
func Fonction ou méthode à analyser.

Renvoie

Toutes les clés d'arguments définies dans la fonction donnée.

Type renvoyé

list

TIPCommon.utils.get_unique_items_by_difference

TIPCommon.utils.get_unique_items_by_difference(item_pool: Iterable, items_to_remove: Iterable) → list

Obtient les éléments de la différence d'ensemble à partir de deux itérables (item_pool - items_to_remove).

Paramètres
item_pool iterable

Pool d'éléments à partir duquel filtrer.
items_to_remove iterable

Éléments à supprimer, le cas échéant.

Renvoie

Liste contenant des éléments uniques de item_pool qui ne faisaient pas partie de items_to_remove.

Type renvoyé

list

TIPCommon.utils.is_empty_string_or_none

TIPCommon.utils.is_empty_string_or_none(data)

Vérifie si les données sont une chaîne vide ou None.

Paramètres
data str

Données à vérifier.

Renvoie

True si les données fournies sont None ou si elles ne contiennent qu'une chaîne vide "".

Type renvoyé

bool

TIPCommon.utils.is_first_run

TIPCommon.utils.is_first_run(sys_argv)

Renvoie une valeur booléenne indiquant si l'action est exécutée de manière asynchrone.

Paramètres

Paramètres
sys_argv Arguments de ligne de commande du module sys.argv.

Renvoie

True si l'action est exécutée de manière asynchrone et False dans tous les autres cas.

TIPCommon.utils.is_overflowed

TIPCommon.utils.is_overflowed(siemplify, alert_info, is_test_run)

Vérifie si le contenu a été tronqué.

Paramètres
siemplify obj

Instance de la classe SiemplifyConnectorExecution du SDK.

alert_info AlertInfo

Informations sur l'alerte.
is_test_run bool

Le paramètre indique si l'exécution actuelle est une exécution test ou non.

Renvoie

True si l'alerte est en dépassement de capacité et False dans tous les autres cas.

TIPCommon.utils.is_python_37

TIPCommon.utils.is_python_37()

Vérifie si la version Python du système est la version 3.7 ou ultérieure.

Renvoie

True si la version actuelle de Python est au moins la version 3.7, sinon False.

Type renvoyé

bool

TIPCommon.utils.is_test_run

TIPCommon.utils.is_test_run(sys_argv)

Renvoie une valeur booléenne indiquant l'état d'exécution du connecteur.

Paramètres
sys_argv _type_

Arguments de ligne de commande.

Renvoie

True si l'exécution actuelle est un test, sinon False.

Type renvoyé

bool

TIPCommon.utils.is_valid_email

TIPCommon.utils.is_valid_email(email_addr: str)→ bool

Vérifie si une valeur fournie est une adresse e-mail valide.

Paramètres

Paramètres
email_addr str

Adresse e-mail à vérifier.

Renvoie

Renvoie True si l'adresse e-mail est valide, ou False dans le cas contraire.

Type renvoyé

bool

TIPCommon.utils.none_to_default_value

TIPCommon.utils.none_to_default_value(value_to_check, value_to_return_if_none)

Vérifie si la valeur actuelle est None.

Si la valeur est None, la fonction la remplace par une autre valeur. Si la valeur n'est pas None, la fonction renvoie la valeur d'origine.

Paramètres
value_to_check dict/list/str

Valeur à vérifier.
value_to_return_if_none dict/list/str

Valeur à renvoyer si value_to_check est None.

Renvoie

Si une valeur est fournie, la valeur d'origine de value_to_check est renvoyée.

Si rien n'est fourni, value_to_return_if_none est renvoyé.

Type renvoyé

dict/list/str

TIPCommon.utils.platform_supports_1p_api

TIPCommon.utils.platform_supports_1p_api()→ bool

Vérifie si la plate-forme est 1P ou non.

Paramètres

Paramètres

Renvoie

Renvoie True si la plate-forme est 1P, ou False dans le cas contraire.

Type renvoyé

bool

TIPCommon.utils.platform_supports_db

TIPCommon.utils.platform_supports_db(siemplify)

Vérifie si la plate-forme est compatible avec l'utilisation de la base de données.

Paramètres
siemplify object

Objet SDK Siemplify.

Renvoie

True si l'objet SDK Siemplify possède l'un des attributs suivants :

  • set_connector_context_property
  • set_job_context_property

Sinon, False est renvoyé.

TIPCommon.utils.safe_cast_bool_value_from_str

TIPCommon.utils.safe_cast_bool_value_from_str(default_value)

Vérifie si une valeur par défaut est une chaîne contenant une valeur booléenne.

Si la valeur par défaut est une chaîne contenant une valeur booléenne, la fonction convertit la chaîne en valeur booléenne. Sinon, elle renvoie la valeur.

Paramètres
default_value Valeur par défaut à renvoyer si le casting échoue.

Renvoie

Valeur castée ou valeur par défaut.

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

Vérifie si une valeur par défaut est une chaîne contenant la valeur entière.

Si la valeur par défaut est une chaîne contenant une valeur entière, la fonction convertit la chaîne en valeur booléenne. Sinon, elle renvoie la valeur.

Paramètres
default_value Valeur par défaut à renvoyer si le casting échoue.

Renvoie

Valeur castée ou valeur par défaut.

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