Skip to main content

Python tool Ferramenta Python

Ferramenta Python atualizada

A partir da versão 2026.1 do Designer, o modo interativo não está mais disponível na ferramenta Python.

O desenvolvimento do Python agora é compatível por meio de um modelo de execução que prioriza a produção. Isso significa que você pode editar seus scripts Python diretamente na ferramenta ou em seu ambiente de desenvolvimento integrado (IDE) externo preferido antes de executar seus fluxos de trabalho.

Requisitos da função de usuário

Função de usuário*

Acesso à ferramenta/ao recurso

Usuário completo

✓

Usuário básico

X

*Aplica-se a clientes do Alteryx OneProfessional e Enterprise Edition nas versões 2025.1 e posteriores do Designer.

A ferramenta Python é um editor de código para usuários do Python. Recomenda-se ter proficiência em Python para utilizar essa ferramenta. Depois de importar o pacote Alteryx Python por meio da execução from ayx import Alteryx, consulte as Funções do Python no Alteryx para obter informações sobre funções que você pode usar por meio da ferramenta Python no Designer.

Importante

O Designer aceita um código Python de cliente (customer Python code), mas o Alteryx não é compatível com esse código.

Fluxo de trabalho de exemplo

Esta ferramenta tem um fluxo de trabalho de exemplo. Acesse Exemplos de fluxos de trabalho para saber como acessar esse e muitos outros exemplos diretamente no Designer.

Começar

Use a janela de configuração da ferramenta Python para inserir ou importar seu script Python. Para obter assistência com código, consulte as referências adicionais em Funções do Python no Alteryx.

Instalar os pacotes de data science de que você precisa

A ferramenta Python inclui estes pacotes de ciência de dados:

  • ayx: API do Python no Alteryx que interage com fluxos de trabalho e com o tempo de execução do Designer.

  • ayx_python_sdk: kit de desenvolvimento de software (SDK) para criar e estender ferramentas do Alteryx em Python.

  • numpy: pacote principal para computação numérica e processamento de matrizes em Python.

  • pandas: estruturas de dados para análise de dados, séries temporais e processamento tabular.

  • scipy: biblioteca de computação científica para otimização, estatísticas, processamento de sinais e matemática avançada.

  • scikit-learn: biblioteca de machine learning para classificação, regressão, clustering e avaliação de modelo.

  • statsmodels: biblioteca de modelagem estatística e econometria para testes de regressão e hipóteses.

  • pyarrow: biblioteca de alto desempenho para processamento de dados colunares e interoperabilidade com o Apache Arrow (por exemplo, Parquet e IPC).

  • SQLAlchemy: abstração de banco de dados e kit de ferramentas de mapeamento de objeto-relacional (ORM) para bancos de dados relacionais em Python.

  • pyodbc: conector ODBC para bancos de dados empresariais.

  • requests: biblioteca HTTP para chamar APIs e serviços Web.

  • matplotlib: biblioteca de plotagem para gráficos estáticos e visualizações.

  • plotly: biblioteca de visualização para painéis e gráficos interativos.

  • plotly: biblioteca de visualização para painéis e gráficos interativos.

  • dash: estrutura para criar aplicativos web analíticos em Python.

Instalação de pacotes adicionais

Dependendo de qual versão do Designer você usa, é possível instalar pacotes adicionais utilizando a função Alteryx.installPackages. Por exemplo, para instalar o keras, execute este comando:

from ayx import Package

Package.installPackages("keras")

Você só pode instalar pacotes adicionais do Python se executar o Designer como administrador. Usuários não administradores não podem instalar pacotes adicionais do Python.

Configurar a ferramenta

Use a janela de configuração da ferramenta Python para selecionar seu ambiente base e inserir o script Python.

Ambiente

Use o menu suspenso Ambiente para selecionar seu ambiente base. O ambiente padrão é DesignerBaseTools_vEnv.

Criar um ambiente personalizado

Você também pode criar um ambiente personalizado para usar em sua ferramenta Python. Você pode especificar suas dependências no ambiente personalizado e configurar a ferramenta Python para usar o ambiente. Isso permite que você importe pacotes rapidamente e fornece uma abordagem mais eficiente e fácil de gerenciar para usar a ferramenta Python no Designer.

Se você quiser usar um ambiente personalizado, siga estas instruções:

  1. Acesse esta pasta (versão de administrador do Designer):

    C:\Program Files\Alteryx\bin\Python\envs\DesignerBaseTools_vEnv\share\jupyter\kernels

  2. Copie a pasta designerbasetools_venv.

  3. Renomeie a pasta copiada com o nome desejado para o novo kernel.

  4. Na pasta renomeada, abra kernel.json.

  5. Atualize o valor display_name.

    • Defina-o com o nome do kernel que você deseja mostrar no menu Ambiente na configuração da ferramenta Python.

    • Esse valor geralmente corresponde ao nome da pasta, mas não é necessário.

  6. Deixe estes valores inalterados:

    • argv: o Jupyter usa isso para executar o Python para o ambiente. Não altere para testes.

    • language: deixe isso definido como python.

    Exemplo de arquivo kernel.json:

    {
  "argv": [
    "C:\\Program Files\\Alteryx\\bin\\Python\\envs\\DesignerBaseTools_vEnv\\Scripts\\python.exe",
    "-m",
    "ipykernel_launcher",
    "-f",
    "{connection_file}"
  ],
  "display_name": "MyCustomEnv",
  "language": "python"
}

  7. Salve o kernel.json e retorne ao Designer.

  8. Atualize a lista de kernel:

    • Clique fora da ferramenta Python e selecione-a novamente.

    • Se o novo kernel não estiver visível, feche o Designer e abra-o novamente.

