Python script tool function error handling

curtvprice — Fri, 10 Dec 2021 23:35:19 GMT

Looking for advice and discussion on implementing script tools.

I have been adopting the convention where my script tools are embedded a functions. Here is my generic template:

import os
import sys
import traceback
import arcpy
from arcpy import env

class MsgError(Exception):
    pass

def MyTool(args):
    """Enter python docstring here """
    # init cursor variables
    Row, Rows = [None] * 2
    # init temp file variables
    lyr1,tmp1 = [None] * 2
    try:
        # tool code here
        pass
    except MsgError as xmsg:
        arcpy.AddError(xmsg))
    except arcpy.ExecuteError:
        tbinfo = traceback.format_tb(sys.exc_info()[2])[0]
        arcpy.AddError(tbinfo.strip())
        numMsg = arcpy.GetMessageCount()
        for i in range(0, numMsg):
            arcpy.AddReturnMessage(i)
    except Exception as xmsg:
        tbinfo = traceback.format_tb(sys.exc_info()[2])[0]
        arcpy.AddError(tbinfo + str(xmsg))
    finally:
        # temp files
        for f in [lyr1, tmp1]:
            if f:
                try:
                    arcpy.Delete_management(f)
                except:
                    pass


if __name__ == "__main__":
    # ArcGIS Script tool interface
    # Get arguments, call tool
    argv = tuple(arcpy.GetParameterAsText(i)
        for i in range(arcpy.GetArgumentCount()))
    MyTool(*argv)

The issue I'm running into is when I use this tool in another script and import it directly instead of going through ImportToolbox (for performance reasons), for example

from rastertools import MyTool
...
MyTool(arg1, arg2)

And the tool fails with an error, my calling script does not stop because i handled it. I want my calling script to bail in this situation.

Is the following approach valid? I'm assuming that if MyTool failed I will get a response from arcpy.GetMessages(2) since I called arcpy.AddError() in the called function.

MyTool(arg1, arg2)
if arcpy.GetMessages(2):
    raise Exception("Geoprocessing tool MyTool failed")

Should I be using ImportToolbox to get my script tool instead of this more direct import of my tool function?

Re: Python script tool function error handling

curtvprice — Thu, 12 Mar 2015 14:55:24 GMT

No response.... any ideas? Should I always import tools using arcpy.ImportToolbox to properly handle tool failure? I think I was avoiding this in the past before tools ran in process.

Re: Python script tool function error handling

SarahSchwarzer1 — Fri, 09 Apr 2021 17:08:24 GMT

I was so excited because this is finally the question that should get the answer I need. I want my tool to stop right where it is, but it keeps going past the error. Maybe 6 years later someone will answer?

topic Re: Python script tool function error handling in Python Questions

Python script tool function error handling

Re: Python script tool function error handling

Re: Python script tool function error handling