Returns the number of arguments passed to the script.


GetArgumentCount ()
Return Value
Data TypeExplanation

The number of arguments passed to the script.

Code sample

GetArgumentCount example 1

Check for required number of arguments to run the Clip tool and handle optional argument.

import arcpy

# Set workspace
arcpy.env.workspace = "c:/data/airport.gdb"

# Set local variables
in_features = arcpy.GetParameterAsText(0)
clip_features = arcpy.GetParameterAsText(1)
out_feature_class = arcpy.GetParameterAsText(2)
xy_tolerance = arcpy.GetParameterAsText(3)

# Check for required number of arguments
if arcpy.GetArgumentCount() < 3:
    print("3 arguments required for Clip_analysis tool")

# Execute Clip tool
    arcpy.Clip_analysis(in_features, clip_features,
                        out_feature_class, xy_tolerance)
except arcpy.ExecuteError:
GetArgumentCode example 2

The following sample uses the GetArgumentCount and GetParameterAsText functions to assign all parameter values in a script tool to a single variable as a list of values.

import arcpy

args = [arcpy.GetParameterAsText(i) for i in range(arcpy.GetArgumentCount())]

Related topics