Usar um interpretador de Python diferente (opcional)

Importante

Recomendamos o uv para gerenciar seu ambiente Python personalizado.

Você pode configurar seu ambiente personalizado para usar um interpretador de Python diferente. Isso permite que você use um ambiente Python totalmente independente com seus próprios pacotes instalados. Para usar um interpretador de Python diferente em seu ambiente personalizado, siga estes passos:

  1. Abra kernel.json na pasta personalizada do kernel.

  2. Atualize a primeira entrada na lista argv para apontar para o caminho do arquivo executável Python do seu ambiente personalizado.

    Exemplo kenrel.json com entrada argv atualizada:

    {
  "argv": [
    "C:\\Users\\<username>\\alteryx_envs\\myenv\\Scripts\\python.exe",
    "-m",
    "ipykernel_launcher",
    "-f",
    "{connection_file}"
  ],
  "display_name": "MyCustomEnv",
  "language": "python"
}

  3. Salve o arquivo kernel.json e atualize a lista de kernel no Designer.

    • Clique fora da ferramenta Python e selecione-a novamente.

    • Se o novo kernel não estiver visível, feche o Designer e abra-o novamente.

Adicione o pacote AYX ao ambiente personalizado

Importante

Se você estiver usando um ambiente Python personalizado, garanta que o pacote ayx está disponível. O pacote ayx é necessário para que a ferramenta Python interaja com o seu fluxo de trabalho do Designer (por exemplo, ler e gravar dados).

Para adicionar o pacote ayx ao seu ambiente personalizado, siga estes passos:

  1. Localize o pacote ayx no ambiente padrão:

    C:\Program Files\Alteryx\bin\Python\envs\DesignerBaseTools_vEnv\Lib\site-packages\ayx

  2. Copie toda a pasta ayx.

  3. Cole a pasta no diretório site-packages do ambiente personalizado:

    <your-env>\Lib\site-packages\

O pacote ayx depende de bibliotecas adicionais que podem não estar instaladas no seu ambiente personalizado (por exemplo, pandas). A cópia do pacote para o ambiente personalizado não instala automaticamente as dependências.

Instale todas as dependências ausentes no ambiente personalizado. Por exemplo:

pip install pandas

Por último, para verificar se você instalou com sucesso o pacote ayx, ative seu ambiente e execute este comando:

python -c "import ayx; print('ayx installed successfully')"

Script Python

Use o campo Script Python da janela de configuração para inserir ou colar seu script Python. Você também tem a opção de importar um script. Para fazer isso, selecione Substituir script/notebook e navegue até o arquivo de script ou notebook. O arquivo deve ser uma extensão .py (script Python) ou .ipynb (notebook Python).

Funções do Python no Alteryx

Há uma série de funções disponíveis como parte do pacote Alteryx quando você executa "from ayx import Alteryx". As funções permitem que você passe dados entre o Alteryx e o Jupyter.

Para obter funções, descrições e exemplos disponíveis, acesse Funções do Python no Alteryx.

Importante

A ferramenta Python trata seus dados como um quadro de dados do pandas. Para obter mais informações, acesse pandas.pydata.org.

Conecte-se aos dados do fluxo de trabalho

A ferramenta Python aceita múltiplas entradas. Depois de conectar as entradas, você pode usar a função Alteryx.read para trazer seus dados do fluxo de trabalho para a ferramenta como um pandas DataFrame. Você pode usar Python para transformar os dados e, por fim, usar Alteryx.write para gerar dados de saída da ferramenta Python.

Consulte Funções do Python no Alteryx para obter uma lista completa das funções disponíveis por meio da biblioteca do Alteryx.

Observações e limitações

Dtype da string do pandas

A ferramenta Python do Alteryx Designer não é compatível com o dtype do pandas "string". Em vez disso, recomendamos o dtype padrão "objeto", que permite que o DataFrame seja gravado com êxito.

IPython

Com as atualizações realizadas na ferramenta Python na versão 2026.1, os recursos interativos do IPython não são mais compatíveis com a funcionalidade pretendida da ferramenta Python no Designer.

A funcionalidade IPython é compatível principalmente com a exploração interativa, que é menos relevante em fluxos de trabalho de produção executados no Designer.

Como resultado:

  • O Alteryx não manterá a compatibilidade com recursos específicos do IPython.

  • Os fluxos de trabalho que dependem da funcionalidade IPython podem não se comportar mais da mesma maneira que antes da versão 2026.1.

  • Se você precisar dessas capacidades, execute seu código fora do Designer em um ambiente IPython.

A ferramenta Python não carrega o script com a opção Desabilitar configuração automática

Se você ativar Desabilitar configuração automática em Configurações de usuário, as ferramentas Python criadas antes da versão 26.1 não carregarão seu conteúdo de script quando você abrir um fluxo de trabalho pré-26.1 no Designer versão 2026.1.

Para resolver esse problema, desative Desabilitar configuração automática em Configurações de usuário e, em seguida, reabra o fluxo de trabalho. Isso permite que a ferramenta converta e carregue o conteúdo do script.

  • Esse problema afeta apenas ferramentas Python criadas antes do Designer versão 2026.1.

  • O problema não ocorre quando Desabilitar configuração automática está desativado (configuração padrão).

Nesta secção: