ArcGIS Desktop

  • ArcGIS Pro
  • ArcMap

  • My Profile
  • 帮助
  • Sign Out
ArcGIS Desktop

ArcGIS Online

专为贵组织打造的制图平台

ArcGIS Desktop

全面的专业性 GIS

ArcGIS Enterprise

面向企业的 GIS

ArcGIS for Developers

用于构建位置感知应用程序的工具

ArcGIS Solutions

适用于行业的免费模板地图和应用程序

ArcGIS Marketplace

获取适用于组织的应用程序和数据

  • 文档
  • 支持
Esri
  • 登录
user
  • 我的个人资料
  • 登出

帮助

  • 主页
  • 入门
  • 制图
  • 分析
  • 管理数据
  • 工具
  • 更多...

ImportToolbox

  • 摘要
  • 说明
  • 语法
  • 代码示例

摘要

将指定的工具箱导入到 ArcPy 中,以便访问工具箱中的相关工具。

说明

默认情况下,可在脚本中访问任何核心 ArcGIS 工具箱,但对于自定义工具箱或第三方工具箱,必须使用 ImportToolbox 来添加它们以便在脚本中使用。

可在多个不同的文件夹或地理数据库中找到其他工具箱,这些工具箱的来源可能各不相同;它们可能是您个人创建的工具箱,或者是您所在组织内部创建的工具箱,也可能是从“地理处理资源中心”等站点下载的工具箱。在任何情况下,将这些工具箱用作 Python 中的工具之前,需要将其一步导入到 ArcPy 中。

还可使用分号分隔符添加服务器工具箱。

Server语法

Internet ArcGIS for Server

URL;服务名称;{用户名};{密码}

了解有关在 Python 中使用地理处理服务的详细信息

ImportToolbox 还支持通过使用 ArcGIS Server 连接 (.ags) 文件来使用受保护的 ArcGIS Online 服务。使用 .ags 文件可将凭据存储并隐藏在文件中。

import arcpy
arcpy.ImportToolbox('c:/logistics/logistics.ags;World/ServiceAreas')
arcpy.GenerateServiceAreas_ServiceAreas()

要允许任何 arcgis.com 用户访问您的工具,请使用 UseSSOIdentityIfPortalOwned 关键字。如未登录,执行 ImportToolbox 时,系统将提示登录 对话框;如已登录,可成功执行此操作。

import arcpy
tbx = "http://logistics.arcgis.com/arcgis/services;World/ServiceAreas;UseSSOIdentityIfPortalOwned"
arcpy.ImportToolbox(tbx)
arcpy.GenerateServiceAreas_ServiceAreas()
注:

将使用登录对话框运行独立 Python 文件。

如果先前已获取令牌,则该令牌也可与 ImportToolbox 组合使用。

import arcpy

token = 'sadsa213d2j32jsdw02dm2'
referrer = 'http://www.arcgis.com/'
tbx = 'http://logistics.arcgis.com/arcgis/services;' + \
      'World/ServiceAreas;token={};{}'.format(token, referrer)
arcpy.ImportToolbox(tbx)
result = arcpy.GenerateServiceAreas_ServiceAreas()

语法

ImportToolbox (input_file, {module_name})
参数说明数据类型
input_file

The geoprocessing toolbox added to the ArcPy site package.

String
module_name

If the toolbox does not have an alias, the module_name is required.

When a tool is accessed through the ArcPy site package, the toolbox alias where the tool is contained is a required suffix (arcpy.<toolname>_<alias>). Since ArcPy depends on toolbox aliases to access and execute the correct tool, aliases are extremely important when importing custom toolboxes. A good practice is to always define a custom toolbox's alias; however, if the toolbox alias is not defined, a temporary alias can be set as the second parameter.

String

返回值

数据类型说明
Module

返回导入的模块。

如果需要,可从模块的 __all__ 属性访问工具名称。

代码示例

ImportToolbox 示例

导入地理处理工具箱以在 ArcPy 中使用。

import arcpy

# Import custom toolbox
arcpy.ImportToolbox("c:/tools/My_Analysis_Tools.tbx")

try:
    # Run tool in the custom toolbox.  The tool is identified by
    #  the tool name and the toolbox alias.
    arcpy.GetPoints_myanalysis("c:/data/forest.shp")
except arcpy.ExecuteError:
    print(arcpy.GetMessages(2))

相关主题

  • CreateGISServerConnectionFile
  • 通过 Python 使用工具
  • 使用 Python 添加工具箱

ArcGIS Desktop

  • 主页
  • 文档
  • 支持

ArcGIS 平台

  • ArcGIS Online
  • ArcGIS Desktop
  • ArcGIS Enterprise
  • ArcGIS for Developers
  • ArcGIS Solutions
  • ArcGIS Marketplace

关于 Esri

  • 关于我们
  • 招贤纳士
  • Esri 博客
  • 用户大会
  • 开发者峰会
Esri
分享您的想法。
Copyright © 2019 Esri. | 隐私政策 | 法律声明