Python Tool Family

Version:
Current
Last modified: June 30, 2020

YXI installers can be grouped together to share dependencies and a single python virtual environment. This allows for a common site-packages path that is shared between all Python SDK tools that are of the same ToolFamily.

If 2 tools in the same ToolFamily, set ToolFamilyGlobalStateGroup to the same value. The tools will share the same subinterpreter. Additionally, the tools will share the same global state and global variables.

ToolFamily Attribute: A string field on the EngineSettings Element that indicates an association between multiple tools. Tools with the same value for ToolFamily will make use of the same python virtual environment and share dependencies. This allows for a common site-packages path that is shared between all Python SDK tools that are of the same ToolFamily

ToolFamilyGlobalStateGroup Attribute: A string field on the EngineSettings Element. It allows sharing of global state between 2 tools. If 2 tools in the same ToolFamily set ToolFamilyGlobalStateGroup to the same value, the tools will share the same subinterpreter, and as a consequence, they will share the same global state and global variables.

Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.