Обзор функций 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 / Портала

Функция	Описание
ClearCredentials	Удаляет учетную информацию ArcGIS Server с клиентского компьютера, чтобы запретить доступ к защищенным сервисам.
GetActivePortalURL	Возвращает URL-адрес активного портала.
GetPortalDescription	Возвращает словарь информации портала.
GetPortalInfo	Возвращает словарь, содержащий информацию о доступных порталах.
GetSigninToken	Возвращает информацию токена при входе на ArcGIS.com или на локальный портал.
ImportCredentials	Импортирует учетные записи из файла подключения к ГИС серверу для защищенных сервисов ArcGIS Server без токенов.
ListPortalURLs	Возвращает список доступных URL портала.
SignInToPortal	Позволяет выполнять вход на портал.

Функции курсоров

Функция	Описание
InsertCursor	Вставляет строку атрибутивных значений в указанный класс объектов или в таблицу.
SearchCursor	Возвращает строки значений атрибутов из класса объектов или таблицы.
UpdateCursor	Обновляет или удаляет строки атрибутивных значений в указанном классе объектов или таблице.

Функции хранилища данных

Функция	Описание
AddDataStoreItem	Выполняет регистрацию папки или базы данных на сайте ArcGIS Server.
ListDataStoreItems	Возвращает список папок или баз данных, зарегистрированных на сайте ArcGIS Server.
RemoveDataStoreItem	Отменяет регистрацию папки или базы данных на сайте ArcGIS Server.
ValidateDataStoreItem	Проверяет, была ли папка или база данных успешно зарегистрирована на сайтеArcGIS Server.

Функции описания данных

Функция
Describe	Описывает элемент данных и возвращает объект Describe с несколькими свойствами, например, тип данных, поля, индексы и многие другие. Свойства объекта являются динамическими, то есть в зависимости от описываемого типа данных доступны для использования различные свойства описания.

Функции среды

Функция	Описание
ClearEnvironment	Восстанавливает специфические параметры среды в значения по умолчанию.
GetSystemEnvironment	Получает указанное значение переменной системного окружения, например, "TEMP".
ListEnvironments	Возвращает список имен параметров среды геообработки.
ResetEnvironments	Возвращает для всех настроек параметров среды значения по умолчанию.

Функции полей

Функция	Описание
AddFieldDelimiters	Добавляет разделители к имени поля для использования в SQL-выражениях.
ParseFieldName	Производит разбор полного имени поля на его компоненты (имя базы данных, имя владельца, имя таблица и имя поля) в зависимости от рабочей области. ParseFieldName возвращает строку, содержащую разобранное имя таблицы и включающую имена базы данных, владельца, таблицы и полей, разделенные запятыми. Рабочая область может быть персональной, файловой или многопользовательской базой геоданных.
ValidateFieldName	Принимает строку (имя поля) и путь рабочей области и возвращает корректное имя поля, созданное с учетом ограничений на задание имен в выходной базе геоданных. Все некорректные символы входной строки заменяются символом подчеркивания (_). Ограничения на имена полей зависят от используемой базы данных (Structured Query Language [SQL] или Oracle).

Общие функции

Функция	Описание
AlterAliasName	Обновляет псевдоним для таблицы или класса пространственных объектов.
ArealUnitConversionFactor	Возвращает коэффициент для конвертации измеряемой площади в другую площадную единицу.
Command	Выполняет функции инструмента геообработки в виде одной строки.
CreateObject	Создает объекты геообработки. Могут использоваться дополнительные аргументы для определения дополнительных требований для создания объекта, например, число столбцов в объекте ValueTable.
CreateRandomValueGenerator	Создает новый генератор случайных чисел.
IsBeingEdited	Определяет, находится ли данный набор данных или рабочая область в сеансе редактирования.
LinearUnitConversionFactor	Возвращает коэффициент для конвертации измеряемого расстояния в другую линейную единицу.
ListPrinterNames	Возвращает список доступных на локальном компьютере принтеров.
Usage	Возвращает синтаксис для указанного инструмента или функции.

Общие функции работы с данными

