在ArcGIS中创建Python工具及脚本使用

ArcGIS Desktop 自带有大量的工具，可以执行各种各样的地理处理任务。通过 Python 我们可以灵活地调用这些工具，把工具组织成自己的工作流，甚至创建一些新的工具。今天就说说在 ArcGIS 中创建 python工具这个话题。

在 ArcGIS 中我们可以通过两种方式来创建python工具：

一种是在标准工具箱下创建 脚本工具:

一种是创建 脚本工具箱：

到这里，可能你会有和我一样的疑问，二者有什么 区别？

第一种脚本工具需要我们首先在 ArcGIS 环境中创建一个工具箱，然后添加 Python脚本文件（*.py），并通过向导来精确配置参数。这种工具很适合脚本工具的初学者，通过前面说的三步就可以搭建出一个自定义工具。但是这种模式也有一些缺点，工具箱和源脚本是分离的，我们很难集中的去管理和维护它们。

相比于前者的难以集中管理的缺点，第二种的Python工具箱就体现出了它的优势。在 Python 工具箱中，参数定义、代码验证和源代码都在同一位置进行处理，因此Python 工具的创建和维护更加容易。此外，Python 工具箱支持脚本工具不支持的功能，例如值表、复合数据类型和自定义许可检查。

Python 工具箱是在 ArcGIS 10.1 之后的版本出现的。如果你熟悉 Python，就可以充分利用所掌握的 Python 技能来创建 Python 工具箱。

下面是一些更加具体的对比列表：

	自定义工具箱	Python 工具箱
组织	自定义工具箱中的脚本工具被组织成以下三个部分： 通过向导定义的工具和参数定义。 对参数行为提供额外控制的可选验证代码，其位于工具箱中。 在单独的文件中为每个工具维护的源代码，通常作为 Python 脚本 (.py)。	Python 工具箱是一个具有 .pyt 扩展名的 Python 脚本，其包含工具箱及其工具的所有方面：参数、验证和执行。通过以下 Python 类实现：一个类用于工具箱，一个类用于各工具。
编辑	可在任何编辑器中编辑源代码。 通过脚本工具向导编辑参数。 如果使用了验证代码，可在编辑器中通过向导编辑验证代码。	可在任何编辑器中编辑 Python 工具箱文件 (.pyt)，而且可在同一位置编辑工具的所有部分（参数定义、验证代码和源代码）。 由于只能在编辑器中编辑 Python 工具箱，它们不支持在工具箱内或工具箱之间进行复制/粘贴。
使用其他工具	自定义工具箱支持各种工具类型，包括 Python 脚本工具、模型工具和内置工具（使用 ArcObjects 和 .NET 等编译型语言构建）。	Python 工具箱不直接支持其他工具类型；即，无法将模型工具或内置工具添加到 Python 工具箱中。但是，可在 Python 工具箱代码中调用其他工具箱的工具。
附加功能	n/a	Python 工具箱支持 isLicensed 方法，您可以根据设定的条件来控制工具的打开。
附加安全性	自定义工具箱中的脚本工具可以将其源代码嵌入工具箱中并使用密码锁定。	n/a

ArcGIS Help 中脚本工具的帮助过于枯燥，在这里，我以一个具体的实例来总结构建脚本工具的过程，我要实现的需求是做个快速实现羽化边界效果的小工具，预期得到如下的效果：

上面效果在ArcMap中完全可以手工运行几个工具实现，但是过程稍微繁琐，那么需求来了，如何做个自定的一键生成羽化边界的小工具？

1 准备Python脚本文件

第一步，先写好脚本工具的核心 —— python脚本文件。

脚本中我希望根据指定环间距自动生成一个9环的缓冲面，然后添加一个字段，用于存储给各个缓冲面的透明度百分比。

看下图就知道我想做什么了：

写一个py文件，将要用到的工具串联起来实现自己的需求，大致是下面的样子。这不是最终要做成脚本工具的版本，只是为了预先了解要如何实现，后面还要修改。

1. __author__ = 'kikita'
2. # FileName: EasyFeathering.py
3. import arcpy
4. # arcpy.env.workspace = "D:\something\Data.gdb"
5. # Script Tool Parameters
6. InputFeature = "InterestArea"
7. OutputFeature = "OutFeathering"
8. SingleRingWidth = 10000
9. # Some Predefined Parameters
10. distances = []
11. level = 9
12. bufferUnit = "meters"
13. NewField = "Percent"
14. # My Easy Feathering function
15. for i in range(level):
16. distances.append(SingleRingWidth*(i+1))
17. i = i+1
18. print  str(distances)
19. print  "Distance Complete!"
20. arcpy.MultipleRingBuffer_analysis(InputFeature, OutputFeature, distances, bufferUnit, "", "ALL","OUTSIDE_ONLY")
21. print  "Success to execute Multi Ring Buffer."
22. arcpy.AddField_management(OutputFeature,NewField,"double")
23. print "Success to add Transparency Percent Field."
24. arcpy.CalculateField_management(OutputFeature, NewField, "!OBJECTID! *10", "PYTHON", "")
25. print "Success to Calculate Transparency Percent Field."

<左右滑动查看更多代码>

2 脚本工具参数配置

有了py文件之后，如何把它塞进工具箱里呢？

在ArcMap的Catalog窗口中，找一个自己喜欢的任意文件夹，新建一个Toolbox，然后右键 Add –> Script，进入向导，这些操作如果不了解，可以点这里 查查帮助，照着做即可，不赘述。

这里我主要说说参数传递。

我希望做好的工具中，我只去指定三个参数，分别是：输入的兴趣区域面（input Feature ），多环缓冲的环间距（Single Ring width ），输出结果（output Feature ）。预览下工具界面：

