Módulo de transformação

TIPCommon.transformation.add_prefix_to_dict

TIPCommon.transformation.add_prefix_to_dict(given_dict: dict, prefix: str) → dict

Adiciona um prefixo às chaves de um determinado dicionário.

Parâmetros

Parâmetros
given_dict	dict O dicionário em que o prefixo será adicionado.
prefix	str O prefixo aplicado às chaves do dicionário.

Retorna

O dicionário com o prefixo adicionado às chaves.

Tipo de retorno

dict

TIPCommon.transformation.add_prefix_to_dict_keys

TIPCommon.transformation.add_prefix_to_dict_keys(target_dict: dict, prefix: str) → dict

Adiciona um prefixo às chaves de um determinado dicionário.

Parâmetros

Parâmetros
target_dict	dict O dicionário em que o prefixo será adicionado.
prefix	str O prefixo aplicado às chaves do dicionário.

Retorna

O dicionário com o prefixo adicionado às chaves.

Tipo de retorno

dict

TIPCommon.transformation.adjust_to_csv

TIPCommon.transformation.adjust_to_csv(value)

Ajusta um valor para que ele possa ser incluído em um CSV.

Parâmetros
value	Any O valor a ser ajustado.

Retorna

O valor ajustado.

Tipo de retorno

str

TIPCommon.transformation.construct_csv

TIPCommon.transformation.construct_csv(list_of_dicts)

Cria um CSV com base em uma lista de dicionários.

Parâmetros
list_of_dicts	list[dict] A lista de dicionários a serem adicionados ao CSV.

Retorna

A lista formatada em CSV.

Tipo de retorno

list[str]

TIPCommon.transformation.convert_comma_separated_to_list

TIPCommon.transformation.convert_comma_separated_to_list(comma_separated, delimiter=',')

Converte uma string separada por vírgulas em uma lista de valores.

Parâmetros
delimiter	O delimitador para analisar a string. O padrão é ','.
comma_separated	str A string separada por vírgulas a ser convertida.

Retorna

A lista de valores.

Tipo de retorno

list

TIPCommon.transformation.convert_dict_to_json_result_dict

TIPCommon.transformation.convert_dict_to_json_result_dict(json_result, title_key='Entity', results_key='EntityResult')

Converte o resultado JSON key, value na lista de objetos de resultado JSON e organiza o objeto de resultado JSON da entidade em um formato definido.

Confira abaixo um exemplo de como um dict é transformado no resultado JSON:

{k1: v1, k2:v2, ...} =>
[
   {
       title_key: k1,
       result_key: v1
   },
   {
       title_key: k2,
       result_key: v1
   }
   ...
]

Parâmetros
json_result	dict[str, Any] | str O resultado JSON key, value.
title_key	str A chave em que o nome de cada chave vai estar.
result_key	str A chave em que o nome de cada valor vai estar.

Exemplos

O exemplo padrão para o formato JSON do resultado da entidade em que title_key='Entity', results_key='EntityResult' é o seguinte:

[
   {
       'Entity': 'key1 in json_result',
       'EntityResult: {
           json_result['key1']
       }
   },
   {
       'Entity': 'key2 in json_result',
       'EntityResult: {
           json_result['key2']
       }
   }
]

Retorna

(list[dict[str, Any]]) Uma lista de objetos de resultado JSON de entidade

Gera

• InternalJSONDecoderError – se json_result for uma string e não puder ser analisada como um dicionário usando json.loads().
• ValueError: se o json_result não for um dict. A verificação é feita depois de carregar o json_result de uma string, se necessário.

TIPCommon.transformation.convert_list_to_comma_string

TIPCommon.transformation.convert_list_to_comma_string(values_list, delimiter=',')

Converte uma lista de valores em uma string separada por vírgulas.

Parâmetros
delimiter	O delimitador a ser usado na string. O padrão é ','.
values_list	list A lista de valores a serem convertidos.

Retorna

A string separada por vírgulas.

Tipo de retorno

str

TIPCommon.transformation.dict_to_flat

TIPCommon.transformation.dict_to_flat(target_dict)

Recebe um dicionário aninhado e o retorna como um dicionário simples.

Parâmetros
target_dict	dict O dicionário a ser condensado.

Retorna

O dicionário nivelado.

Tipo de retorno

dict

TIPCommon.transformation.flat_dict_to_csv

TIPCommon.transformation.flat_dict_to_csv(flat_dict, property_header='Property', value_header='Value')

Converte um dicionário simples em uma lista de strings no formato CSV.

Os argumentos property_header e value_header são usados para personalizar o cabeçalho CSV.

Parâmetros
flat_dict	dict O dicionário a ser convertido para o formato CSV.
property_header	str O cabeçalho da coluna de propriedade. O padrão é Propriedade.
value_header	str O cabeçalho da coluna de valor. O padrão é Valor.

Retorna

A lista de strings no formato CSV.

Tipo de retorno

list

TIPCommon.transformation.get_unicode

TIPCommon.transformation.get_unicode(value)

Recebe o Unicode de um valor.

Parâmetros
value	Any O valor a ser convertido em Unicode.

Retorna

A representação Unicode do valor.

Tipo de retorno

unicode (unicode)

TIPCommon.transformation.removeprefix

TIPCommon.transformation.removeprefix(string: str, prefix: str) → str

Implementação própria para str.removeprefix() que existe no Python 3.9 e em versões mais recentes.

Se a string começar com a string de prefixo, o método vai retornar string[len(prefix):]. Caso contrário, retorna uma cópia da string original.

Parâmetros
string	str A string de que o prefixo será removido.
prefix	str O prefixo a ser removido da string.

Retorna

A string resultante.

TIPCommon.transformation.removesuffix

TIPCommon.transformation.removesuffix(string: str, suffix: str) → str

Implementação própria para str.removesuffix() que existe no Python 3.9 e em versões mais recentes.

Se a string terminar com a string de sufixo, o método vai retornar string[:-len(prefix)]. Caso contrário, retorna uma cópia da string original.

Parâmetros
string	str A string de que o sufixo será removido.
suffix	str O sufixo a ser removido da string.

Retorna

A string resultante.

TIPCommon.transformation.rename_dict_key

TIPCommon.transformation.rename_dict_key(a_dict: dict, current_key: Hashable,new_key: Hashable) → None

Renomeia uma chave em um dicionário.

Parâmetros
a_dict	dict O dicionário para renomear uma chave.
current_key	Hashable A chave em a_dict a ser renomeada.
new_key	Hashable A chave renomeada.

TIPCommon.transformation.string_to_multi_value

TIPCommon.transformation.string_to_multi_value(string_value, delimiter=',', only_unique=False)

Converte uma string que contém uma lista de valores separados por vírgulas em uma lista de valores.

Parâmetros
string_value	str A string a ser convertida.
delimiter	Opcional str O delimitador para dividir a string. O padrão é ','.
only_unique	Opcional bool Se definido como True, o parâmetro inclui apenas valores únicos na lista retornada. O padrão é False.

Retorna

A lista de valores.

Tipo de retorno

list

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