---
title: "Execute Python Script"
---
Executes a specified Python script.
PYExec(
Script: <text>,
[Verbose: <true/false>],
[SuccessExitCode: <text>],
[Variables: <%(key1: value1, ...)>],
[OutVariables: <@(text)>],
[Arguments: <text>],
[EnvironmentVariables: <%(key1: value1, ...)>],
[PythonPath: <text>],
[CaptureDebug: <true/false>]
);
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 |
---|---|---|---|
☆ Script (default) | text | Script | This argument is required. |
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. Default value is "ignored". |
Variables | %(key1: value1, ...) | Variables | |
OutVariables | @(text) | OutVariables | |
Command line arguments | text | Arguments | |
Environment variables | %(key1: value1, ...) | EnvironmentVariables | |
Python path | text | PythonPath | Full path to python/python.exe on the target server. Default value is "$PythonPath". |
Capture debug messages | true/false | CaptureDebug |