那么问题又来了，这三个参数如何从工具界面传给真正执行工具的 python 脚本？我们需要对前面的脚本参数定义部分做个修改，使用 arcpy 提供的 GetParameterAsText()函数即可在工具界面和脚本之间传递参数。用下面的代码替换前面对这三个参数的替换：

1. # Script Tool Parameters
2. InputFeature = arcpy.GetParameterAsText(0)
3. SingleRingWidth = arcpy.GetParameterAsText(1)
4. OutputFeature = arcpy.GetParameterAsText(2)

对应的脚本工具参数配置：

为工具配置参数的时候，有2个原则需要遵守：

• 工具对话框中的参数顺序必须与脚本中的参数顺序一致。

• 每个脚本工具参数都有关联的数据类型。ArcGIS的地理处理不会将值发送给数据类型不正确的脚本，从这点上看，脚本工具比下一篇要说到的脚本工具箱多了一个优势，就是，在参数值发送给脚本之前会有数据类型检验。

修改Python脚本文件后，现在就运行工具，发现可以得到预期的结果：

但是有点不完美，就是在工具的运行过程中，工具给我返回的信息并不充足，我只知道 “Running Script EasyFeathering …”，而不了解工具在做什么，执行到了哪个步骤。这不是好的体验。

3 消息

工具和用户之间的所有沟通均通过消息来实现。接着上一步提出的问题，如何在工具进度窗口中传递消息给用户？

虽然在开始调试脚本的时候，如开头代码所示，我加了些 Print 语句，方便我了解自己的脚本独立执行时的状态，但是如果运行脚本工具，这些print语句是看不到的。可以使用 ArcPy中提供的有关消息的函数，AddMessage、AddWarning、AddError等向工具进度条界面发送消息。这里我做了个简单的步骤的消息性提示，以及，如果结果没有记录输出，会提示警告。

1. __author__ = 'kikita'
2. # FileName: EasyFeathering.py
3. import arcpy
4. #arcpy.env.workspace = "D:\IncidentSupport2015\something\Data.gdb"
5. # Get the input values from tool UI
6. InputFeature = arcpy.GetParameterAsText(0)
7. SingleRingWidth = arcpy.GetParameterAsText(1)
8. OutputFeature = arcpy.GetParameterAsText(2)
9. # Some Predefined Parameters
10. distances = []
11. level = 9
12. bufferUnit = "meters"
13. NewField = "Percent"
14. # My Easy Feathering function
15. for i in range(level):
16. distances.append(int(SingleRingWidth)*(i+1))
17. i = i+1
18. arcpy.AddMessage("Step1 Distance list Complete!")
19. arcpy.MultipleRingBuffer_analysis(InputFeature, OutputFeature, distances, bufferUnit, "", "ALL","OUTSIDE_ONLY")
20. arcpy.AddMessage("Step2 Success to execute Multi Ring Buffer.")
21. arcpy.AddField_management(OutputFeature,NewField,"double")
22. arcpy.AddMessage("Step3 Success to add Transparency Percent Field.")
23. arcpy.CalculateField_management(OutputFeature, NewField, "!OBJECTID! *10", "PYTHON", "")
24. InputFeatureCount = int(arcpy.GetCount_management(OutputFeature).getOutput(0))
25. if InputFeatureCount == 0:
26. arcpy.AddWarning("{0} has no features.".format(OutputFeature))
27. else:
28. arcpy.AddMessage("Step4 Success to Calculate Transparency Percent Field.")

<左右滑动查看更多代码>

这样在工具的执行过程中，我就收到了消息：

到这里，工具的功能部分就完成了。

4 显示结果图层

我进一步希望脚本工具运行之后，自动显示在当前的地图文档中，从而避免重复设置透明度的操作。

1. 为输出参数配置模板图层。

1. 在处理设置中，激活设置

这样在运行工具之后，结果即自动添加显示。

5 配置路径

如果是在本机使用脚本工具，一般我们会使用绝对路径，但是如果希望分享自己的工具给别人，就要考虑路径问题，也就是新用户运行脚本工具时，相关的脚本文件和其他用到的资源能否访问到。我的工具按照如下的结构组织：

在脚本工具的属性中，可以配置存储相对路径引用 py 文件：

PS：但是不要想太多，这个设置仅仅会将脚本文件所在位置按照相对路径存储，而不会将脚本内部的路径进行转换。

这个示例中我还需要用到一个图层文件作为模板，如果希望使用相对路径使用，就建议将符号化信息写在脚本内部，而不是在参数窗口中配置。所以，要继续修改下Python脚本文件。

在脚本文件的最后追加两行代码，我这里将获取与Python脚本文件在相同目录下的lyr文件：

1. # Layer files are located in same folder as the .py file
2. PythonFilePath = os.path.dirname(__file__)
3. params = arcpy.GetParameterInfo()
4. params[2].symbology = os.path.join(PythonFilePath, "FeatheringEffectTemplate.lyr")
5. # Pass message
6. arcpy.AddMessage("Finding Feathering Effect Template Layer ..." +"/n"+ os.path.join(PythonFilePath, "FeatheringEffectTemplate.lyr"))

OK，路径的问题就解决了。

6 帮助文档

还可以进一步为工具添加帮助文档，让更多的人了解如何使用这个工具。

在ArcCatalog 或者ArcMap的Catalog 中，在脚本工具上右键，点击 Item Description 菜单，点击 Edit 就可以对工具的帮助文档进行编辑。

这样当别人打开你的工具时，就看到帮助喽。

好啦，关于ArcGIS 中使用脚本工具的过程就说到这里。

文章转载于CSDN，作者kikita版权归原作者所有，如有侵权请告知删除

- END -