将工具箱保存到版本 (数据管理)

摘要

分析和保存工具箱,以便与 ArcGIS 软件的特定版本配合使用。

分析程序将检查已安装的 ArcGIS Pro 版本和指定目标版本之间的各种地理处理工具兼容性问题。 有关兼容性问题的列表,请参阅分析工具箱的版本工具,因为此工具使用相同的分析程序逻辑。

了解有关将工具箱保存到先前版本的详细信息

此工具分析程序将报告基于 模型构建器Python 的工具的兼容性问题(仅适用于 Python 文件作为工具源的脚本工具)。 以下是待执行操作的区别:

  • 模型工具 - 某些类型的兼容性问题将作为操作的一部分加以解决。
  • 脚本工具 - 不会对工具的源文件执行更改。

使用情况

  • 此工具将创建一个输出工具箱,将在其中写入结果。 不会修改原始工具箱。 建议您保留原始工具箱,以避免数据丢失。

  • 输出工具箱中的工具可能产生与原始工具箱不一致的结果。 测试输出工具箱中的工具,以验证一致性。

  • 模型中的某些功能,特别是与过滤器、域和选项列表(值下拉列表)相关的功能,将从输出工具箱中移除。 要修复此问题,将相关工具添加并重新连接到模型的工作流。

  • 对于脚本工具,工具 Python 文件的路径在输出工具箱中不会改变。 原始工具箱和输出工具箱中的脚本工具将使用相同的文件。 如果需要修改,请复制 .py 文件并更新两个脚本工具中其中一个的脚本文件属性以指向第二个 .py 文件。 此操作不适用于具有嵌入式脚本文件的脚本工具。

  • 无法通过此工具修复某些兼容性问题。 例如,目标版本中不存在的数据类型可能导致错误。 为了解决这一问题,请创建工具箱的副本,手动移除问题数据,然后使用该工具箱作为输入。

参数

标注说明数据类型
输入工具箱

将要分析并保存的输入工具箱(.tbx.atbx 文件)。 不会修改文件。

不支持将 Python 工具箱格式(.pyt 文件)作为输入。

Toolbox
目标版本

指定将用于工具箱兼容性问题分析的软件版本。

  • ArcGIS Desktop 10.6.0ArcGIS Desktop 10.6.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Desktop 10.7.0ArcGIS Desktop 10.7.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Desktop 10.8.0ArcGIS Desktop 10.8.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Desktop 10.8.2ArcGIS Desktop 10.8.2 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.2ArcGIS Pro 2.2 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.3ArcGIS Pro 2.3 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.4ArcGIS Pro 2.4 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.5ArcGIS Pro 2.5 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.6ArcGIS Pro 2.6 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.7ArcGIS Pro 2.7 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.8ArcGIS Pro 2.8 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 2.9ArcGIS Pro 2.9 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 3.0ArcGIS Pro 3.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 3.1ArcGIS Pro 3.1 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • ArcGIS Pro 3.2ArcGIS Pro 3.2 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
String
输出工具箱

为了与指定的目标版本参数值对应的 ArcGIS 软件配合使用而创建的工具箱。

Toolbox
工具缺失时出错
(可选)

指定如果遇到目标版本中不存在的工具,是否将生成错误。

  • 选中 - 将生成错误,并且不会创建输出工具箱。 这是默认设置。
  • 未选中 - 将生成警告消息并创建输出工具箱。 对于模型工具,问题工具将从模型中移除,这需要手动编辑。
Boolean
必填参数缺失时出错
(可选)

指定如果遇到目标版本中不存在的参数并且该参数的值不是其默认值,是否将生成错误。

  • 选中 - 将生成错误,并且不会创建输出工具箱。 这是默认设置。
  • 未选中 - 将生成警告消息,从模型中移除该参数,并创建输出工具箱。
Boolean
参数值无效时出错
(可选)

指定如果遇到目标版本的参数过滤器中不存在的参数值,是否将生成错误。

  • 选中 - 将生成错误,并且不会创建输出工具箱。 这是默认设置。
  • 未选中 - 将生成警告消息并创建输出工具箱。 如果输出工具箱具有不在域范围内或无效的值,则会生成错误。
Boolean

arcpy.management.SaveToolboxToVersion(in_toolbox, version, out_toolbox, {missing_tool}, {missing_param}, {invalid_param_value})
名称说明数据类型
in_toolbox

将要分析并保存的输入工具箱(.tbx.atbx 文件)。 不会修改文件。

不支持将 Python 工具箱格式(.pyt 文件)作为输入。

Toolbox
version

指定将用于工具箱兼容性问题分析的软件版本。

  • 10.6.0ArcGIS Desktop 10.6.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 10.7.0ArcGIS Desktop 10.7.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 10.8.0ArcGIS Desktop 10.8.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 10.8.2ArcGIS Desktop 10.8.2 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.2ArcGIS Pro 2.2 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.3ArcGIS Pro 2.3 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.4ArcGIS Pro 2.4 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.5ArcGIS Pro 2.5 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.6ArcGIS Pro 2.6 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.7ArcGIS Pro 2.7 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.8ArcGIS Pro 2.8 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 2.9ArcGIS Pro 2.9 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 3.0ArcGIS Pro 3.0 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 3.1ArcGIS Pro 3.1 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
  • 3.2ArcGIS Pro 3.2 将用于工具箱兼容性问题分析。 输出工具箱将保存到此版本。
String
out_toolbox

为了与指定的 version 参数值对应的 ArcGIS 软件配合使用而创建的工具箱。

Toolbox
missing_tool
(可选)

指定如果遇到目标版本中不存在的工具,是否将生成错误。

  • ERROR_ON_MISSING_TOOL将生成错误,并且不会创建输出工具箱。 这是默认设置。
  • WARN_ON_MISSING_TOOL将生成警告消息并创建输出工具箱。 对于模型工具,问题工具将从模型中移除,这需要手动编辑。
Boolean
missing_param
(可选)

指定如果遇到目标版本中不存在的参数并且该参数的值不是其默认值,是否将生成错误。

  • ERROR_ON_MISSING_REQUIRED_PARAM将生成错误,并且不会创建输出工具箱。 这是默认设置。
  • WARN_ON_MISSING_REQUIRED_PARAM将生成警告消息,从模型中移除该参数,并创建输出工具箱。
Boolean
invalid_param_value
(可选)

指定如果遇到目标版本的参数过滤器中不存在的参数值,是否将生成错误。

  • ERROR_ON_INVALID_PARAM_VALUE将生成错误,并且不会创建输出工具箱。 这是默认设置。
  • WARN_ON_INVALID_PARAM_VALUE将生成警告消息并创建输出工具箱。 输出工具箱将生成错误,内容为值不在域范围内或无效。
Boolean

代码示例

SaveToolboxToVersion 示例 1(Python 窗口)

以下 Python 窗口脚本演示了如何在即时模式下使用 SaveToolboxToVersion 函数。

import arcpy
arcpy.management.SaveToolboxToVersion(r"C:\toolboxes\MyTools.atbx", "2.7", "C:\toolboxes\MyTools_27.tbx")

环境

此工具不使用任何地理处理环境。

许可信息

  • Basic: 是
  • Standard: 是
  • Advanced: 是

相关主题