ListTools (arcpy)

Summary

Lists the geoprocessing tools, limited by name.

Syntax

ListTools ({wild_card})
ParameterExplanationData Type
wild_card

The wild_card limits the results returned. If no wild_card is specified, all values are returned.

String
Return Value
Data TypeExplanation
String

The list returned from the function containing geoprocessing tool names, limited by the optional wild card.

Code Sample

ListTools example

Lists all tools in the specified toolbox.

import arcpy

# Create a list of tools in the Analysis toolbox
tools = arcpy.ListTools("*_analysis")

# Loop through the list and print each tool's usage.
for tool in tools:
    print(arcpy.Usage(tool))

Related Topics

3/3/2014