ArcPy 函数概览

ArcPy 使用 Python 提供了许多函数以更好地支持工作流。

除了本主题中列出的函数之外，所有地理处理工具都可以作为 ArcPy 函数进行访问。有关详细信息，请参阅通过 Python 使用工具。 可以在其他 ArcPy 模块中找到其他函数，包括：

• 图表模块 (arcpy.charts)
• 数据访问模块 (arcpy.da)
• 地理编码模块 (arcpy.geocoding)
• 影像分析模块 (arcpy.ia)
• 制图模块 (arcpy.mp)
• 元数据模块 (arcpy.metadata)
• Network Analyst 模块 （arcpy.nax 和 arcpy.na）
• 共享模块 (arcpy.sharing)
• Spatial Analyst 模块 (arcpy.sa)
• Workflow Manager (Classic) 模块 (arcpy.wmx)

了解有关在 Python 中使用函数的详细信息

ArcGIS Online/Portal 函数

函数	描述
ClearCredentials	ClearCredentials 函数将从客户端计算机中移除 ArcGIS Server 凭据信息以禁用安全服务的访问权限。
GetActivePortalURL	返回活动门户的 URL。
GetPortalDescription	GetPortalDescription 用于返回当前匿名或已登录用户已查看的门户视图。其中包含该门户的名称、徽标、要素项目和支持的协议（HTTP 与 HTTPS）等信息。如果用户尚未登录，该调用将返回门户的默认视图。如果用户已登录，将返回用户所属组织特定的门户视图。门户的默认视图取决于从用户的配置文件中获取的用户语种。
GetPortalInfo	GetPortalInfo 函数返回包含可用门户信息的字典。
GetSigninToken	登录到 ArcGIS.com 或本地门户时，返回令牌信息。
ImportCredentials	ImportCredentials 函数可针对 ArcGIS Server 非基于令牌的安全服务从 GIS Server 连接文件导入凭据。
ListPortalURLs	返回可用门户 URL 列表的 ListPortalURLs 函数。
SignInToPortal	SignInToPortal 函数允许您登录门户。

游标函数

函数	描述
InsertCursor	向要素类、shapefile 或表中插入行。InsertCursor 可返回一个分发 Row 对象的枚举对象。
SearchCursor	SearchCursor 函数用于在要素类或表上建立只读游标。SearchCursor 可用于遍历 Row 对象并提取字段值。可以使用 where 子句或字段限制搜索，并对结果排序。
UpdateCursor	UpdateCursor 函数可创建一个用于更新或删除指定要素类、shapefile 和表中的行的游标。该游标将数据锁定保留至脚本完成或更新游标对象被删除时。

数据存储函数

函数	描述
AddDataStoreItem	在 ArcGIS Server 站点注册文件夹或数据库。
ListDataStoreItems	返回在 ArcGIS Server 站点注册的文件夹或数据库列表。
RemoveDataStoreItem	从 ArcGIS Server 站点注销文件夹或数据库。
ValidateDataStoreItem	验证文件夹或数据库是否已成功注册至 ArcGIS Server 站点。

描述数据函数

函数
Describe	Describe 函数返回的 Describe 对象包含多个属性，如数据类型、字段、索引以及许多其他属性。该对象的属性是动态的，这意味着根据所描述的数据类型，会有不同的描述属性可供使用。

环境函数

函数	描述
ClearEnvironment	将特定环境设置重置为默认值。
GetSystemEnvironment	获取指定的系统环境变量值，例如“TEMP”。
ListEnvironments	可返回地理处理环境名称列表。
ResetEnvironments	将所有环境设置重置为默认设置。

字段函数

函数	描述
AddFieldDelimiters	在字段名称中添加字段分隔符，以便在 SQL 表达式中使用。
ParseFieldName	将全限定字段名解析为依赖工作空间的各个组成部分（数据库名称、所有者名称、表名和字段名）。ParseFieldName 将返回一个包含已解析表名的字符串，其中包含数据库名称、所有者名称、表名和字段名称（以逗号分隔）。此工作空间必须是个人地理数据库、文件地理数据库或企业级地理数据库。
ValidateFieldName	获取字符串（字段名）和工作空间路径，并基于输出地理数据库中的名称限制返回一个有效字段名。输入字符串中所有的无效字符都将替换为下划线 (_)。字段名的限制取决于所使用的特定数据库（结构化查询语言 [SQL] 或 Oracle）。

常规函数

函数	描述
AlterAliasName	更新表或要素类的别名。
Command	将地理处理工具作为单个字符串执行。
CreateObject	用于创建地理处理对象。可使用额外的参数来指定创建对象所需的附加要求，例如 ValueTable 对象中的列数。
CreateRandomValueGenerator	创建新的随机数生成器。
ListPrinterNames	返回在本地计算机中的可用打印机的列表。
Usage	返回特定工具或函数的语法。

