idea Allow multiple files for Python toolboxes in ArcGIS Pro Ideas

Allow multiple files for Python toolboxes

ChrisGarrard — Thu, 11 Jul 2024 19:16:48 GMT

I would like to be able to put each tool in a Python toolbox in its own file. This way I don't end up with a huge and hard to manage .pyt file if the toolbox contains a lot of tools. Right now I can write other modules and use them in the tool's execute method, which definitely helps, but putting the entire tool in its own file would be a lot better.

I was thinking that maybe a Python toolbox could be a folder that contained all of the required files, kind of like a file geodatabase.

Re: Allow multiple files for Python toolboxes

DavidWynne — Wed, 20 Feb 2013 21:12:26 GMT

Have a look at this python toolbox the Spatial Analyst team recently put out.

What they did, and what you could do is, is write out tool classes into individual .py's. Then use a from-<py>-import-<tool> style to import in the tool classes. Then you just have to add the imported tool class(es) to the toolbox's tools property.

-Dave

Re: Allow multiple files for Python toolboxes

Luke_Pinner — Sun, 24 Mar 2013 23:04:49 GMT

Yes, this is how I do it. See http://forums.arcgis.com/threads/66230-Anyone-using-the-new-Python-Toolboxes-at-10.1?p=230255&viewfull=1#post230255

Re: Allow multiple files for Python toolboxes - Status changed to: Closed

HannesZiegler — Fri, 19 Jul 2024 21:26:40 GMT

Thank you for submitting your idea to break out individual tools in a .pyt into separate files. We appreciate your suggestion and the time you took to provide detailed feedback. The recommended way to separate individual tool logic from your Python Toolbox code is to place the tool logic in separate modules and import these in your .pyt (as described by in Dave and Luke's previous responses).

Re: Allow multiple files for Python toolboxes

HaydenWelch — Tue, 24 Sep 2024 01:30:35 GMT

@HannesZiegler

I do think that the implementation I've shown in pytframe2 is a good iteration on the code shown here. Utilizing module reloading and a more agnostic import system that relies not on import statements, but on a configuration dictionary.

Only adding a comment here to raise some awareness on similar solutions and hopefully gather similar ideas into one solution.

Re: Allow multiple files for Python toolboxes

HannesZiegler — Fri, 25 Oct 2024 19:34:21 GMT

Yes, thanks, some users viewing this idea may find it helpful