PythonScript policy
Stay organized with collections Save and categorize content based on your preferences.

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

What

The Python Script policy lets you add customized Python functionality to your API proxy flow, especially when the functionality you need is beyond what the Apigee out-of-the-box policies provide.

This policy is an Extensible policy and use of this policy might have cost or utilization implications, depending on your Apigee license. For information on policy types and usage implications, see Policy types.

Python language support is provided through Jython version 2.5.2. Third-party libraries you add must be "pure Python" (implemented only in Python). For more on adding libraries, see Resource files.

A Python policy contains no actual code. Instead, a Python policy references a Python resource and defines the Step in the API flow where the Python script executes. You can upload your script through the Apigee UI proxy editor, or you can include it in the /resources/py directory in API proxies that you develop locally.

Samples

Python policy & script

Python Script policy

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?> <Scriptname="Python-1"> <DisplayName>Python-1</DisplayName> <ResourceURL>py://myscript.py</ResourceURL> </Script>

In this example, the element, ResourceURL specifies the relevant Python script resource.

Python Script

This shows what you might include in the Python script itself.

importbase64username=flow.getVariable("request.formparam.client_id")password=flow.getVariable("request.formparam.client_secret")base64string=base64.encodestring('%s:%s'%(username,password))[:-1]authorization="Basic "+base64stringflow.setVariable("authorizationParam",authorization)

Element reference

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?> <Scriptname="Python-1"> <DisplayName>Python-1</DisplayName> <ResourceURL>py://myscript.py</ResourceURL> <IncludeURL>py://myscript_dependency.py</IncludeURL> </Script>

The following table describes attributes that are common to all policy parent elements:

Attribute	Description	Default	Presence
`name`	The internal name of the policy. The value of the `name` attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters. Optionally, use the `<DisplayName>` element to label the policy in the management UI proxy editor with a different, natural-language name.	N/A	Required
`continueOnError`	Set to `false` to return an error when a policy fails. This is expected behavior for most policies. Set to `true` to have flow execution continue even after a policy fails. See also: Fault rules are triggered ONLY in an error state (about continueOnError) Handling faults within the current flow	false	Optional
`enabled`	Set to `true` to enforce the policy. Set to `false` to turn off the policy. The policy will not be enforced even if it remains attached to a flow.	true	Optional
`async`	This attribute is deprecated.	false	Deprecated

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>

Default

N/A

If you omit this element, the value of the policy's name attribute is used.

Presence Optional

Type String

<ResourceURL> element

This element specifies the main Python file that will execute in the API flow. You can store this file at the API proxy scope (under /apiproxy/resources/py in the API proxy bundle or in the Scripts section of the API proxy editor's Navigator pane), or at the organization or environment scopes for reuse across multiple API proxies, as described in Resource files. Your code can use the objects, methods, and properties of the JavaScript object model.

<ResourceURL>py://myscript.py</ResourceURL>

Default:	None
Presence:	Required
Type:	String

<IncludeURL> element

Specifies a Python file to be loaded as dependency to the main Python file specified with the <ResourceURL> element. The scripts will be evaluated in the order in which they are listed in the policy.

Include more than one Python dependency resource with additional <IncludeURL> elements.

Warning: If your Python files are stored at the organization or environment level, be sure they were uploaded correctly with cURL using the -F option or as a file attachment through a REST client. Content-Type is multipart/form-data. For more information, see Resource files.

<IncludeURL>py://myscript_dependency.py</IncludeURL>

Default:	None
Presence:	Optional
Type:	String

Error codes

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.script.ScriptEvaluationFailed`	`500`	The PythonScript policy can throw several different types of ScriptExecutionFailed errors. Commonly seen types of errors include NameError and ZeroDivisionError.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidResourceUrlFormat`	If the format of the resource URL specified within the `<ResourceURL>` or the `<IncludeURL>` element of the PythonScript policy is invalid, then the deployment of the API proxy fails.
`InvalidResourceUrlReference`	If the `<ResourceURL>` or the `<IncludeURL>` elements refer to a PythonScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ScriptExecutionFailed"`
`pythonscript.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`pythonscript.PythonScript-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{"fault":{"faultstring":"Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError:"status"isnotdefined.\"","detail":{"errorcode":"steps.script.ScriptExecutionFailed"}}}

Example fault rule

<FaultRulename="PythonScript Policy Faults"> <Step> <Name>AM-CustomErrorResponse</Name> <Condition>(fault.nameMatches"ScriptExecutionFailed") </Condition> </Step> <Condition>(pythonscript.PythonScript-1.failed=true) </Condition> </FaultRule>

PythonScript policy Stay organized with collections Save and categorize content based on your preferences.