topic Re: Python Toolbox Toolset in Python Questions

Python Toolbox Toolset

DavidAllen — Mon, 10 Jun 2013 19:40:52 GMT

Can someone post an example of how to configure and use the toolsets in a Python Toolbox?

The help barely mentions that this is even an option, and the only code example I can find is to set:
self.category = ???Toolset Name???

but when you have:
self.tools = [tool1, tool2]

I just get the regular tools listed in the toolbox without a toolset.

How do you tell it to put the tools into the category?

Re: Python Toolbox Toolset

ShaunWalbridge — Sun, 12 Dec 2021 03:04:21 GMT

I've create an example, example-toolbox.pyt that hopefully clarifies (also as a Github Gist😞

import arcpy
 
class Toolbox(object):
    def __init__(self):
        self.label = u'Example_Toolbox'
        self.alias = ''
        self.tools = [FirstTool, SecondTool, ThirdTool]
 
 
class FirstTool(object):
 
    def __init__(self):
        self.label = u'First Tool'
        self.description = u''
        self.canRunInBackground = False
        self.category = "Import"
 
    def getParameterInfo(self):
        return
 
    def execute(self, parameters, messages):
        pass
 
class SecondTool(object):
 
    def __init__(self):
        self.label = u'Second Tool'
        self.description = u''
        self.canRunInBackground = False
        self.category = "Export"
 
    def getParameterInfo(self):
        return
 
    def execute(self, parameters, messages):
        pass
 
class ThirdTool(object):
 
    def __init__(self):
        self.label = u'Third Tool'
        self.description = u''
        self.canRunInBackground = False
        self.category = "Export"
 
    def getParameterInfo(self):
        return
 
    def execute(self, parameters, messages):
        pass

You'll then have two categories within your toolbox: Export and Import, Import will contain one item and Export will contain two.

cheers,
Shaun

Re: Python Toolbox Toolset

DavidAllen — Tue, 11 Jun 2013 11:52:15 GMT

I've create an example, example-toolbox.pyt that hopefully clarifies (also as a Github Gist😞

You'll then have two categories within your toolbox: Export and Import, Import will contain one item and Export will contain two.

cheers,
Shaun

Aha! I found three references to adding the self.category but none said that it goes in the individual tool class rather than the toolbox class.
Perfectly understandable now. Thanks!!

Re: Python Toolbox Toolset

BartłomiejStaroń — Tue, 08 Sep 2015 10:19:16 GMT

How to create toolset in toolset? It is possibile?

Re: Python Toolbox Toolset

ShaunWalbridge — Sun, 12 Dec 2021 03:04:24 GMT

Sure, just embed '\' separators between the toolsets. Here's an example where the two "Export" tools will be in separate toolsets, nested underneath the parent (also on GitHub😞

import arcpy

class Toolbox(object):
    def __init__(self):
        self.label = u'Example_Toolbox'
        self.alias = ''
        self.tools = [FirstTool, SecondTool, ThirdTool]


class FirstTool(object):

    def __init__(self):
        self.label = u'First Tool'
        self.description = u''
        self.canRunInBackground = False
        self.category = "Import"

    def getParameterInfo(self):
        return

    def execute(self, parameters, messages):
        pass

class SecondTool(object):

    def __init__(self):
        self.label = u'Second Tool'
        self.description = u''
        self.canRunInBackground = False
        self.category = "Export\\GeoJSON"

    def getParameterInfo(self):
        return

    def execute(self, parameters, messages):
        pass

class ThirdTool(object):

    def __init__(self):
        self.label = u'Third Tool'
        self.description = u''
        self.canRunInBackground = False
        self.category = "Export\\TopoJSON"

    def getParameterInfo(self):
        return

    def execute(self, parameters, messages):
        pass