Resumo do código

Nessa seção iremos abordar as etapas que estão sendo executadas em cada parte do código.

• Importação de bibliotecas

Nesta dica, precisaremos apenas de 3 bibliotecas do python: pandas, requests e datetime.

import pandas as pd # Biblioteca para manipulação de dados

import requests # Biblioteca para requisições web

from datetime import datetime # Biblioteca para manipulação de datas

• Criação da função no python

Via de regra, todo script python dentro do tableau prep precisa de uma função principal, que deve ser passada na configuração da step. Definimos o nome da função como “calcular_valor_dolar” e ela tem um argumento chamado “df”.

def calcular_valor_dolar(df):

    “””

    Essa função recebe uma tabela no Tableau Prep.

    Baseado na coluna data_venda, faz requisições na plataforma do Banco Central e retorna a cotação diária do dólar comercial.

    A saída dessa função é um dataframe

    Args:

    df (dataframe): dataframe do Tableau Prep que contenha uma coluna data_venda, valor_venda e nome_produto

    Returns:

    Dataframe

        Um dataframe que retorna as colunas data_venda, valor_venda, nome_produto, valor_dolar

    “””

• Conversão da coluna de data

A primeira etapa do script envolve a conversão da coluna data_venda. A função “str.replace” é capaz de substituir caracteres específicos por outro. Essa tratativa se faz necessária devido ao padrão de data que a coluna possui. Nesse caso, estamos atribuindo esse ajuste na própria coluna data_venda.

    # Passo 1: Extrai da coluna data_venda o caractere ‘Z’. Essa etapa é importante pois a coluna está formatada no padrão UTC

    df[‘data_venda’] = df[‘data_venda’].str.replace(‘Z’, ”, regex=False)

• Conversão da coluna data_venda para o padrão da API

Como foi possível observar na url de consulta, o padrão de data da API segue o padrão mm-dd-yyyy. Nessa etapa, estamos criando uma nova coluna chamada “data_venda_formatada”

    # Passo 2: Converter a coluna data_venda para o padrão da API – mm-dd-yyyy

    df[‘data_venda_formatada’] = pd.to_datetime(df[‘data_venda’]).dt.strftime(‘%m-%d-%Y’)

• Seleção de todas as datas únicas

Nessa etapa, criamos uma variável que armazena todas as datas únicas da coluna “data_venda_formatada” com a função “unique”.

    # Passo 3 – Listar todas as datas únicas da nova coluna criada

    datas_unicas = df[‘data_venda_formatada’].unique()

• Criação de uma lista que armazena os resultados de consulta à API

a próxima etapa envolve a criação de uma lista vazia que armazena os resultados para cada consulta à API. Ela será incrementada à cada consulta que será realizada.

    # Passo 4 –  Lista para armazenar os resultados

    resultados = []

• Aplicação de um loop para realizar a consulta

a próxima etapa envolve a criação de um evento de repetição que executa uma sequência de atividades. Com base na lista de datas únicas criada na etapa 5, o loop faz a consulta à API, retornando em formato json. Acessando o json gerado, obtém a coluna “cotacaoVenda “ e inclui o registro na lista criada na etapa 6, de forma incremental.

    # Passo 5 – Criar um for loop que faz a requisição na API para cada data da lista ‘datas_unicas’

    for i in datas_unicas:

        # Url Base

        url = f”https://olinda.bcb.gov.br/olinda/servico/PTAX/versao/v1/odata/CotacaoDolarDia(dataCotacao=@dataCotacao)?@dataCotacao='{i}’&$top=1000&$format=json”

        # Obter a resposta do request

        response = requests.get(url)

        # Status da requisição

        response.raise_for_status()

        # A resposta da requisição retorna um Json

        dados = response.json()

        # Acessando o Json para obter a coluna cotacaoVenda

        cotacao_dolar = dados[‘value’][0][‘cotacaoVenda’]       

        # Ao final, a cotação da data é incluída na lista ‘resultados’

        resultados.append([i, cotacao_dolar])

• Criar uma tabela no python com base na lista “resultados”

Nessa etapa, foi criada uma tabela chamada df_cotacoes com base na lista criada na etapa anterior.

    # Passo 6 – Criar um Dataframe Pandas com as colunas data_formatada e cotacao_dolar

    df_cotacoes = pd.DataFrame(resultados, columns=[‘data_formatada’, ‘cotacao_dolar’])

• Mesclar a tabela criada na etapa 8 com a base principal

Utilizando a coluna de data de cada tabela, realizamos a mesclagem dos dados utilizando a função “merge”, utilizando a base principal como base.

    # Passo 7: Realizar o merge da base principal com a base de cotações

    df_final = pd.merge(df, df_cotacoes, left_on=’data_venda_formatada’, right_on=’data_formatada’)

• Criar a nova coluna de valor de venda em dólar

Agora resta atribuir uma nova coluna, chamada “valor_dolar”, que irá receber a multiplicação do valor_venda pelo valor da cotação_dolar do dia respectivo.

    # Passo 8: Criar uma nova coluna com o valor da venda em dólar

    df_final[‘valor_dolar’] = df_final[‘valor_venda’] * df_final[‘cotacao_dolar’]

• Selecionar as colunas que irão compor a tabela final

    # Passo 9: Selecionar apenas as colunas desejadas

    df_final = df_final[[‘data_venda’, ‘valor_venda’, ‘nome_produto’, ‘valor_dolar’]]

• Definição do formato de saída da função

Aqui definimos qual a saída da função “calcular_valor_dolar”. No exemplo abaixo, definimos que a saída é o dataframe “df_final”, que foi atribuído na etapa 11.

    # Passo 10: Realizar a saída da função que calcula o valor em dólar

    return df_final

• Definição do schema (colunas e tipo de dados)

Aqui utilizamos a função get_output_schema, presente na documentação do tableau prep. Essa função é necessária sempre que a tabela final criada no python script for diferente da tabela fornecida na etapa anterior do tableau prep. A documentação pode ser encontrada nesse link: Usar scripts de Python no seu fluxo – Tableau.

Nela, basicamente informamos um dataframe com os nomes das colunas e quais tipos de dados eles serão. Aqui cabe um cuidado para que o formato de saída das colunas do python script seja compatível com o tipo de dado esperado e aceito pelo tableau prep.

# Passo 11: Definir quais colunas irão para o dataframe final

def get_output_schema():

    “””

    A função get_output_schema é essencial se a tabela final tiver colunas diferentes da tabela input do Tableau Prep. É ela que define quais colunas irão aparecer na tabela final.

    Returns:

        Dataframe: O schema desejado para a tabela final que será apresentada no Tableau Prep.

    “””

    return pd.DataFrame({

        ‘data_venda’ : prep_date(),

        ‘valor_venda’ : prep_int(),

        ‘nome_produto’ : prep_string(),

        ‘valor_dolar’ : prep_decimal()

    })