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 ao qual adicionar o prefixo.
prefix	str O prefixo aplicado às chaves do dicionário.

Devoluções

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

Tipo devolvido

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 ao qual adicionar o prefixo.
prefix	str O prefixo aplicado às chaves do dicionário.

Devoluções

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

Tipo devolvido

dict

TIPCommon.transformation.adjust_to_csv

TIPCommon.transformation.adjust_to_csv(value)

Ajusta um valor para ser adequado para inclusão num CSV.

Parâmetros
value	Any O valor a ajustar.

Devoluções

O valor ajustado.

Tipo devolvido

str

TIPCommon.transformation.construct_csv

TIPCommon.transformation.construct_csv(list_of_dicts)

Constrói um CSV a partir de uma lista de dicionários.

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

Devoluções

A lista formatada em CSV.

Tipo devolvido

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 numa lista de valores.

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

Devoluções

A lista de valores.

Tipo devolvido

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 num formato definido.

O exemplo de como um dict se transforma no resultado JSON é o seguinte:

{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 key, value resultado JSON.
title_key	str A chave sob a qual o nome de cada chave vai estar.
result_key	str A chave sob a qual o nome de cada valor vai estar.

Exemplos

O exemplo predefinido para o formato JSON do resultado da entidade onde 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']
       }
   }
]

Devoluções

(list[dict[str, Any]]) Uma lista de objetos JSON de resultados de entidades

Aumenta

• InternalJSONDecoderError – se json_result for uma string e não for possível analisá-la quanto ao dicionário através de json.loads().
• ValueError – se o json_result não for um dict (a verificação é feita depois de o carregar a partir 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 numa string separada por vírgulas.

Parâmetros
delimiter	O delimitador a usar na string. A predefinição é ','.
values_list	list A lista de valores a converter.

Devoluções

A string separada por vírgulas.

Tipo devolvido

str

TIPCommon.transformation.dict_to_flat

TIPCommon.transformation.dict_to_flat(target_dict)

Recebe um dicionário aninhado e devolve-o como um dicionário simples.

Parâmetros
target_dict	dict O dicionário a unir.

Devoluções

O dicionário reduzido.

Tipo devolvido

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 numa lista de strings no formato CSV.

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

Parâmetros
flat_dict	dict O dicionário a converter para o formato CSV.
property_header	str O cabeçalho da coluna de propriedade. A predefinição é Property.
value_header	str O cabeçalho da coluna de valor. O valor predefinido é Value.

Devoluções

A lista de strings no formato CSV.

Tipo devolvido

list

TIPCommon.transformation.get_unicode

TIPCommon.transformation.get_unicode(value)

Obtém o valor Unicode de um valor.

Parâmetros
value	Any O valor a converter em Unicode.

Devoluções

A representação Unicode do valor.

Tipo devolvido

unicode (unicode)

TIPCommon.transformation.removeprefix

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

Implementação autónoma para o str.removeprefix() que existe no Python 3.9 e posterior.

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

Parâmetros
string	str A string da qual remover o prefixo.
prefix	str O prefixo a remover da string.

Devoluções

A string resultante.

TIPCommon.transformation.removesuffix

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

Implementação autónoma para o str.removesuffix() que existe no Python 3.9 e posterior.

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

Parâmetros
string	str A string da qual remover o sufixo.
suffix	str O sufixo a remover da string.

Devoluções

A string resultante.

TIPCommon.transformation.rename_dict_key

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

Altera o nome de uma chave num dicionário.

Parâmetros
a_dict	dict O dicionário no qual quer mudar o nome de uma chave.
current_key	Hashable A chave em a_dict à qual quer mudar o nome.
new_key	Hashable A chave com o novo nome.

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 numa lista de valores.

Parâmetros
string_value	str A string a converter.
delimiter	Opcional str O delimitador no qual dividir a string. A predefinição é ','.
only_unique	Opcional bool Se estiver definido como True, o parâmetro inclui apenas valores únicos na lista devolvida. A predefinição é False.

Devoluções

A lista de valores.

Tipo devolvido

list

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