Módulo Utils

TIPCommon.utils.camel_to_snake_case

TIPCommon.utils.camel_to_snake_case(string)

Convierte una cadena con notación camello en una cadena con notación de serpiente.

Parámetros
string	str La cadena que se va a convertir.

Devoluciones

La cadena convertida.

Tipo de devolución

str

TIPCommon.utils.cast_keys_to_int

TIPCommon.utils.cast_keys_to_int(data)

Convierte las claves de un diccionario en números enteros.

Parámetros
data	dict Los datos cuyas claves se convierten en números enteros.

Devoluciones

Un nuevo diccionario con sus claves como números enteros.

Tipo de devolución

dict

TIPCommon.utils.clean_result

TIPCommon.utils.clean_result(value)

Elimina los espacios innecesarios que haya antes o después del valor.

Parámetros
value	str El valor del que se van a quitar los espacios.

Devoluciones

Una versión sin formato del valor original.

Tipo de devolución

str

TIPCommon.utils.create_and_write_to_tempfile

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

Crea un archivo temporal y escribe contenido en él.

Parámetros

Parámetros
content	str | bytes El contenido que se va a escribir en el archivo temporal.

Devoluciones

Ruta al archivo temporal creado.

Tipo de devolución

Path

TIPCommon.utils.get_entity_original_identifier

TIPCommon.utils.get_entity_original_identifier(entity)

Función auxiliar para obtener el identificador original de la entidad.

Parámetros
entity	Entity La entidad de la que la función obtiene el identificador original.

Devoluciones

El identificador original.

Tipo de devolución

str

TIPCommon.utils.get_function_arg_names

TIPCommon.utils.get_function_arg_names(func)

Obtiene todos los nombres de los argumentos de una función específica.

Parámetros
func	La función o el método que se va a analizar.

Devoluciones

Todas las claves de argumentos definidas en la función dada.

Tipo de devolución

list

TIPCommon.utils.get_unique_items_by_difference

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

Obtiene los elementos de la diferencia de conjuntos de dos iterables (item_pool - items_to_remove).

Parámetros
item_pool	iterable El grupo de elementos del que se va a filtrar.
items_to_remove	iterable Los elementos que se deben quitar, si los hay.

Devoluciones

Lista que contiene elementos únicos de item_pool que no formaban parte de items_to_remove.

Tipo de devolución

list

TIPCommon.utils.is_empty_string_or_none

TIPCommon.utils.is_empty_string_or_none(data)

Comprueba si los datos son una cadena vacía o None.

Parámetros
data	str Los datos que se van a comprobar.

Devoluciones

True si los datos proporcionados son None o si solo contienen una cadena vacía "".

Tipo de devolución

bool

TIPCommon.utils.is_first_run

TIPCommon.utils.is_first_run(sys_argv)

Devuelve un valor booleano que indica si la acción se está ejecutando de forma asíncrona.

Parámetros

Parámetros
sys_argv	Los argumentos de línea de comandos del módulo sys.argv.

Devoluciones

True si la acción se está ejecutando de forma asíncrona y False en cualquier otro caso.

TIPCommon.utils.is_overflowed

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

Comprueba si se ha producido un desbordamiento.

Parámetros
siemplify	obj Una instancia de la clase SiemplifyConnectorExecution del SDK.
alert_info	AlertInfo Información de alerta.
is_test_run	bool El parámetro indica si la ejecución actual es una prueba o no.

Devoluciones

True si la alerta se desborda y False en cualquier otro caso.

TIPCommon.utils.is_python_37

TIPCommon.utils.is_python_37()

Comprueba si la versión de Python del sistema es la 3.7 o una posterior.

Devoluciones

True si la versión actual de Python es 3.7 o una posterior; de lo contrario, False.

Tipo de devolución

bool

TIPCommon.utils.is_test_run

TIPCommon.utils.is_test_run(sys_argv)

Devuelve un valor booleano que indica el estado de ejecución del conector.

Parámetros
sys_argv	_type_ Los argumentos de la línea de comandos.

Devoluciones

True si la ejecución actual es una prueba; de lo contrario, False.

Tipo de devolución

bool

TIPCommon.utils.is_valid_email

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

Comprueba si un valor proporcionado es una dirección de correo válida.

Parámetros

Parámetros
email_addr	str La dirección de correo que se va a comprobar.

Devoluciones

Devuelve True si el correo es válido; de lo contrario, devuelve False.

Tipo de devolución

bool

TIPCommon.utils.none_to_default_value

TIPCommon.utils.none_to_default_value(value_to_check, value_to_return_if_none)

Comprueba si el valor actual es None.

Si el valor es None, la función lo sustituye por otro valor. Si el valor no es None, la función devuelve el valor original.

Parámetros
value_to_check	dict/list/str Valor que se va a comprobar.
value_to_return_if_none	dict/list/str Valor que se devuelve si value_to_check es None.

Devoluciones

Si se proporciona algo, se devuelve el valor original de value_to_check.

Si no se proporciona nada, se devuelve value_to_return_if_none.

Tipo de devolución

dict/list/str

TIPCommon.utils.platform_supports_1p_api

TIPCommon.utils.platform_supports_1p_api()→ bool

Comprueba si la plataforma es propia o no.

Parámetros

Parámetros

Devoluciones

Devuelve True si la plataforma es propia; de lo contrario, devuelve False.

Tipo de devolución

bool

TIPCommon.utils.platform_supports_db

TIPCommon.utils.platform_supports_db(siemplify)

Comprueba si la plataforma admite el uso de la base de datos.

Parámetros
siemplify	object El objeto SDK de Siemplify.

Devoluciones

True si el objeto del SDK de Siemplify tiene alguno de los siguientes atributos:

• set_connector_context_property
• set_job_context_property

De lo contrario, se devuelve False.

TIPCommon.utils.safe_cast_bool_value_from_str

TIPCommon.utils.safe_cast_bool_value_from_str(default_value)

Comprueba si un valor predeterminado es una cadena que contiene un valor booleano.

Si el valor predeterminado es una cadena que contiene un valor booleano, la función convierte la cadena en un valor booleano. De lo contrario, la función devuelve el valor.

Parámetros
default_value	Valor predeterminado que se devuelve si la conversión falla.

Devoluciones

El valor convertido o el valor predeterminado.

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

Comprueba si un valor predeterminado es una cadena que contiene el valor entero.

Si el valor predeterminado es una cadena que contiene un valor entero, la función convierte la cadena en un valor booleano. De lo contrario, la función devuelve el valor.

Parámetros
default_value	Valor predeterminado que se devuelve si la conversión falla.

Devoluciones

El valor convertido o el valor predeterminado.

¿Necesitas más ayuda? Recibe respuestas de los miembros de la comunidad y de los profesionales de Google SecOps.