ImportToolbox

サマリ

Imports the specified toolbox into ArcPy, allowing for access to the toolbox's associated tools.

説明

While any of the core ArcGIS toolboxes are accessible by default in a script, your own custom or third-party toolboxes must be added using ImportToolbox to use them in a script.

Other toolboxes may be found in any number of different folders or geodatabases, and may have many different origins; they may be toolboxes you have personally created, or are toolboxes created internally by your organization, or are toolboxes you have downloaded from sites like the Geoprocessing Resource Center. In any case, these toolboxes need to be imported into ArcPy in a one-step process before they can be used as tools in Python.

構文

ImportToolbox (input_file, {module_name})

パラメータ	説明	データ タイプ
input_file	The geoprocessing toolbox to be added to the arcpy site-package.	String
module_name	If the toolbox does not have an alias, the module_name is required. ヒント: The best practice is to assign an alias when first creating the toolbox rather than using ImportToolbox to assign a temporary one that will only be applicable in Python.	String

コードのサンプル

ImportToolbox example

Import geoprocessing toolbox for use in 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:
    print arcpy.GetMessages(2)