Usage

Summary

Returns the syntax for the specified tool or function.

Discussion

Complete help information for a tool, including complete parameter descriptions, can be accessed using the Python help function.

import arcpy
help(arcpy.Buffer_analysis)

In a Notebook, complete help information, can be returned by appending a question mark to any function.

import arcpy
arcpy.Buffer_analysis?

Syntax

Usage (tool_name)
ParameterExplanationData Type
tool_name

The tool name to display the syntax.

String
Return Value
Data TypeExplanation
String

Returns a string containing the specified tool's syntax.

Code sample

Usage example

Print the specified tool's syntax.

import arcpy

print(arcpy.Usage("Buffer_analysis"))
print(arcpy.Usage("MakeFeatureLayer_management"))

Related topics