Skip To Content

Writing messages in script tools

When a tool is run, ArcPy is fully aware of the application it is called from. One major effect of this is that you can write messages in Python and your messages automatically appear on the tool dialog box, in Geoprocessing history, and the Python window. It also means that any model or script tool that calls your tool has access to the messages you write.

Learn more about messaging in Understanding messaging in script tools

During execution of a tool, messages are written that can be retrieved with geoprocessing functions. The four ArcPy functions for writing messages are as follows:

  • AddMessage(message)—For general informative messages (severity = 0)
  • AddWarning(message)—For warning messages (severity = 1)
  • AddError(message)—For error messages (severity = 2)
  • AddIDMessage(message_type, message_ID, add_argument1, add_argument2)—Used for both errors and warnings (the message_type argument determines severity).

A call to AddIDMessage() displays a short message and the message ID, which is a link to an explanation about the cause of and solutions to the problem. When you add an error message using either AddError() or AddIDMessage(), the following occurs:

  • Your script continues execution. It is up to you to add appropriate error-handling logic and stop execution of your script. For example, you might need to delete intermediate files or cursors.
  • Upon return from your script, the calling script or model receives a system error and execution stops.

Example of adding messages

In the example below, the input is evaluated, and if it contains no input features, an error message is added to the tool and an arcpy.ExecuteError exception is raised to end the tool.

import arcpy
input = arcpy.GetParameterAsText(0)
output = arcpy.GetParameterAsText(0)
       
# If the input has no features, add an error message, and raise
#  an arcpy.ExecuteError
if int(arcpy.GetCount_management(input)[0]) == 0:
    arcpy.AddError("{0} has no features.".format(input))
    raise arcpy.ExecuteError

Related topics