Python ArcGIS execute_notebook用法及代码示例

本文简要介绍 python 语言中 arcgis.notebook.execute_notebook 的用法。

用法:

arcgis.notebook.execute_notebook(item, *, timeout=50, update_portal_item=True, parameters=None, save_parameters=False, server_index=0, gis=None, future=False)

返回：

字典 else If future = True ，则结果是 concurrent.futures.Future 对象。调用result()获取响应

执行笔记本操作允许管理员和具有 Create and Edit Notebooks 权限的用户远程运行他们拥有的笔记本。操作中指定的笔记本将按顺序运行所有单元。

使用此操作，您可以安排笔记本的执行一次或定期执行。这使您可以自动执行重复任务，例如数据收集和清理、内容更新和门户管理。在Linux机器上，使用cron作业来安排executeNotebook操作；在 Windows 计算机上，您可以使用任务计划程序应用程序。

注意：

要在 ArcGIS Enterprise 中运行此操作，您必须使用 Enterprise 帐户登录。您无法使用 ArcGIS Notebook Server 主站点管理员帐户执行笔记本。

注意：

ArcGIS Online 有附加参数，如下参数表所示。

您可以指定执行时要在笔记本中使用的参数。如果您指定了一个或多个参数，它们将作为新单元格插入到笔记本中。该单元格将放置在笔记本的开头，除非您已将标签参数添加到单元格中。

Parameter	Description
item	必需 Item 。打开现有的门户项目。
update_portal_item	可选布尔值。指定是否要在执行后更新笔记本的门户项目。默认为 true。当您正在执行的笔记本包含需要更新的信息(例如收集最新版本的数据集的工作流)时，您可能需要指定 true。如果笔记本在执行后不会存储任何新信息，例如通过电子邮件向不活动用户发送提醒的管理笔记本，则更新门户项目可能并不重要。
parameters	可选列表。要添加到笔记本以执行此执行的可选参数数组。这些参数将作为新单元格直接插入到您标记为 parameters 的单元格之后。用逗号分隔参数。使用数字定义参数时使用格式“x”:1，使用文本字符串定义参数时使用格式“y”:”text”。
save_parameters	可选布尔值。指定笔记本参数单元是否应保存在笔记本中以供将来使用。默认为 false。
timeout	可选的国际。超时前运行实例的分钟数。这仅适用于ArcGIS 在线。
future	可选布尔值。如果为 True，将返回一个 Job 对象，并且进程不会等待任务完成。默认为False，表示等待结果。

例子：

#Usage example

>>> from arcgis.gis import GIS
>>> from arcgis.notebook import execute_notebook

>>> gis = GIS(profile="your_org_profile")

>>> nb_item = gis.content.get("ac7b7792913b4b3c9b22da4e2c42f986")
>>> execute_notebook(nb_item)