How to add the default blue warning message in custom Python Toolboxes
Hi everyone,
I'm developing a custom Python Toolbox (.pyt) in ArcGIS Pro, and I'd like to include the default blue warning message that appears in many built-in geoprocessing tools. Specifically, the one that says: “This tool modifies the Input Table”, as shown in the snapshot below.
In ArcGIS Pro tools, this message appears just below the tool's name and above the input parameters. It's very useful to inform users that the tool will overwrite or modify the input data directly.
Is there any official way to enable or configure this message for custom Python tools?
Or is this behavior restricted to tools developed internally by Esri?
Thanks in advance!
Albert
To add to the moderately hacky workarounds, you can add a warning message to the top parameter.
import arcpy
class Toolbox:
def __init__(self):
self.label = "Warning Test"
self.alias = "WarningTest"
self.tools = [Tool]
class Tool:
def __init__(self) -> None:
self.description = "Test tool"
self.label = "Testing"
return
def getParameterInfo(self) -> list:
acknowledge = arcpy.Parameter(
displayName="Acknowledge",
name="acknowledge",
datatype="GPBoolean",
parameterType="Required",
direction="Input",
)
acknowledge.value = False
return [acknowledge]
def updateParameters(self, parameters: list[arcpy.Parameter]) -> None: ...
def updateMessages(self, parameters: list[arcpy.Parameter]) -> None:
if not parameters[0].value:
parameters[0].setWarningMessage('This Tool Modifies the Input Table, Please check this box to acknowledge')
else:
parameters[0].clearMessage()
def execute(self, parameters: list[arcpy.Parameter], messages: list) -> None:
if not parameters[0].value:
arcpy.AddWarning('Please check the acknowledge box to run this tool')
return
...
If you're authoring for Pro 3.4 or above you can check the new "Show banner that tool modifies the input data" option in the General properties. Looks official to me!
