Skip to main content

ListTools

Summary

The ListTools function returns a list of geoprocessing tools.

Syntax

ListTools({wild_card})

Parameter Explanation Data Type

wild_card

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

Use an asterisk (*) to represent zero or more characters. For example, Te* finds Tennessee and Texas.

String

Return value

Data Type Explanation

String

The list returned from the function containing geoprocessing tool names, optionally limited by the 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))