常规数据函数

函数	描述
CreateScratchName	为指定的数据类型创建唯一的临时路径名称。如果未给定工作空间，则使用当前工作空间。
CreateUniqueName	通过在输入名称后追加数字的方式在指定工作空间中创建唯一名称。该数字会不断增大，直到名称是唯一的为止。如果未指定工作空间，则使用当前的工作空间。
Exists	确定指定数据对象是否存在。此函数可测试是否存在各种数据类型，这些数据类型包括要素类、表、数据集、shapefile、工作空间、图层和文件。函数返回指示元素是否存在的布尔值。
ParseTableName	将表名解析为依赖工作空间的各个组成部分（数据库、所有者、表）。ParseTableName 将返回一个包含已解析表名的字符串，其中的数据库名称、所有者名称和表名以逗号分隔。此工作空间必须是个人数据库、文件数据库或企业级地理数据库。
TestSchemaLock	测试是否可以为要素类、表或要素数据集获取方案锁。用于更改方案的工具要求在输入数据上放置方案锁。添加字段工具就是此类工具的示例。如果工具需要方案锁，但无法在执行时获取方案锁，则将返回相应的错误消息。使用此类工具的脚本应当测试是否可以获取输入数据的方案锁。TestSchemaLock 函数不会对输入数据真正应用方案锁，但会返回布尔值。
ValidateTableName	获取表名和工作空间路径并为该工作空间返回一个有效表名。表名中出现的任何无效字符将替换为下划线“_”,以便遵循工作空间的名称限制。表名限制取决于所使用的特定 RDBMS。

地理数据库管理函数

函数	描述
AcceptConnections	允许管理员启用或禁用非管理员用户连接到企业级地理数据库的功能。
DisconnectUser	允许管理员断开当前连接到企业级地理数据库的用户的连接。
ListUsers	返回一组指定的元组，其中包含连接到企业级地理数据库的所有用户的信息。

几何函数

函数	描述
AsShape	将 Esri JSON 或 GeoJSON 几何转换为 ArcPy 几何，并将 Esri JSON 要素集转换为 ArcPy 要素集。GeoJSON 是一种地理空间数据的交换格式，可用于对地理数据结构进行编码。
FromCoordString	将坐标系记法字符串转换为 WGS84 坐标中的 PointGeometry 对象。
FromGeohash	将 geohash 字符串转换为 WGS 1984 坐标中的 Extent 对象，该对象用于表示 geohash 格网中的相应边界框。
FromWKB	根据 bytearray 中存储的熟知二进制 (WKB) 字符串来创建新的几何对象。
FromWKT	根据熟知文本 (WKT) 字符串创建新的几何对象。

许可和安装函数

函数	描述
CheckExtension	核查是否存在可为特定类型的扩展模块检出的许可。
CheckInExtension	将许可归还给许可管理器，以便其他应用程序使用。
CheckOutExtension	通过许可管理器检索许可。
CheckProduct	检查申请的许可是否可用。
GetInstallInfo	GetInstallInfo 函数返回包含安装信息的字典。
ListInstallations	ListInstallations 函数将返回安装类型列表（server、desktop、engine、arcgispro）。
ProductInfo	返回当前产品许可。

列出数据函数

函数	描述
ListDatasets	返回当前工作空间中的数据集的列表。可针对数据集名称和数据集类型指定搜索条件，从而限制返回的列表。
ListFeatureClasses	可返回当前工作空间中受名称、要素类型和可选要素数据集限制的要素类的列表。
ListFields	可返回指定数据集中的要素类、shapefile 或表中的字段的列表。返回的列表可用针对名称和字段类型的搜索条件进行限制，并将包含字段对象。
ListFiles	返回当前工作空间中的文件列表。
ListIndexes	可返回指定数据集中的要素类、shapefile 或表中的索引的列表。
ListRasters	返回当前工作空间中的栅格列表。
ListTables	返回当前工作空间中的表格列表。
ListVersions	列出连接用户有权使用的版本。
ListWorkspaces	返回当前工作空间中的工作空间列表。

日志记录函数

函数	描述
GetLogHistory	确定历史记录是否处于活动状态。
GetLogMetadata	确定是否将地理处理操作写入数据集元数据。
SetLogHistory	控制是否将执行的地理处理工具的相关信息写入外部日志文件。
SetLogMetadata	控制是否更新地理处理工具输入和输出数据集元数据，以包括工具名称、参数、工具运行时间和其他信息。

消息和错误处理函数

