Modulo Utils

TIPCommon.utils.camel_to_snake_case

TIPCommon.utils.camel_to_snake_case(string)

Converte una stringa in notazione camel case in snake case.

Parametri
string str

La stringa da convertire.

Restituisce

La stringa convertita.

Tipo restituito

str

TIPCommon.utils.cast_keys_to_int

TIPCommon.utils.cast_keys_to_int(data)

Esegue il cast delle chiavi di un dizionario in numeri interi.

Parametri
data dict

I dati le cui chiavi vengono convertite in numeri interi.

Restituisce

Un nuovo dizionario con le chiavi come numeri interi.

Tipo restituito

dict

TIPCommon.utils.clean_result

TIPCommon.utils.clean_result(value)

Rimuove gli spazi non necessari prima o dopo il valore.

Parametri
value str

Il valore da cui rimuovere gli spazi.

Restituisce

Una versione semplice del valore originale.

Tipo restituito

str

TIPCommon.utils.create_and_write_to_tempfile

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

Crea un file temporaneo e vi scrive i contenuti.

Parametri

Parametri
content str | bytes

I contenuti da scrivere nel file temporaneo.

Restituisce

Il percorso del file temporaneo creato.

Tipo restituito

Path

TIPCommon.utils.get_entity_original_identifier

TIPCommon.utils.get_entity_original_identifier(entity)

Una funzione helper per ottenere l'identificatore originale dell'entità.

Parametri
entity Entity

L'entità da cui la funzione recupera l'identificatore originale.

Restituisce

L'identificatore originale.

Tipo restituito

str

TIPCommon.utils.get_function_arg_names

TIPCommon.utils.get_function_arg_names(func)

Recupera tutti i nomi degli argomenti di una funzione specifica.

Parametri
func La funzione o il metodo da analizzare.

Restituisce

Tutte le chiavi degli argomenti definite nella funzione specificata.

Tipo restituito

list

TIPCommon.utils.get_unique_items_by_difference

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

Restituisce gli elementi della differenza tra due iterabili (item_pool - items_to_remove).

Parametri
item_pool iterable

Il pool di elementi da cui filtrare.
items_to_remove iterable

Gli elementi da rimuovere, se presenti.

Restituisce

Un elenco contenente elementi unici di item_pool che non facevano parte di items_to_remove.

Tipo restituito

list

TIPCommon.utils.is_empty_string_or_none

TIPCommon.utils.is_empty_string_or_none(data)

Controlla se i dati sono una stringa vuota o None.

Parametri
data str

I dati da controllare.

Restituisce

True se i dati forniti sono None o se contengono solo una stringa vuota "".

Tipo restituito

bool

TIPCommon.utils.is_first_run

TIPCommon.utils.is_first_run(sys_argv)

Restituisce un valore booleano che indica se l'azione viene eseguita in modo asincrono.

Parametri

Parametri
sys_argv Gli argomenti della riga di comando del modulo sys.argv.

Restituisce

True se l'azione viene eseguita in modo asincrono e False in tutti gli altri casi.

TIPCommon.utils.is_overflowed

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

Verifica se è stato eseguito l'overflow.

Parametri
siemplify obj

Un'istanza della classe SiemplifyConnectorExecution dell'SDK.

alert_info AlertInfo

Informazioni sull'avviso.
is_test_run bool

Il parametro indica se l'esecuzione corrente è un'esecuzione di test o meno.

Restituisce

True se l'avviso è in overflow e False in tutti gli altri casi.

TIPCommon.utils.is_python_37

TIPCommon.utils.is_python_37()

Verifica che la versione di Python del sistema sia 3.7 o successiva.

Restituisce

True se la versione attuale di Python è almeno la 3.7, altrimenti False.

Tipo restituito

bool

TIPCommon.utils.is_test_run

TIPCommon.utils.is_test_run(sys_argv)

Restituisce un valore booleano che indica lo stato di esecuzione del connettore.

Parametri
sys_argv _type_

Gli argomenti della riga di comando.

Restituisce

True se l'esecuzione corrente è un'esecuzione di test, altrimenti False.

Tipo restituito

bool

TIPCommon.utils.is_valid_email

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

Controlla se un valore fornito è un indirizzo email valido.

Parametri

Parametri
email_addr str

L'indirizzo email da controllare.

Restituisce

Restituisce True se l'email è valida; altrimenti, False.

Tipo restituito

bool

TIPCommon.utils.none_to_default_value

TIPCommon.utils.none_to_default_value(value_to_check, value_to_return_if_none)

Controlla se il valore attuale è None.

Se il valore è None, la funzione lo sostituisce con un altro valore. Se il valore non è None, la funzione restituisce il valore originale.

Parametri
value_to_check dict/list/str

Il valore da controllare.
value_to_return_if_none dict/list/str

Il valore da restituire se value_to_check è None.

Restituisce

Se viene fornito qualcosa, viene restituito il valore originale di value_to_check.

Se non viene fornito nulla, viene restituito value_to_return_if_none.

Tipo restituito

dict/list/str

TIPCommon.utils.platform_supports_1p_api

TIPCommon.utils.platform_supports_1p_api()→ bool

Controlla se la piattaforma è 1P o meno.

Parametri

Parametri

Restituisce

Restituisce True se la piattaforma è 1P; altrimenti, False.

Tipo restituito

bool

TIPCommon.utils.platform_supports_db

TIPCommon.utils.platform_supports_db(siemplify)

Controlla se la piattaforma supporta l'utilizzo del database.

Parametri
siemplify object

L'oggetto SDK Siemplify.

Restituisce

True se l'oggetto Siemplify SDK ha uno dei seguenti attributi:

  • set_connector_context_property
  • set_job_context_property

In caso contrario, viene restituito False.

TIPCommon.utils.safe_cast_bool_value_from_str

TIPCommon.utils.safe_cast_bool_value_from_str(default_value)

Controlla se un valore predefinito è una stringa contenente un valore booleano.

Se il valore predefinito è una stringa contenente un valore booleano, la funzione converte la stringa in booleano. In caso contrario, la funzione restituisce il valore.

Parametri
default_value Il valore predefinito da restituire se il casting non va a buon fine.

Restituisce

Il valore convertito o il valore predefinito.

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

Controlla se un valore predefinito è una stringa contenente il valore intero.

Se il valore predefinito è una stringa contenente un valore intero, la funzione converte la stringa in booleano. In caso contrario, la funzione restituisce il valore.

Parametri
default_value Il valore predefinito da restituire se il casting non va a buon fine.

Restituisce

Il valore convertito o il valore predefinito.

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