---
title: "PYCall"
---
Calls a Python script that is stored as an asset.
PYCall(
Name: <text>,
[Parameters: <%(key1: value1, ...)>],
[Verbose: <true/false>],
[SuccessExitCode: <text>],
[InputVariables: <%(key1: value1, ...)>],
[OutputVariables: <@(text)>],
[PythonPath: <text>],
[CaptureDebug: <true/false>],
[Arguments: <text>],
[EnvironmentVariables: <%(key1: value1, ...)>]
);
This operation may be prefixed with python::
, although this is a built-in namespace and isn't really necessary.
Name | Format | Script Usage | Usage Notes |
---|---|---|---|
☆ Name (default) | text | Name | The name of the script asset. This argument is required. |
Parameters | %(key1: value1, ...) | Parameters | |
Verbose | true/false | Verbose | When true, additional information about staging the script is written to the debug log. |
Success exit code | text | SuccessExitCode | Integer exit code which indicates no error. When not specified, the exit code is ignored. This can also be an integer prefixed with an inequality operator. |
InputVariables | %(key1: value1, ...) | InputVariables | |
OutputVariables | @(text) | OutputVariables | |
Python path | text | PythonPath | Full path to python/python.exe on the target server. |
Capture debug messages | true/false | CaptureDebug | |
Command line arguments | text | Arguments | |
Environment variables | %(key1: value1, ...) | EnvironmentVariables |