Módulo Utils
TIPCommon.utils.camel_to_snake_case
TIPCommon.utils.camel_to_snake_case(string)
Converte uma string em letras concatenadas para snake case.
Parâmetros | |
---|---|
string |
str A string a ser convertida. |
Retorna
A string convertida.
Tipo de retorno
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. |
Retorna
Um novo dicionário com as chaves como números inteiros.
Tipo de retorno
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 de onde os espaços serão removidos. |
Retorna
Uma versão simples do valor original.
Tipo de retorno
str
TIPCommon.utils.create_and_write_to_tempfile
TIPCommon.utils.create_and_write_to_tempfile(content: str | bytes)→ Path
Cria um arquivo temporário e grava conteúdo nele.
Parâmetros
Parâmetros | |
---|---|
content |
str | bytes O conteúdo a ser gravado no arquivo temporário. |
Retorna
O caminho para o arquivo temporário criado.
Tipo de retorno
Path
TIPCommon.utils.get_entity_original_identifier
TIPCommon.utils.get_entity_original_identifier(entity)
Uma função auxiliar para receber o identificador original da entidade.
Parâmetros | |
---|---|
entity |
Entity
A entidade de que a função recebe o identificador original. |
Retorna
O identificador original.
Tipo de retorno
str
TIPCommon.utils.get_function_arg_names
TIPCommon.utils.get_function_arg_names(func)
Recupera todos os nomes de argumentos de uma função específica.
Parâmetros | |
---|---|
func |
A função ou o método a ser analisado. |
Retorna
Todas as chaves de argumento definidas na função especificada.
Tipo de retorno
list
TIPCommon.utils.get_unique_items_by_difference
TIPCommon.utils.get_unique_items_by_difference(item_pool: Iterable,
items_to_remove: Iterable) → list
Recebe 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 ser filtrado. |
items_to_remove |
iterable
Os itens que devem ser removidos, se houver. |
Retorna
Uma lista que contém itens exclusivos de item_pool
que não faziam parte de items_to_remove
.
Tipo de retorno
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 serem verificados. |
Retorna
True
se os dados fornecidos forem None
ou se contiverem apenas uma string vazia ""
.
Tipo de retorno
bool
TIPCommon.utils.is_first_run
TIPCommon.utils.is_first_run(sys_argv)
Retorna um valor booleano que indica se a ação está sendo executada de forma assíncrona.
Parâmetros
Parâmetros | |
---|---|
sys_argv |
Os argumentos da linha de comando do módulo sys.argv . |
Retorna
True
se a ação estiver sendo 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 estouro.
Parâmetros | |
---|---|
siemplify |
obj
Uma instância da classe |
alert_info |
AlertInfo Informações do alerta. |
is_test_run |
bool
O parâmetro indica se a execução atual é um teste ou não. |
Retorna
True
se o alerta estiver em estouro 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 é 3.7 ou mais recente.
Retorna
True
se a versão atual do Python for 3.7 ou mais recente. Caso contrário, False
.
Tipo de retorno
bool
TIPCommon.utils.is_test_run
TIPCommon.utils.is_test_run(sys_argv)
Retorna um valor booleano que indica o estado de execução do conector.
Parâmetros | |
---|---|
sys_argv |
_type_ Os argumentos de linha de comando. |
Retorna
True
se a execução atual for um teste. Caso contrário, False
.
Tipo de retorno
bool
TIPCommon.utils.is_valid_email
TIPCommon.utils.is_valid_email(email_addr: str)→ bool
Verifica se um valor fornecido é um endereço de e-mail válido.
Parâmetros
Parâmetros | |
---|---|
email_addr |
str O endereço de e-mail a ser verificado. |
Retorna
Retorna True
se o e-mail for válido. Caso contrário, retorna False
.
Tipo de retorno
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 o substituirá por outro valor. Se o valor não for None
, a função vai retornar o valor original.
Parâmetros | |
---|---|
value_to_check |
dict/list/str O valor a ser verificado. |
value_to_return_if_none |
dict/list/str
O valor a ser retornado se |
Retorna
Se algo for fornecido, o valor original de value_to_check
será retornado.
Se nada for fornecido, o value_to_return_if_none
será retornado.
Tipo de retorno
dict/list/str
TIPCommon.utils.platform_supports_1p_api
TIPCommon.utils.platform_supports_1p_api()→ bool
Verifica se a plataforma é própria ou não.
Parâmetros
Parâmetros |
---|
Retorna
Retorna True
se a plataforma for 1P. Caso contrário, retorna False
.
Tipo de retorno
bool
TIPCommon.utils.platform_supports_db
TIPCommon.utils.platform_supports_db(siemplify)
Verifica se a plataforma é compatível com o uso do banco de dados.
Parâmetros | |
---|---|
siemplify |
object O objeto do SDK do Siemplify. |
Retorna
True
se o objeto do SDK do Siemplify tiver algum dos seguintes atributos:
set_connector_context_property
set_job_context_property
Caso contrário, False
será retornado.
TIPCommon.utils.safe_cast_bool_value_from_str
TIPCommon.utils.safe_cast_bool_value_from_str(default_value)
Verifica se um valor padrão é uma string que contém um valor booleano.
Se o valor padrão for uma string que contém um valor booleano, a função converterá a string em booleano. Caso contrário, a função retorna o valor.
Parâmetros | |
---|---|
default_value |
O valor padrão a ser retornado se a transmissão falhar. |
Retorna
O valor convertido ou o valor padrão.
TIPCommon.utils.safe_cast_int_value_from_str
TIPCommon.utils.safe_cast_int_value_from_str(default_value)
Verifica se um valor padrão é uma string que contém o valor inteiro.
Se o valor padrão for uma string que contém um valor inteiro, a função converterá a string em booleano. Caso contrário, a função retorna o valor.
Parâmetros | |
---|---|
default_value |
O valor padrão a ser retornado se a transmissão falhar. |
Retorna
O valor convertido ou o valor padrão.
Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.