PythonScript policy runtime error troubleshooting

You're viewing Apigee and Apigee hybrid documentation.
View Apigee Edge documentation.

ScriptEvaluationFailed

Error code

steps.script.ScriptEvaluationFailed

Error response body

{
    "fault": {
        "faultstring": "Evaluation of script pythonscript_name (py) failed with reason: error_type: error_description"",
        "detail": {
            "errorcode": "steps.script.ScriptEvaluationFailed"
        }
    }
}

Possible causes

The Python Script policy can throw several different types of ScriptEvaluationFailed errors. The sections below describe some of these errors.

NameError

If there is a variable in the PythonScript code which is referenced or operated on without being defined, then you get the Name error.

Error response body

{
    "fault": {
        "faultstring": "Evaluation of script pythonscript_name (py) failed with reason: "NameError: variable_name is not defined"",
        "detail": {
            "errorcode": "steps.script.ScriptEvaluationFailed"
        }
    }
}

Example error response body

{
    "fault": {
        "faultstring": "Evaluation of script myscript.py (py) failed with reason: "NameError: 'num3' is not defined"",
        "detail": {
            "errorcode": "steps.script.ScriptEvaluationFailed"
        }
    }
}

Diagnosis

Identify the PythonScript policy and the undefined variable name from the faultstring element of the error response. For example, in the following faultstring, the PythonScript name is myscript.py and the undefined variable name is num3:
```
"faultstring": "Evaluation of script myscript.py (py) failed with reason: "NameError: 'num3' is not defined""
```
Examine the PythonScript source file identified in step #1 above and verify if the undefined variable identified in step #1 above is being referenced. For example, the following PythonScript code references the undefined variable num3, which matches the faultstring:
```
num1 = 1.5
num2 = 6.3
sum = float(num1) + float(num3)
print('The sum of {0} and {1} is {2}'.format(num1, num3 sum))
```
Check if the specific variable is defined within the PythonScript code. If the variable is not defined, then that's the cause for the error.

In the example script shown above, the variable num3 is undefined. Therefore, you will get the below error:
```
"faultstring": "Evaluation of script myscript.py (py) failed with reason: "NameError: 'num3' is not defined""
```

Resolution

Ensure that all the variables referenced in the PythonScript code are properly defined.

To fix the issue with the example PythonScript shown above, define the variable num3 before using it. For example:

num1 = 1.5
num2 = 6.3
num3 = 8.7
sum = float(num1) + float(num3)
print('The sum of {0} and {1} is {2}'.format(num1, num3, sum))

ZeroDivisionError

This error is raised when the second argument of a division or modulo operation is zero.

Error response body

{
    "fault": {
        "faultstring": "Evaluation of script pythonscript_name (py) failed with reason: "ZeroDivisionError: reason_for_error"",
        "detail": {
            "errorcode": "steps.script.ScriptEvaluationFailed"
        }
    }
}

Example error response body

{
    "fault": {
        "faultstring": "Evaluation of script myscript.py (py) failed with reason: "ZeroDivisionError: integer division or modulo by zero"",
        "detail": {
            "errorcode": "steps.script.ScriptEvaluationFailed"
        }
    }
}

Diagnosis

Identify the PythonScript policy name and the reason for failure from the faultstring element of the error response. For example, in the following faultstring, the PythonScript name is myscript.py and the reason for failure is integer division or modulo by zero:
```
"faultstring": "Evaluation of script myscript.py (py) failed with reason: "ZeroDivisionError: integer division or modulo by zero""
```
Examine the PythonScript source file identified in step #1 above and verify if there's a division or a modulus operation by zero. For example, the following PythonScript code performs division by zero, which matches with what's in the faultstring:
```
a = 0
b = 5
c = b/a
print c
```
In the example script shown above, because the second argument of the division operation is zero, you get the following error:
```
"faultstring": "Evaluation of script myscript.py (py) failed with reason: "ZeroDivisionError: integer division or modulo by zero""
```

Resolution

Ensure that the second argument of a division or modulo operation is non zero in the PythonScript.

To fix the issue with the example PythonScript shown above, use a non zero value as the second argument of a division or modulo operation. For example:

a = 3
b = 5
c = b/a
print c

More Information

There are many other possible causes for the error steps.script.ScriptEvaluationFailed apart from the ones described above. Please refer to the official Python documentation for more information.