Обзор функций 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)
Инженерная сеть (arcpy.un)

Дополнительные сведения об использовании функций в Python

Функции ArcGIS Online / Портал


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

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


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

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


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

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


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

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


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

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


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

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


Функция	Описание
`AIOFileOpen`	Открывает локальный или облачный дескриптор файла, поддерживающий протокол контекстного управления.
`AlterAliasName`	Обновляет название псевдонима таблицы и класса пространственных объектов.
`ArealUnitConversionFactor`	Возвращает коэффициент для конвертации измеряемой площади в другую площадную единицу.
`Command`	Запускает одной строкой инструмент геообработки.
`CreateObject`	Создает объект геообработки. Дополнительные аргументы могут быть использованы для указания дополнительных требований к созданию объекта, таких как количество столбцов в объекте `ValueTable`.
`CreateRandomValueGenerator`	Функция `CreateRandomValueGenerator` создает генератор случайных чисел.
`GetSTACInfo`	Извлекает информацию из URL-адреса SpatioTemporal Asset Catalog (STAC).
`IsBeingEdited`	Определяет, находится ли данный набор данных или рабочая область в сеансе редактирования.
`LinearUnitConversionFactor`	Возвращает коэффициент для конвертации измеряемого расстояния в другую линейную единицу.
`ListPrinterNames`	Возвращает список доступных принтеров на локальном компьютере.
`RefreshLayer`	Обновляет виды карты, содержащие указанные слои.
`Usage`	Возвращает синтаксис для указанного инструмента или функции.

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


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

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


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

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


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

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


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

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


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

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


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

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


Функция	Описание
`AddError`	Добавляет сообщение об ошибке (степень важности 2) в сообщения инструмента-скрипта или инструмента из набора Python.
`AddIDMessage`	Используйте сообщения системного ID с помощью инструмента-скрипта.
`AddMessage`	Функция `AddMessage` добавляет информационное сообщение (степень важности 0) в сообщения инструмента-скрипта или инструмента набора Python.
`AddReturnMessage`	Устанавливает возвращаемое сообщение инструмента скрипта в качестве выходного сообщения по индексу.
`AddWarning`	Добавляет сообщение с предупреждением (степень важности 1) в сообщения инструмента-скрипта или инструмента набора Python.
`GetAllMessages`	Возвращает типы сообщений, коды возврата и строки сообщений последнего запуска инструмента.
`GetIDMessage`	Функция `GetIDMessage` получает строку сообщения с идентификатором ошибки или предупреждения.
`GetMaxSeverity`	Получает максимально важные сообщения, возвращаемые последним запущенным инструментом.
`GetMessage`	Возвращает сообщение инструмента геообработки по позиции индекса.
`GetMessageCount`	Возвращает количество всех возвращенных сообщений от ранее запущенного инструмента.
`GetMessages`	Возвращает сообщения геообработки от инструмента по указанной степени серьезности.
`GetReturnCode`	Возвращает код ошибки для сообщения геообработки.
`GetSeverity`	Получает код важности (0, 1, 2) указанного сообщения по индексу.
`GetSeverityLevel`	Возвращает уровень важности. Уровень важности используется для управления тем, как инструменты геообработки генерируют исключения.
`SetMessageLevels`	Устанавливает дополнительные категории информационных сообщений, возвращаемых вместе с сообщениями инструментов геообработки.
`SetSeverityLevel`	Управляет тем, как инструменты геообработки будут вызывать исключения в скрипте.

Функции упаковки


Функция	Описание
`GetPackageInfo`	Возвращает словарь, содержащий информацию о файле пакета.

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


Функция	Описание
`CopyParameter`	Копирует указанный параметр по индексу или имени в другой параметр в инструменте скрипта. Указанные параметры должны иметь один и тот же тип данных.
`GetArgumentCount`	Возвращает количество аргументов, передаваемых скрипту.
`GetParameter`	Из списка параметров выберите нужный параметр по его индексу или названию. Параметр возвращается как объект.
`GetParameterAsText`	Получает указанный параметр в виде текстовой строки по его индексу или имени параметра.
`GetParameterCount`	Возвращает количество значений параметра для указанного инструмента. Если инструмент находится в пользовательском наборе инструментов, используйте функцию `ImportToolbox` для доступа к пользовательскому инструменту.
`GetParameterInfo`	Возвращает список объектов параметров для заданного инструмента и обычно используется в классе инструмента-скрипта `ToolValidator`.
`GetParameterValue`	Для имени указанного инструмента возвращает значение нужного параметра по умолчанию. Параметр задается либо индексом, либо именем параметра.
`SetParameter`	Настраивает свойство заданного параметра по индексу или имени параметра с помощью объекта. Эта функция используется при передаче объектов из скрипта в инструмент скрипта. Если необходима передача строки, используйте функцию `SetParameterAsText`.
`SetParameterAsText`	Получает указанный параметр в виде текстовой строки по его индексу или имени параметра.
`SetParameterSymbology`	Задает свойства символов указанного выходного параметра инструмента-скрипта по индексу или имени параметра.

Функции диалогового окна хода выполнения


Функция	Описание
`ResetProgressor`	Восстанавливает прогрессор обратно в исходное состояние.
`SetProgressor`	Создает объект прогрессора для поддержки информации о прогрессоре, которая отображается на панели Геообработка. Вешний вид прогрессора может определяться выбором прогрессора по умолчанию или пошагового прогрессора.
`SetProgressorLabel`	Обновляет подпись на панели Геообработка.
`SetProgressorPosition`	Обновляет строку состояния прогрессора на панели Геообработка.

Функции публикации


Функция	Описание
`CreateGeocodeSDDraft`	Функция `CreateGeocodeSDDraft` преобразует локатор в файл Черновика определения сервиса (`.sddraft`), который может быть использован для создания определения сервиса, необходимого для публикации сервиса геокодирования.
`CreateGPSDDraft`	Функция `CreateGPSDDraft` преобразует объекты `Result` и файлы результата (`.rlt`) в файлы черновика определения сервиса (`.sddraft`).
`CreateImageSDDraft`	Преобразует растр или набор данных мозаики в файл черновика определения сервиса (`.sddraft`).

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


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

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


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

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


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

Обзор функций ArcPy

Связанные разделы