Skip to main content

Python tool Python 工具

更新了 Python工具

自 2026.2 Designer 版本发布起,Python 工具可与 AMP 引擎原生配合使用。

自 2026.1 Designer 版本发布起,Python 工具中不再提供交互模式。

Python 开发目前支持通过“生产优先”的执行模型进行。这样一来,您可以在运行工作流之前直接在工具或首选的外部集成开发环境 (IDE) 中编辑 Python 脚本。

用户角色要求

用户角色*

工具/功能访问

完整用户

✓

基本用户

X

*适用于 Designer 版本 2025.1+ 上的 Alteryx One专业版和企业版客户。

Python 工具是面向 Python 用户的代码编辑器。使用此工具前,您应熟练掌握 Python。通过 from ayx import Alteryx 导入 Alteryx Python 软件包后,有关可在 Designer 中通过「Python 工具」使用的函数,请参阅 Alteryx Python 函数。

重要

尽管 Designer 接受客户 Python 代码,但 Alteryx 并不为客户 Python 代码提供支持。

单个工具示例

此工具具有单个工具示例。转到示例工作流,了解如何在 Designer 中直接访问此示例和许多其他示例。

入门

使用 Python 工具配置窗口输入或导入您的 Python 脚本。如需代码帮助,请参阅Alteryx Python 函数中的其他引用。

安装所需的数据科学包

Python 工具包括以下数据科学包:

  • ayx:与工作流和 Designer 运行时交互的 Alteryx Python API。

  • ayx_python_sdk:用于在 Python 中构建和扩展 Alteryx 工具的软件开发包 (SDK)。

  • numpy:Python 中用于数值计算和数组处理的核心软件包。

  • pandas:用于数据分析、时间序列和表格处理的数据结构。

  • scipy:用于优化、统计、信号处理和高等数学的科学计算库。

  • scikit-learn:用于分类、回归、聚类和模型评估的机器学习库。

  • statsmodels:用于回归和假设检验的统计建模与计量经济学库。

  • pyarrow:用于列式数据处理和 Apache Arrow 互操作的高性能库(例如 Parquet 和 IPC)。

  • SQLAlchemy:Python 中用于关系型数据库的数据库抽象和对象关系映射 (ORM) 工具包。

  • pyodbc:用于企业数据库的 ODBC 连接器。

  • requests:用于调用 API 和 Web 服务的 HTTP 库。

  • matplotlib:静态图表和可视化的绘制库。

  • plotly:用于交互式图表和仪表板的可视化库。

  • plotly:用于交互式图表和仪表板的可视化库。

  • dash:用于在 Python 中构建分析型 Web 应用程序的框架。

其它软件包安装

根据所使用的 Designer 的版本,您可以使用 Alteryx.installPackages 函数安装其他程序包。例如,若要安装 keras,请运行以下命令:

from ayx import Package

Package.installPackages("keras")

仅当您以管理员身份运行 Designer 时,才能安装其他 Python 软件包。非管理员用户无法安装其他 Python 软件包。

配置工具

您可以使用 Python 工具的配置窗口选择基础环境并输入 Python 脚本。

环境

使用环境下拉菜单选择您的基础环境。默认环境为 DesignerBaseTools_vEnv。

创建自定义环境

您还可以创建自定义环境以在 Python 工具中使用。您可以在自定义环境中指定依赖关系,并配置 Python 工具以使用该环境。这助您快速导入包,并提供了一种在 Designer 中使用 Python 工具更高效、更易于管理的方法。

若要使用自定义环境,请按照以下说明操作:

  1. 导航至以下文件夹(Designer 管理员版本):

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

  2. 复制 designerbasetools_venv 文件夹。

  3. 将复制的文件夹重命名为您想要的新内核名称。

  4. 在重命名后的文件夹中,打开 kernel.json 文件。

  5. 更新 display_name 值。

    • 将其设置为您希望在 Python 工具配置的环境菜单中显示的内核名称。

    • 显示名称不应与包含自定义环境的文件夹名称相同。

  6. 保留以下值不变:

    • argv:Jupyter 使用此项为 environment 运行 Python。测试时请勿更改。

    • language:保留此设置为 python。

    示例 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. 保存 kernel.json 并返回 Designer。

  8. 刷新内核列表:

    • 单击 Python 工具,然后再次选择该工具。

    • 如果未看到新内核,请关闭 Designer 并重新打开。

使用不同的 Python 解释器(可选)

重要

我们建议使用 uv 来管理您的自定义 Python 环境。

您可以将自定义环境配置为使用不同的 Python 解释器。执行此操作可让您使用完全独立的 Python 环境以及您自己安装的包。若要在自定义环境中使用不同的 Python 解释器,请按照以下步骤操作:

  1. 在自定义内核文件夹中打开 kernel.json。

  2. 更新 argv 列表中的第一个条目,使其指向自定义环境 Python 可执行文件的路径。

    带更新后 argv 条目的示例 kernel.json:

    {
      "argv": [
        "C:\\Users\\<username>\\alteryx_envs\\myenv\\Scripts\\python.exe",
        "-m",
        "ipykernel_launcher",
        "-f",
        "{connection_file}"
      ],
      "display_name": "MyCustomEnv",
      "language": "python"
    }
  3. 保存 kernel.json 文件并在 Designer 中刷新内核列表。

    • 单击 Python 工具,然后再次选择该工具。

    • 如果未看到新内核,请关闭 Designer 并重新打开。