Функция	Описание
CreateScratchName	Создает уникальное имя (scratch-имя) пути для заданного типа данных. Если рабочая область не выделена, то используется текущая рабочая область.
CreateUniqueName	Создает уникальное имя для указанной рабочей области, прибавляя число к входному имени. Число увеличивается пока имя не станет уникальным. Если рабочая область не задана, используется текущая.
Exists	Определяет существование указанного объекта данных. Эта функция проверяет наличие различных типов данных, включая классы объектов, таблицы, наборы данных, шейп-файлы, рабочие области, слои и файлы. Функция возвращает булево выражение, по которому можно определить существует ли элемент.
ParseTableName	Производит разбор имени таблицы на его компоненты (база данных, владелец, таблица) в зависимости от рабочей области. ParseTableName возвращает строку, содержащую разобранное имя таблицы и включающую имя базы данных, имя владельца и имя таблицы, разделенные запятыми. Рабочая область может быть персональной, файловой или многопользовательской базой геоданных.
TestSchemaLock	Проверяет, если замыкание схемы может применяться для класса пространственных объектов, таблицы или набора данных объектов. Инструменты, которые производят изменение схемы, потребует, чтобы блокировка схемы была размещены на входные данные. Инструмент Добавить поле (Add Field) является примером такого инструмента. Если программа требует схемы блокировки, и не в состоянии применить ее во время выполнения, возвращается соответствующее сообщение об ошибке возвращается. Скрипты, которые используют такие инструменты, должны проверять, может ли блокировка схемы быть применена на входные данные. Функция TestSchemaLock не действительно применяет блокировку схемы на входных данных, но возвратит булево выражение.
ValidateTableName	Принимает имя таблицы и путь рабочей области и возвращает корректное имя таблицы для рабочей области. Все недопустимые символы в именах таблиц будут заменены символом подчеркивания "_" в соответствии с ограничениями имен в рабочей области. Ограничения на имена таблиц зависят от используемой РСУБД.

Функции администрирования базы геоданных

Функция	Описание
AcceptConnections	Позволяет администратору включать или отключать возможность для пользователей, не обладающих правами администратора, создавать подключения к многопользовательской базе геоданных.
DisconnectUser	Позволяет администратору отключать пользователей, подключенных в данный момент к многопользовательской базе геоданных.
ListUsers	Возвращает список именованных кортежей, содержащих информацию о пользователях, подключенных в данный момент к многопользовательской базе геоданных.

Функции геометрии

Функция	Описание
AsShape	Конвертирует геометрию Esri JSON или GeoJSON в геометрию ArcPy, а наборы объектов Esri JSON в наборы объектов ArcPy. GeoJSON – это обменный формат геопространственных данных для кодирования структур географических данных.
FromCoordString	Преобразует строку обозначения системы координат в объект PointGeometry в координатах WGS84.
FromGeohash	Конвертирует строку geohash в объект Extentс координатами WGS 1984, который представляет соответствующую ограничивающую рамку в гриде geohash.
FromWKB	Создает объект геометрии на основе строки в формате WKВ, хранимой как объект bytearray или bytes.
FromWKT	Создает новый объект геометрии из строки в формате WKT.

Функции лицензирования и установки

Функция	Описание
CheckExtension	Проверяет, доступна ли для открепления лицензия для конкретного типа модуля.
CheckInExtension	Возвращает лицензию в Менеджер лицензий, чтобы другие приложения могли ее использовать.
CheckOutExtension	Выберите лицензию в менеджере лицензий.
CheckProduct	Проверяет, доступна ли требуемая лицензия.
GetInstallInfo	Возвращает словарь, содержащий информацию об установке.
ListInstallations	Возвращает список типов установки.
ProductInfo	Возвращает текущую лицензию на продукт.

Функции листинга данных

