Módulo Utils

TIPCommon.utils.camel_to_snake_case

TIPCommon.utils.camel_to_snake_case(string)

Convierte una cadena de camel case a snake case.

Parámetros
string str

Es la cadena que se convertirá.

Devoluciones

Es la cadena convertida.

Tipo de datos que se muestra

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

Son los datos cuyas claves se convierten en números enteros.

Devoluciones

Es un nuevo diccionario con sus claves como números enteros.

Tipo de datos que se muestra

dict

TIPCommon.utils.clean_result

TIPCommon.utils.clean_result(value)

Quita los espacios innecesarios antes o después del valor.

Parámetros
value str

Valor del que se quitarán los espacios.

Devoluciones

Es una versión sin formato del valor original.

Tipo de datos que se muestra

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

Es el contenido que se escribirá en el archivo temporal.

Devoluciones

Ruta de acceso al archivo temporal creado.

Tipo de datos que se muestra

Path

TIPCommon.utils.get_entity_original_identifier

TIPCommon.utils.get_entity_original_identifier(entity)

Es una función auxiliar para obtener el identificador original de la entidad.

Parámetros
entity Entity

Es la entidad de la que la función obtiene el identificador original.

Devoluciones

Es el identificador original.

Tipo de datos que se muestra

str

TIPCommon.utils.get_function_arg_names

TIPCommon.utils.get_function_arg_names(func)

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

Parámetros
func Es la función o el método que se analizará.

Devoluciones

Son todas las claves de argumentos definidas en la función determinada.

Tipo de datos que se muestra

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 diferencia de conjunto de dos iterables (item_pool - items_to_remove).

Parámetros
item_pool iterable

Es el grupo de elementos desde el que se filtrará.
items_to_remove iterable

Son los elementos que se deben quitar, si hay alguno.

Devoluciones

Es una lista que contiene elementos únicos de item_pool que no formaban parte de items_to_remove.

Tipo de datos que se muestra

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

Son los datos que se deben verificar.

Devoluciones

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

Tipo de datos que se muestra

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 Son los argumentos de la línea de comandos del módulo sys.argv.

Devoluciones

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

TIPCommon.utils.is_overflowed

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

Verifica si se desbordó.

Parámetros
siemplify obj

Instancia de la clase SiemplifyConnectorExecution del SDK.

alert_info AlertInfo

Es la información de la alerta.
is_test_run bool

El parámetro indica si la ejecución actual es una ejecución de 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()

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

Devoluciones

True si la versión actual de Python es al menos 3.7; de lo contrario, False.

Tipo de datos que se muestra

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_

Son los argumentos de la línea de comandos.

Devoluciones

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

Tipo de datos que se muestra

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 electrónico válida.

Parámetros

Parámetros
email_addr str

Es la dirección de correo electrónico que se debe verificar.

Devoluciones

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

Tipo de datos que se muestra

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 reemplaza por otro valor. Si el valor no es None, la función devuelve el valor original.

Parámetros
value_to_check dict/list/str

Es el valor que se verificará.
value_to_return_if_none dict/list/str

Es el 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 datos que se muestra

dict/list/str

TIPCommon.utils.platform_supports_1p_api

TIPCommon.utils.platform_supports_1p_api()→ bool

Comprueba si la plataforma es de 1P o no.

Parámetros

Parámetros

Devoluciones

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

Tipo de datos que se muestra

bool

TIPCommon.utils.platform_supports_db

TIPCommon.utils.platform_supports_db(siemplify)

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

Parámetros
siemplify object

Es el objeto del 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 booleano. De lo contrario, la función devuelve el valor.

Parámetros
default_value Es el valor predeterminado que se devuelve si falla la conversión.

Devoluciones

Es 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 booleana. De lo contrario, la función devuelve el valor.

Parámetros
default_value Es el valor predeterminado que se devuelve si falla la conversión.

Devoluciones

Es el valor convertido o el valor predeterminado.

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.