在 Python 工具箱中定义工具

工具作为类添加至 .pyt 中。每个工具类应至少包括 __init__ 和 execute 方法。或者，可以使用 getParameterInfo、isLicensed、updateParameters 和 updateMessages 方法向工具的行为中添加其他控制。

用于定义工作工具类的方法

工具方法	必填/可选	说明
__init__	必填	初始化工具类。
getParameterInfo	可选	定义工具的参数。
isLicensed	可选	返回该工具是否获得执行许可。
updateParameters	可选	在用户每次在工具对话框中更改参数时调用。从 updateParameters 返回后，地理处理将调用它的内部验证例程。
updateMessages	可选	在从内部验证例程返回后调用。您可以检查在内部验证过程中创建的消息并根据需要进行更改。
执行	必填	工具的源代码。

设置工具类的 __init__ 方法

工具类中的 __init__ 方法是标准 Python 类初始化方法。对于 Python 工具箱中的工具，__init__ 方法用于设置该工具的属性，这些属性包括工具的 label 和 description。工具的名称由类的名称确立（在下例中，工具的名称为 CalculateSinuosity）。

__init__ 方法建立工具属性，例如 label 和 description。以下示例中，创建了名为 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."

注：

Python 语法规则将在命名 Python 工具箱的工具类时强制执行大多数地理处理约定。此外，还要避免在工具类名称中使用下划线，因为它们会在运行 ArcGIS Server 中的工具时发生错误。

可在工具的 __init__ 方法中设置以下属性。

属性	说明
canRunInBackground	注： canRunInBackground 属性仅用于 ArcGIS Desktop 中；该属性对 ArcGIS Pro 没有影响。
category	工具所在工具集的名称。工具集是在工具箱内组织工具的一种方式。
description	工具的描述。
label	标注是工具的显示名称，如地理处理窗格中所示。
stylesheet	更改用于工具的默认样式表。如果未设置，则使用默认样式表。