将 AYX 包添加到自定义环境

重要

若您使用的是自定义 Python 环境,请务必确保 ayx 包可用。Python 工具需要 ayx 包才能与 Designer 工作流进行交互(例如读取和写入数据)。

若要将 ayx 包添加到自定义环境,请按照以下步骤操作:

  1. 在默认 environment 中找到 wheels 目录:

    C:\Program Files\Alteryx\bin\Python\envs\DesignerBaseTools_vEnv\wheels

  2. 复制整个 ayx 文件夹。

    pip install ayx --find-links "C:\Program Files\Alteryx\bin\Python\envs\DesignerBaseTools_vEnv\wheels"

最后,若要验证是否已成功安装 ayx 包,请激活环境并运行以下命令:

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

Python 脚本

使用“配置”窗口中的 Python 脚本字段输入或粘贴您的 Python 脚本。您还可以选择导入脚本。要执行此操作,请选择覆盖脚本/笔记本,然后浏览至您的脚本或笔记本文件。文件扩展名必须为 .py(Python 脚本)或 .ipynb(Python 笔记本)。

  • Find and Replace: Use the find and replace icon to search and replace content in your script.

    • 在查找字段中输入文本,并自定义搜索条件:

      • 区分大小写(Alt + C):仅查找与输入文本大小写匹配的文本。查找“read”,而非“READ”。

      • Match Whole Word (Alt + W): Only find whole words (don't return words that include the input text). For example, find "data", not "DataFrame".

      • 使用正则表达式(Alt + R):输入正则表达式以自定义搜索条件。

      • 使用向上和向下箭头循环浏览匹配项。

      • 在所选内容中查找(Alt + L):选择此项以在当前行中查找。

    • 在 Replace 字段中输入文本,以替换您在 查找 字段中输入的文本。

      • Preserve Case (Alt + P): Preserve the case of the found text when replacing.

      • Replace (Enter): Replace one instance of the found text with the text in the Replace field.

      • Replace All (Ctrl + Alt + Enter): Replace all instances of the found text with the text in the Replace field.

  • 复制:选择「复制」图标,以复制当前编辑器的完整内容,包括自上次保存工作流以来所做的编辑。

  • Comment and Uncomment: Select the # icon to comment or uncomment the current line or selected non-blank lines without changing indentation.

  • Import: Select to import a Python script and browse to your script or notebook file. The file must be a .py (Python script) or .ipynb (Python notebook) extension.

Alteryx Python 函数

运行 from ayx import Alteryx 后,有多个函数可作为 Alteryx 包的一部分进行使用。这些函数允许您在 Alteryx 和 Jupyter 之间传递数据。

如需了解可用函数、说明和示例,请参阅 Alteryx Python 函数。

重要

Python 工具会将您的数据视为 Pandas DataFrame。有关详细信息,请转至 pandas.pydata.org。

连接到工作流数据

Python 工具接受多个输入。连接输入后,您可以使用 Alteryx.read 函数将工作流数据作为 pandas DataFrame 导入该工具。然后您可以使用 Python 转换数据,最后使用 Alteryx.write 从 Python 工具输出数据。

如需了解 Alteryx 库提供的完整函数列表,请参阅 Alteryx Python 函数。

注意事项和限制

Pandas 字符串数据类型

Alteryx Designer Python 工具暂不支持 pandas 的“string”数据类型。建议改用标准的“object”数据类型,以确保能够成功写入 DataFrame。

IPython

随着 2026.1 版本对 Python 工具的更新,依赖 IPython 的交互式功能将不再与 Designer 中 Python 工具的预期功能兼容。

IPython 的核心功能是支持交互式探索,这在 Designer 中执行的生产工作流中实用性较低。

因此:

  • Alteryx 不会维护与 IPython 特定功能的兼容性。

  • 依赖于 IPython 功能的工作流,其行为方式可能与 2026.1 之前的版本有所不同。

  • 如果您需要这些功能,请在 Designer 外部的 IPython 环境中运行代码。

Python 工具在启用“禁用自动配置”后无法加载脚本

如果您在用户设置中开启禁用自动配置,则当您在 Designer 2026.1 中打开 26.1 之前版本的工作流时,在此版本之前创建的 Python 工具将无法加载其脚本内容。

要解决此问题,请在用户设置中关闭禁用自动配置,然后重新打开工作流。此操作助工具转换并加载脚本内容。

  • 此问题仅影响在 Designer 版本 2026.1 之前创建的 Python 工具。

  • 若禁用自动配置处于关闭状态(默认设置),则不会出现此问题。