Definir una herramienta en una caja de herramientas Python

Las herramientas se agregan a .pyt como clases. Cada clase de herramienta debe incluir, como mínimo, un método __init__ y ejecutar. Como opción, los métodos getParameterInfo, isLicensed, updateParameters y updateMessages se pueden usar para agregar control adicional al comportamiento de la herramienta.

Métodos utilizados para definir una clase de herramienta funcional

Método de herramienta	Requerido/opcional	Descripción
__init__	Requerido	Inicia la clase de herramienta.
getParameterInfo	Opcional	Define los parámetros de la herramienta
isLicensed	Opcional	Informa si la herramienta tiene licencia para ejecutarse.
updateParameters	Opcional	Se invoca cada vez que el usuario modifica un parámetro en el cuadro de diálogo de la herramienta. Después de volver de updateParameters, el geoprocesamiento invoca su rutina de validación interna.
updateMessages	Opcional	Se invoca después de volver de la rutina de validación interna. Puede examinar los mensajes creados desde la validación interna y modificarlos si lo desea.
ejecutar	Requerido	El código de origen de la herramienta.

Configurar __init__ de la clase de herramientas

El método __init__ en una clase de herramientas es un método de inicialización de clase Python estándar. Para una herramienta en la caja de herramientas Python, el método __init__ se utiliza para configurar las propiedades de la herramienta, incluyendo la etiqueta y descripción de la herramienta. El nombre de la herramienta se establece por medio de la clase en sí (en el ejemplo a continuación, el nombre de la herramienta es CalculateSinuosity).

El método __init__ establece propiedades de la herramienta como la etiqueta y descripción. A continuación, se crea una herramienta denominada CalculateSinuosity.

class CalculateSinuosity(object):     def __init__(self):         self.label = "Calculate Sinuosity"         self.description = "Sinuosity measures the amount that a river meanders within its valley, " + \                            "calculated by dividing total stream length by valley length."

Las siguientes propiedades se pueden establecer en el método __init__ de una herramienta.

Propiedad	Descripción
canRunInBackground	Si canRunInBackground no está establecido en Verdadero, la herramienta respetará la configuración actual Procesamiento en segundo plano en el cuadro de diálogo Opciones de geoprocesamiento. Si se establece en Falso, la herramienta siempre se ejecuta en primer plano, invalidando la configuración Procesamiento en segundo plano en cuadro de diálogo Opciones de geoprocesamiento. Obtenga más información acerca de cómo ejecutar herramientas personalizadas en segundo plano.
categoría	El nombre del conjunto de herramientas en el que se encuentra la herramienta. Un conjunto de herramientas es una forma de organizar herramientas dentro de una caja de herramientas.
descripción	La descripción de la herramienta.
etiqueta	La etiqueta es el nombre de visualización para la herramienta como se muestra en la ventana Catálogo.
hoja de estilo	Para cambiar la hoja de estilo predeterminada utilizada para la herramienta. Si no está establecido, se utiliza la hoja de estilo predeterminada.