idea Python ToolBox Guide Book in ArcGIS Pro Ideas

Python ToolBox Guide Book

GusMartinka — Wed, 24 Oct 2012 22:57:21 GMT

An in depth guide book, like the one for python add-ins, would be great for learning the power of python toolboxes. An explanation of best practices and debugging would be great.

An example of dynamic tool validation would also be great. For example, a tool that pulled the current data driven page record into a value table or record set for user interaction would be very helpful.

Re: Python ToolBox Guide Book

Suzanne-Boden — Fri, 09 Nov 2012 00:55:17 GMT

We did a free one-hour training seminar on Python toolboxes a little while back. You may find that helpful for learning some best practices. You can access the seminar at http://training.esri.com/gateway/index.cfm?fa=catalog.webCourseDetail&courseid=2523

Re: Python ToolBox Guide Book

KoryKramer — Mon, 06 Mar 2017 17:50:43 GMT

Hi Gus,

I realize that a lot of time has passed since the original idea was posted, so I wanted to check with you to make sure you're aware of the following resources:

What is a Python toolbox? What is a Python toolbox?—Geoprocessing and Python | ArcGIS Desktop

Comparing custom and Python toolboxes: Comparing custom and Python toolboxes—Geoprocessing and Python | ArcGIS Desktop

As well as all of the resources under the Creating tools in a Python toolbox topic: Creating a new Python toolbox—Geoprocessing and Python | ArcGIS Desktop

Do you need something more than the above? If so, please provide additional and specific information about what would be helpful.

Re: Python ToolBox Guide Book

curtvprice — Mon, 06 Mar 2017 19:20:53 GMT

Kory, we really need some best practices not detailed in the help. For example, if you put your code in one big pyt file, it takes forever to load, it's really best practice to create separate scripts and import them into the pyt. Perhaps setting up a package is the best way to do this, but there are no cookbooks available from the help. Also, if you do this you need to do a reload() but I understand that's handled differently in 3.4 (accessing toolbox in Pro). The help really doesn't have any good examples, and unlike python add ins there are no templates out there beyond the pyt stub in the help to get things going.

I have avoided getting into pyt's much because of this lack of documentation, I have run into weirdnesses caused probably by the way I am structuring a bigger than "toy" size pyt. If you structure things wrong, you can make ArcMap totally unstable so such a resource is still needed.

Re: Python ToolBox Guide Book

MattWilkie1 — Thu, 17 Jun 2021 21:56:34 GMT

What @curtvprice says above is still largely true. There aren't enough best practice examplars of fully fledged python toolboxes to study and learn from.

Re: Python ToolBox Guide Book - Status changed to: In Product Plan

DavidWynne — Tue, 21 Feb 2023 22:24:50 GMT

Re: Python ToolBox Guide Book

MattWilkie1 — Wed, 22 Feb 2023 18:15:03 GMT

Great news!

Re: Python ToolBox Guide Book

HannesZiegler — Thu, 31 Oct 2024 20:24:58 GMT

Quick update: As you may have noticed, this idea has slipped for a few releases now due to the size of the task and available bandwidth, but we are still including it in our planning.

Re: Python ToolBox Guide Book - Status changed to: Under Consideration

HannesZiegler — Fri, 24 Oct 2025 19:30:52 GMT

Unfortunately, this work has been pushed off near-term due to other priorities, but it is still included in our future plans.

We encourage the community to continue voting and sharing feedback.