topic Re: Python Toolbox Tool Display Order in Python Questions

Python Toolbox Tool Display Order

LorneDmitruk — Thu, 17 Jan 2013 18:50:33 GMT

Hi,

I've been coding a python toolbox for use in a data conversion process. I would like the tools to be presented in the order in which they need to be run as opposed to alphabetical which seems to be default way the tool are listed. I have tried placing the tools in the order I want in the list for the tools for example:

class Toolbox(object):     def __init__(self):         """Define the toolbox (the name of the toolbox is the name of the         .pyt file)."""         self.label = "My Toolbox"         self.alias = ""         # List of tool classes associated with this toolbox         self.tools = [Importdata,Convertdata, CalculateMeasures, StationLine,         CreatePoints,ExtractPoint,CreateDataPackage]

So other than naming the tools step 1, step 2 etc. is there a way to overide the default listing of the tools in a python toolbox?

Cheers!

Re: Python Toolbox Tool Display Order

JimCousins — Thu, 17 Jan 2013 19:53:16 GMT

Lorne,
Direct from the help:
Toolset and tool display order
Toolsets and tools are always displayed alphabetically. You cannot change this alphabetical ordering.
If there is some implied order to using tools within a toolbox or toolset, such as "use this tool first, then this tool," you should consider creating models, since models are the way you create and use a sequence of tools.

so, what about a tool that runs all of these in the appropriate order, in addition to the individual stand-alone tools?
Regards,
Jim

Re: Python Toolbox Tool Display Order

LorneDmitruk — Fri, 18 Jan 2013 13:38:48 GMT

Thanks Jim,

I knew I should have RTFM'd a little more deeply. I have thought about a tool that runs them all but I want the users to have a chance to inspect the results from each tool before they continue to the next. The other possibility would be to create a python add-in but I don't have time to figure that out right now.

Cheers!

Lorne,
Direct from the help:
Toolset and tool display order
Toolsets and tools are always displayed alphabetically. You cannot change this alphabetical ordering.
If there is some implied order to using tools within a toolbox or toolset, such as "use this tool first, then this tool," you should consider creating models, since models are the way you create and use a sequence of tools.

so, what about a tool that runs all of these in the appropriate order, in addition to the individual stand-alone tools?
Regards,
Jim

Re: Python Toolbox Tool Display Order

ChrisSnyder — Fri, 18 Jan 2013 15:28:15 GMT

I don't think there's any shame in naming the tools "Step 1 - Do This", "Step2 - Do That", etc.

Another idea... What about having a single tool that pauses between sections and asks for a user response before continuing?

Re: Python Toolbox Tool Display Order

Heidi_Kristenson — Tue, 12 Nov 2019 02:50:56 GMT

Any chance that this has changed in the intervening years? I would also like to set a specific display order for the tools in my python toolbox file. A user may not need or want to use every tool in my toolbox, so wrapping them into a model or a single tool doesn't really suit my purposes. I would like the users to see the tools available in the order that they might become useful. In the past I've gone with starting the label with a step number, but it would be tidier if I could just designate the order in the code for the toolbox.

Re: Python Toolbox Tool Display Order

DanPatterson_Retired — Tue, 12 Nov 2019 02:57:27 GMT

no change alphabetical still,