函数	描述
AddError	向脚本工具或 Python 工具箱工具的消息中添加错误消息（严重性为 2）。
AddIDMessage	可以通过脚本工具使用系统消息。
AddMessage	向脚本工具或 Python 工具箱工具的消息中添加自定义信息性消息（严重性为 0）。
AddReturnMessage	按索引将脚本工具的返回消息设置为输出消息。
AddWarning	向脚本工具或 Python 工具箱工具的消息中添加自定义警告消息（严重性为 1）。
GetIDMessage	获取错误或警告 ID 消息的字符串。
GetMaxSeverity	获取从上次执行工具以来返回的最大严重性。
GetMessage	按地理处理工具消息的索引位置返回该消息。
GetMessageCount	返回从上次执行命令到现在为止返回的所有消息计数。
GetMessages	按指定的严重性级别从工具返回地理处理消息。
GetReturnCode	通过索引返回消息错误代码。
GetSeverity	按索引获取指定消息的严重性代码（0、1 和 2）。
GetSeverityLevel	返回严重性级别。严重性级别用于控制地理处理工具抛出异常的方式。
SetSeverityLevel	用于控制地理处理工具如何抛出异常。

参数函数

函数	描述
CopyParameter	按索引将指定参数复制到脚本工具中的另一个参数中。指定参数必须具有相同的数据类型。
GetArgumentCount	返回传递至脚本的参数数量。
GetParameter	在参数列表中，按所需参数的索引值选择参数。参数以对象的形式返回。
GetParameterAsText	按照参数在参数列表中的索引位置以文本字符串的形式获取指定参数。
GetParameterCount	返回指定工具的参数值计数。如果此工具包含在自定义工具箱中，请使用 ImportToolbox 访问此自定义工具。
GetParameterInfo	返回给定工具的参数对象列表，并且通常用在脚本工具的 ToolValidator 类中。
GetParameterValue	为指定工具名称返回所需参数的默认值。
SetParameter	用于使用对象按索引来设置指定参数属性。此函数用于将对象从脚本传递到脚本工具。如果您需要传递字符串，请使用 SetParameterAsText 函数。
SetParameterAsText	按照参数在参数列表中的索引位置以文本字符串的形式获取指定参数。
SetParameterSymbology	用于设置脚本工具的指定输出参数的符号系统属性。

进度对话框函数

函数	描述
ResetProgressor	将进度条重置为初始状态。
SetProgressor	建立进度条对象以支持要在地理处理窗格中显示的进度信息。可通过选择默认进度条或步长进度条来控制进度对话框的外观。
SetProgressorLabel	在地理处理窗格中更新进度条标注。
SetProgressorPosition	在地理处理窗格中更新进度条状态栏。

发布函数

函数	描述
CreateGeocodeSDDraft	此函数用于将定位器转换为服务定义草稿 (.sddraft) 文件，以供创建用于发布地理编码服务的服务定义。
CreateGPSDDraft	该函数将 Result 对象和结果文件 (.rlt) 转换为服务定义草稿 (.sddraft) 文件。
CreateImageSDDraft	CreateImageSDDraft 函数是使用 ArcPy 自动发布镶嵌数据集或栅格数据集作为“影像服务”的第一步。基于 CreateImageSDDraft 创建的输出是服务定义草稿 (.sddraft) 文件，该文件由栅格数据集或地理数据库中的镶嵌数据集、服务器信息以及一组服务属性组合而成。该服务定义草稿可作为服务定义过渡，然后作为影像服务上传至指定的 ArcGIS 服务器。

栅格函数

函数	描述
GetImageEXIFProperties	用于从经地理标记的图像返回 EXIF 头信息。
NumpyArrayToRaster	将 NumPy 数组转换为栅格。
RasterToNumPyArray	将栅格转换为 NumPy 数组。

空间参考和转换函数

函数	描述
GenerateOptimalCoordinateSystem	生成一个具有自定义投影坐标系的 SpatialReference 对象，该坐标系最适用于地图或分析的指定范围和预期目的。
ListSpatialReferences	返回可用空间参考名称的列表，用作 SpatialReference 类的参数。
ListTransformations	返回有效变换方法列表。对于某个特定的地理区域，可以使用区域范围来缩小有效变换方法列表的范围。

工具和工具箱函数

函数	描述
AddToolbox	将指定的工具箱导入到 ArcPy 中，以便访问工具箱中的相关工具。
DecryptPYT	对加密的 Python 工具箱文件进行解密。
EncryptPYT	加密 Python 工具箱文件。
ImportToolbox	将指定的工具箱导入到 ArcPy 中，以便访问工具箱中的相关工具。
IsSynchronous	确定工具是同步运行还是异步运行。当工具为同步运行时，会自动返回结果，但在完成同步之前不能执行任何其他操作。所有非服务器工具都是同步运行的。服务器工具可以是异步运行的，即向服务器提交某个工具后，无需等待即可使用其他功能，但必须向服务器明确请求结果。
ListToolboxes	返回工具箱列表。
ListTools	返回地理处理工具列表。
RemoveToolbox	通过指定路径或引用别名来移除指定的工具箱。从当前地理处理会话中移除指定工具箱。还可使用分号分隔符移除服务器工具箱。