ListTools

Summary

Returns a list of geoprocessing tools.

Syntax

ListTools ({wild_card})
ParameterExplanationData Type
wild_card

Limits the results returned. If a value is not specified, all values are returned. The wildcard is not case sensitive.

SymbolDescriptionExample

*

Represents zero or more characters.

Te* finds Tennessee and Texas.

String
Return Value
Data TypeExplanation
String

The list returned from the function containing geoprocessing tool names, limited by the optional wild_card argument.

Code sample

ListTools example

List 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