idea Better debug tutorials for toolbox in Python Ideas

Better debug tutorials for toolbox

HildermesJoséMedeirosFilho — Wed, 06 Jul 2022 04:38:58 GMT

I found the hard way that debuging a pyt could be very script like.


class Toolbox(object):
///Toolboxcode and Classes

def debug():
    """
    Debug with pydevd (I use pycharm but people could just change the aproach)
    """
    tbx = Toolbox()
    tool = ToolboxLabel()
    print('Debugging tool: {}'.format(tool.label))
    debug_folder = os.path.dirname(__file__)
    params = tool.getParameterInfo()
    params[0].value = os.path.join(debug_folder, "test")
    params[1].value = os.path.join(debug_folder, 'test', "docs") #os.path.join(debug_folder, 'testes', "pdfs")
    params[2].value = "CE"#"PI"
    params[3].value = 50
    params[4].value = os.path.join(debug_folder, 'test', 'temp')
    params[5].value = os.path.join(debug_folder, 'test', "test.shp")
    tool.execute(params, None)


if "__main__" == __name__:
    if "pydevd" in sys.modules:
        debug()

A more modern official debug
doc/Tutorial it would be appreciated.

Re: Better debug tutorials for toolbox - Status changed to: Under Consideration

HannesZiegler — Tue, 26 Nov 2024 19:50:51 GMT

You've got our attention! We think this is a good suggestion and have entered it in our backlog. This does not guarantee that the idea will be developed so we encourage the community to continue voting and sharing feedback which will help teams gauge user demand.

Re: Better debug tutorials for toolbox - Status changed to: In Product Plan

HannesZiegler — Thu, 20 Mar 2025 15:10:00 GMT

We're working on this! This status does not guarantee that the functionality will be in the next release, but development work has begun. Release cycles vary by product so make sure to check the product life cycle information to get an idea of when to expect the next release.

Re: Better debug tutorials for toolbox - Status changed to: Implemented

HannesZiegler — Tue, 20 May 2025 15:10:18 GMT

We have updated the documentation for debugging script tools and Python toolboxes with the release of ArcGIS Pro 3.5,

Debug Python code—ArcGIS Pro | Documentation

The documentation now provides more detailed information & instructions for debugging with Visual Studio and Visual Studio Code.

We have also released the ArcGIS Pro Debugger Extension for Visual Studio Code (a free to use IDE) to improve the experience and accessibility of debugging script tools and Python toolboxes,

Debug ArcGIS Pro python tools in VS Code using Att... - Page 2 - Esri Community