Функция	Описание
ListDatasets	Возвращает список наборов данных, найденных в текущей рабочей области. Возвращаемый список может быть ограничен с помощью критериев поиска для имени или типа набора данных.
ListFeatureClasses	Возвращает список классов пространственных объектов в текущей рабочей области, ограниченные по имени, типу объектов и дополнительно набору классов объектов.
ListFields	Возвращает список полей в классе пространственных объектов, шейп-файле или таблице в выбранном наборе данных. Возвращаемый список Python может быть ограничен с помощью критерия поиска для имени или типа поля, и будет содержать объекты полей.
ListFiles	Возвращает список файлов в текущей рабочей области.
ListIndexes	Возвращает список индексов в классе пространственных объектов, шейп-файле или таблице в указанном наборе данных.
ListRasters	Возвращает список растров в текущей рабочей области.
ListTables	Возвращает список таблиц в текущей рабочей области.
ListVersions	Перечисляет версии, использование которых разрешено подключенному пользователю.
ListWorkspaces	Возвращает список рабочих областей в текущей рабочей области.

Функции журналирования

Функция	Описание
GetLogHistory	Определяет, активно ли ведение журнала истории.
GetLogMetadata	Определяет, записываются ли операции геообработки в метаданные набора данных.
SetLogHistory	Управляет тем, записывается ли информация о выполнении инструментов геообработки во внешний файл журнала.
SetLogMetadata	Определяет, будут ли после запуска инструментов геообработки обновлены метаданные входного и выходного наборов данных, для включения в них имени инструмента, параметров, времени запуска и другой информации.

Функции обработки сообщений и ошибок

Функция	Описание
AddError	Добавляет сообщение об ошибке (степень важности 2) в сообщения инструмента-скрипта или инструмента из набора Python.
AddIDMessage	Используйте сообщения системного ID с помощью инструмента-скрипта.
AddMessage	Добавляет информационное сообщение (степень важности 0) в сообщения инструмента-скрипта или инструмента набора Python.
AddReturnMessage	Устанавливает возвращаемое сообщение инструмента-скрипта в виде выходного сообщения по индексу.
AddWarning	Добавляет сообщение с предупреждением (степень важности 1) в сообщения инструмента-скрипта или инструмента набора Python.
GetIDMessage	Получить строку ошибки или предупреждающее сообщение идентификатора.
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	Преобразует растр или набор данных мозаики в файл черновика определения сервиса (.sddraft).

Функции растра

Функция	Описание
GetImageEXIFProperties	Возвращает заголовок EXIF из изображения с геотегом.
NumpyArrayToRaster	Конвертирует массив NumPy в растр.
RasterToNumPyArray	Конвертирует растр в массив NumPy.
Render	Создает визуализированный растровый объект, применяя символы к указанному набору растровых данных. Эта функция применяется при отображении данных в ноутбуке Jupyter.

Функции пространственной привязки и трансформации

Функция	Описание
GenerateOptimalCoordinateSystem	Создает объект SpatialReference с пользовательской системой координат, оптимальной для определенного экстента и назначения вашей карты или анализа.
ListSpatialReferences	Возвращает список имен доступных пространственных привязок для использования в качестве аргумента в классе SpatialReference.
ListTransformations	Возвращает список корректных методов трансформации. Можно использовать экстент для сокращения списка допустимых методов трансформации для определенной географической области.

Функции инструментов и наборов инструментов

Функция	Описание
AddToolbox	Импортирует заданный набор инструментов в ArcPy, обеспечивая доступ к входящим в этот набор инструментам.
DecryptPYT	Расшифровывает зашифрованный файла набора инструментов Python.
EncryptPYT	Шифрует файл набора инструментов Python.
ImportToolbox	Импортирует набор инструментов геообработки в ArcPy, обеспечивая доступ к входящим в этот набор инструментам.
IsSynchronous	Определяет, работает ли инструмент в синхронном или асинхронном режиме. Когда инструмент работает в синхронном режиме, результаты возвращаются автоматически, но пока инструмент не закончит работу, другие действия выполнить нельзя. Все несерверные инструменты являются синхронными. Серверные инструменты могут быть асинхронными, т.е., начав выполнение инструмента на сервере, можно одновременно использовать другую функциональность, при этом результаты выполнения инструмента должны быть явным образом запрошены у сервера.
ListToolboxes	Возвращает список наборов инструментов.
ListTools	Возвращает список инструментов геообработки.
RemoveToolbox	Удаляет указанный набор инструментов, указав путь к нему или сославшись на его псевдоним. Удаляет указанный набор инструментов из текущего сеанса геообработки. Наборы инструментов сервера также можно удалить с использованием точки с запятой в качестве разделителя.