什么是 Python 工具箱？—帮助

创建 Python 工具箱
Python 工具箱示例

Python 工具箱是完全用 Python 语言创建的地理处理工具箱。Python 工具箱及其所包含工具的外观、操作和运行方式与任何以其他方式创建的工具箱和工具相类似。Python 工具箱 (.pyt) 只是一个基于 ASCII 的文件，该文件定义了工具箱和一个或多个工具。

创建后，Python 工具箱中的工具具备以下优势：

通过创建 Python 工具箱，您可以利用您的 Python 知识来快速构建原型并创建功能完备的地理处理工具。
您所创建的工具会像系统工具一样成为地理处理的组成部分，您可以从搜索或目录窗口中打开它，可在模型构建器和 Python 窗口中使用它，还可以从脚本中调用它。
您可以将消息写入结果窗口和进度对话框。
使用内置的文档工具，可以创建文档。
将脚本作为脚本工具运行时，arcpy 完全知道从哪个应用程序（如 ArcMap）调用该脚本。在应用程序中所做的设置（如 arcpy.env.overwriteOutput 和 arcpy.env.scratchWorkspace）都可从脚本工具中的 ArcPy 中获得。

创建 Python 工具箱

右键单击要在其中创建新工具箱的文件夹，然后单击新建 > Python 工具箱，即可创建 Python 工具箱。

最初，Python 工具箱包含一个名为 Toolbox 的 Python 类（用于定义工具箱的特征），以及另一个名为 Tool 的 Python 类（提供无存根的地理处理工具）。

入门

入门	创建新 Python 工具箱编辑 Python 工具箱
定义工具	定义工具
定义工具的参数	定义 Python 工具箱中的参数在 Python 工具箱中定义参数数据类型
自定义工具行为	自定义 Python 工具箱中的工具的行为更新 Python 工具箱中的方案控制 Python 工具箱中的许可行为
编写工具的“源代码”	访问 Python 工具箱中的参数在 Python 工具箱中写入消息
记录工具	对 Python 工具箱中的工具编写文档

Python 工具箱示例

以下是包含一个工具的 Python 工具箱的实际示例。名为 CalculateSinuosity 的工具添加一个字段并计算要素的曲折度，曲折度用于衡量直线的弯曲程度。

import arcpy

class Toolbox(object):
    def __init__(self):
        self.label =  "Sinuosity toolbox"
        self.alias  = "sinuosity"

        # List of tool classes associated with this toolbox
        self.tools = [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."

    def getParameterInfo(self):
        #Define parameter definitions

        # Input Features parameter
        in_features = arcpy.Parameter(
            displayName="Input Features",
            name="in_features",
            datatype="GPFeatureLayer",
            parameterType="Required",
            direction="Input")
        
        in_features.filter.list = ["Polyline"]

        # Sinuosity Field parameter
        sinuosity_field = arcpy.Parameter(
            displayName="Sinuosity Field",
            name="sinuosity_field",
            datatype="Field",
            parameterType="Optional",
            direction="Input")
        
        sinuosity_field.value = "sinuosity"
        
        # Derived Output Features parameter
        out_features = arcpy.Parameter(
            displayName="Output Features",
            name="out_features",
            datatype="GPFeatureLayer",
            parameterType="Derived",
            direction="Output")
        
        out_features.parameterDependencies = [in_features.name]
        out_features.schema.clone = True

        parameters = [in_features, sinuosity_field, out_features]
        
        return parameters

    def isLicensed(self): #optional
        return True

    def updateParameters(self, parameters): #optional
        if parameters[0].altered:
            parameters[1].value = arcpy.ValidateFieldName(parameters[1].value,
                                                          parameters[0].value)
        return

    def updateMessages(self, parameters): #optional
        return

    def execute(self, parameters, messages):
        inFeatures  = parameters[0].valueAsText
        fieldName   = parameters[1].valueAsText
        
        if fieldName in ["#", "", None]:
            fieldName = "sinuosity"

        arcpy.AddField_management(inFeatures, fieldName, 'DOUBLE')

        expression = '''
import math
def getSinuosity(shape):
    length = shape.length
    d = math.sqrt((shape.firstPoint.X - shape.lastPoint.X) ** 2 +
                  (shape.firstPoint.Y - shape.lastPoint.Y) ** 2)
    return d/length
'''

        arcpy.CalculateField_management(inFeatures,
                                        fieldName,
                                        'getSinuosity(!shape!)',
                                        'PYTHON_9.3',
                                        expression)

创建 Python 工具箱

入门

Python 工具箱示例

相关主题