Módulo Utils

TIPCommon.utils.camel_to_snake_case

TIPCommon.utils.camel_to_snake_case(string)

Converte uma string em formato camel case para snake case.

Parâmetros
string	str A string a converter.

Devoluções

A string convertida.

Tipo devolvido

str

TIPCommon.utils.cast_keys_to_int

TIPCommon.utils.cast_keys_to_int(data)

Converte as chaves de um dicionário em números inteiros.

Parâmetros
data	dict Os dados cujas chaves são convertidas em números inteiros.

Devoluções

Um novo dicionário com as respetivas chaves como números inteiros.

Tipo devolvido

dict

TIPCommon.utils.clean_result

TIPCommon.utils.clean_result(value)

Remove espaços desnecessários antes ou depois do valor.

Parâmetros
value	str O valor do qual remover os espaços.

Devoluções

Uma versão simples do valor original.

Tipo devolvido

str

TIPCommon.utils.create_and_write_to_tempfile

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

Cria um ficheiro temporário e escreve conteúdo no mesmo.

Parâmetros

Parâmetros
content	str | bytes O conteúdo a escrever no ficheiro temporário.

Devoluções

O caminho para o ficheiro temporário criado.

Tipo devolvido

Path

TIPCommon.utils.get_entity_original_identifier

TIPCommon.utils.get_entity_original_identifier(entity)

Uma função auxiliar para obter o identificador original da entidade.

Parâmetros
entity	Entity A entidade a partir da qual a função obtém o identificador original.

Devoluções

O identificador original.

Tipo devolvido

str

TIPCommon.utils.get_function_arg_names

TIPCommon.utils.get_function_arg_names(func)

Obtém todos os nomes de argumentos de uma função específica.

Parâmetros
func	A função ou o método a analisar.

Devoluções

Todas as chaves de argumentos definidas na função especificada.

Tipo devolvido

list

TIPCommon.utils.get_unique_items_by_difference

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

Obtém os itens de diferença de conjunto de dois iteráveis (item_pool - items_to_remove).

Parâmetros
item_pool	iterable O conjunto de itens a partir do qual filtrar.
items_to_remove	iterable Os itens que devem ser removidos, se existirem.

Devoluções

Uma lista que contém itens únicos de item_pool que não faziam parte de items_to_remove.

Tipo devolvido

list

TIPCommon.utils.is_empty_string_or_none

TIPCommon.utils.is_empty_string_or_none(data)

Verifica se os dados são uma string vazia ou None.

Parâmetros
data	str Os dados a verificar.

Devoluções

True se os dados fornecidos forem None ou se contiverem apenas uma string vazia "".

Tipo devolvido

bool

TIPCommon.utils.is_first_run

TIPCommon.utils.is_first_run(sys_argv)

Devolve um valor booleano que indica se a ação está a ser executada de forma assíncrona.

Parâmetros

Parâmetros
sys_argv	Os argumentos da linha de comandos do módulo sys.argv.

Devoluções

True se a ação estiver a ser executada de forma assíncrona e False em qualquer outro caso.

TIPCommon.utils.is_overflowed

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

Verifica se houve overflow.

Parâmetros
siemplify	obj Uma instância da classe SiemplifyConnectorExecution do SDK.
alert_info	AlertInfo Informações de alerta.
is_test_run	bool O parâmetro indica se a execução atual é uma execução de teste ou não.

Devoluções

True se o alerta estiver em overflow e False em qualquer outro caso.

TIPCommon.utils.is_python_37

TIPCommon.utils.is_python_37()

Verifica se a versão do Python do sistema é a 3.7 ou posterior.

Devoluções

True se a versão atual do Python for, pelo menos, 3.7; caso contrário, False.

Tipo devolvido

bool

TIPCommon.utils.is_test_run

TIPCommon.utils.is_test_run(sys_argv)

Devolve um valor booleano que indica o estado de execução do conector.

Parâmetros
sys_argv	_type_ Os argumentos da linha de comandos.

Devoluções

True se a execução atual for uma execução de teste; caso contrário, False.

Tipo devolvido

bool

TIPCommon.utils.is_valid_email

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

Verifica se um valor fornecido é um endereço de email válido.

Parâmetros

Parâmetros
email_addr	str O endereço de email a verificar.

Devoluções

Devolve True se o email for válido; caso contrário, devolve False.

Tipo devolvido

bool

TIPCommon.utils.none_to_default_value

TIPCommon.utils.none_to_default_value(value_to_check, value_to_return_if_none)

Verifica se o valor atual é None.

Se o valor for None, a função substitui-o por outro valor. Se o valor não for None, a função devolve o valor original.

Parâmetros
value_to_check	dict/list/str O valor a verificar.
value_to_return_if_none	dict/list/str O valor a devolver se value_to_check for None.

Devoluções

Se for fornecido algo, é devolvido o valor original de value_to_check.

Se não for fornecido nada, é devolvido o valor value_to_return_if_none.

Tipo devolvido

dict/list/str

TIPCommon.utils.platform_supports_1p_api

TIPCommon.utils.platform_supports_1p_api()→ bool

Verifica se a plataforma é de origem ou não.

Parâmetros

Parâmetros

Devoluções

Devolve True se a plataforma for 1P; caso contrário, False.

Tipo devolvido

bool

TIPCommon.utils.platform_supports_db

TIPCommon.utils.platform_supports_db(siemplify)

Verifica se a plataforma suporta a utilização da base de dados.

Parâmetros
siemplify	object O objeto do SDK Siemplify.

Devoluções

True se o objeto do SDK Siemplify tiver algum dos seguintes atributos:

• set_connector_context_property
• set_job_context_property

Caso contrário, é devolvido False.

TIPCommon.utils.safe_cast_bool_value_from_str

TIPCommon.utils.safe_cast_bool_value_from_str(default_value)

Verifica se um valor predefinido é uma string que contém um valor booleano.

Se o valor predefinido for uma string que contenha um valor booleano, a função converte a string em booleano. Caso contrário, a função devolve o valor.

Parâmetros
default_value	O valor predefinido a devolver se a conversão falhar.

Devoluções

O valor convertido ou o valor predefinido.

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

Verifica se um valor predefinido é uma string que contém o valor inteiro.

Se o valor predefinido for uma string que contenha um valor inteiro, a função converte a string em booleano. Caso contrário, a função devolve o valor.

Parâmetros
default_value	O valor predefinido a devolver se a conversão falhar.

Devoluções

O valor convertido ou o valor predefinido.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.