解决Alteryx Python SDK的ModuleNotFoundError：自定义工具开发报错

我正在Alteryx Designer中开发自定义工具，采用Alteryx Python SDK实现，但导入AlteryxPythonSDK模块时出现ModuleNotFoundError错误。

我的代码 #

from ayx import Alteryx
import AlteryxPythonSDK as Sdk

def process_tool(input_anchor, output_anchor):
    # Read the incoming data from the input anchor
    incoming_record_info = input_anchor.get_record_info(input_anchor)

    # Create the outgoing data with the same structure as the incoming data
    outgoing_record_info = Sdk.RecordInfo(input_anchor)
    outgoing_record_info.init_from_input_record_info(incoming_record_info)

    # Set the predefined column names for row number 3
    predefined_columns = ['Column A', 'Column B', 'Column C', 'Column D', 'Column E']

    # Create a new row for the column names
    outgoing_row = outgoing_record_info.construct_record()

    # Write the predefined column names to the outgoing row
    for idx, column_name in enumerate(predefined_columns):
        outgoing_row[idx] = column_name

    # Push the outgoing row to the output anchor
    output_anchor.push_record(outgoing_row)

    # Forward the incoming data to the output anchor
    for record in input_anchor:
        output_anchor.push_record(record)

# Instantiate the Alteryx tool object
tool = Sdk.AlteryxTool(1, 1)

# Get the input and output anchors
input_anchor = tool.get_input_anchor(0)
output_anchor = tool.get_output_anchor(0)

# Process the tool using the custom function defined above
process_tool(input_anchor, output_anchor)

运行时错误 #

ModuleNotFoundError: No module named 'AlteryxPythonSDK'

已完成的排查操作 #

• 通过pip安装ayx-python-sdk包，提示依赖已满足
• 将pip升级至最新版本
• 执行pip操作后重启应用及系统
• 测试未使用Python SDK的示例代码可正常运行

解决办法 #

1. 安装到Alteryx自带的Python环境 #

Alteryx Designer自带独立Python环境，需确保SDK安装在该环境中：

• 打开Alteryx Designer，进入Options > User Settings > Edit User Settings > Python，复制当前使用的Python解释器路径
• 打开命令提示符，用该路径执行pip安装命令，示例：

  "C:\Program Files\Alteryx\bin\Miniconda3\envs\AlteryxTools\python.exe" -m pip install ayx-python-sdk --upgrade
  

2. 调整导入语句 #

在Alteryx环境中，AlteryxPythonSDK属于ayx包的子模块，可修改导入方式：

from ayx import Alteryx
from ayx.AlteryxPythonSDK import AlteryxTool, RecordInfo

同时将代码中Sdk.RecordInfo改为RecordInfo，Sdk.AlteryxTool改为AlteryxTool。

3. 检查自定义工具配置 #

• 确认工具的Config.xml中未手动指定外部Python路径
• 使用Alteryx官方的Python Tool模板创建工具，默认会绑定内置Python环境

4. 重装SDK清除缓存 #

完全卸载后重新安装，避免缓存问题：

"[你的Alteryx Python路径]" -m pip uninstall ayx-python-sdk -y
"[你的Alteryx Python路径]" -m pip install ayx-python-sdk

内容的提问来源于stack exchange，提问作者usama nomani