Когда окно Python открывается первый раз, его вид будет следующим:
Левый раздел – главное окно подсказок окна Python, в котором выполняется все команды Python. Правый раздел – окно Справка (help) и Синтаксис (syntax), в которых после запуска инструментов отображаются: сообщения исполнений, Справка для конкретного инструмента, его функция или класс в виде введенного кода.
Первым шагом для доступа к инструментам и другим возможностям arcpy в окне Python является написание команды arcpy. в строке. Это приведет к отображению списка всех инструментов, функций и классов arcpy. Этот список можно прокручивать, используя указатель мыши или клавиши клавиатуры Вверх (UP) и Вниз (DOWN). После введения дополнительной информации раскрывающийся список будет отфильтрован для поиска подходящих инструментов или методов, соответствующих введенной информации. Например, если ввести в окне Python arcpy.addf, в раскрывающемся списке будет содержаться только инструменты или методы, начинающиеся с этих знаков. Если arcpy.AddField_management был выбран из списка через прокрутку или щелчком мыши, полное имя инструмента будет автоматически введено в окне подсказки после нажатия на клавишу TAB. Когда введены открывающие круглые скобки – (, – в окне Справки и синтаксиса отобразится справка инструмента arcpy.AddField_management. По умолчанию будет выделен первый параметр.
В окне Python имя инструмента используется вместо метки инструмента. Подпись инструмента отображается в верхней части диалогового окна инструмента или в окне Каталог (Catalog). Имена инструментов обычно такие же, как метки инструментов, но они не содержат пробелы. В окне Python псевдоним панели инструментов также включает в себя имя инструмента.
- Имя и метка свойств инструмента (Tool properties name and label)
- Метка и псевдоним имени свойств панели инструментов (Toolbox properties name label and alias)
После введения всех параметров нажмите на клавишу ENTER для включения инструмента. Сообщения исполнения отобразятся в разделе Справка и синтаксис окна Python. В зависимости от типа сообщений, цвет его текста будет разным. По умолчанию цвета и значения текста сообщений следующие:
| Цвет | Значение (Meaning) |
|---|---|
Черный | Обычное информационное сообщение. |
Красный (Red) | Сообщение об ошибке. Результаты не были созданы (Results were not created). |
Оранжевый (Orange) | Предупреждающее сообщение Полученный результат может отличаться от ожидаемого вами (Results may not be what you expect). |
Вы можете изменить эти цвета, щелкнув правой клавишей мыши в разделах Справка и Синтаксис окна Python и выбрав в них раздел Формат (Format).
Сравнение требуемых и опциональных параметров.
Параметры инструмента могут быть либо обязательными, либо необязательными. Опциональные параметры взяты в фигурные скобки { }; требуемые параметры не содержат скобок.
| Тип параметра (Parameter Type) | Символ (Symbol) | Значение (Meaning) |
|---|---|---|
Обязательный | Требуемый параметр (Required parameter). Эти типы параметров в команде всегда находятся первыми. Вы должны ввести значение для требующегося параметра. | |
Необязательный (Optional) | { } | Опциональный параметр (Optional parameter). Необязательные параметры всегда идут после обязательных. Если вы не ввели значения для опционального параметра, в этом случае будет рассчитано и использовано значение по умолчанию. Значение по умолчанию параметра можно найти в разделе Справка инструмента. |
Инструменты могут иметь несколько опциональных параметров. Иногда только некоторые опциональные параметры инструмента относятся к объекту; эти параметры необходимо настроить. В программе существует три способа, как пропустить или отодвинуть дополнительный параметр:
- Установите рядом с дополнительным параметром пустые кавычки ("").
- Укажите в качестве дополнительного параметра знак решетки в кавычках ("#").
- Отдельно задайте имя и значение параметра для использования (пропускается все, кроме именованного параметра).
На показанном ниже примере используется инструмент Add Field, но четвертый и пятый параметры оставлены с их значениями по умолчанию с помощью использования трех техник.
# Use empty strings to skip optional parameters
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", "", "", 120)
# Use the # sign to skip optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", "#", "#", 120)
# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)
Значения по умолчанию (Default values)
- Опциональные параметры имеют значения по умолчанию. Если ввести значок решетки в кавычках #, "" (две двойные кавычки), '' (две одинарные кавычки) или None в качестве дополнительного параметра, будет использоваться значение параметра по умолчанию. Для ключевых слов значение по умолчанию будет первым ключевым словом в списке. Для получения информации о значении параметра по умолчанию для отдельного инструмента см. раздел Справка.
- Широко распространена практика пропуска некоторых опциональных параметров для доступа к конкретному параметру, который вы хотите изменить.
Раскрывающийся список Параметры (Parameter drop-down lists)
Раскрывающиеся списки отобразятся в окне Python, когда инструментом будут найдены имеющиеся опции для определенного параметра. Являясь частью диалогового окна инструмента, параметр идентифицирует и отфильтрует подходящие значения. Например, инструмент AddXY_management допускает только классы точечных объектов или слои в качестве входных объектов; таким образом, раскрывающийся список для этого параметра будет содержать только доступные векторные слои точечных объектов. Точно так же инструмент DeleteField_management на основе входной таблицы будет создавать раскрывающийся список полей.
Многозначные параметры (Multivalue parameters)
Параметр инструмента в зависимости от параметра может принимать только одно или несколько значений. Когда принимается многозначные значения, значение параметра может быть указано в списке Python.
Инструмент Удалить поле (Delete Field) принимает для удаления несколько полей. Для удаления нескольких полей с использованием инструмента Удалить поле (Delete Field) введите в списке Python имена полей в виде строчек.
arcpy.DeleteField_management("c:/base/rivers.shp", ["Type", "Turbidity", "Depth"])
Некоторые инструменты, такие как инструменты наложения: Union_analysis и Intersect_analysis, имеют параметры, представленные в виде таблицы, то есть с несколькими рядами, содержащими многозначные параметры для каждого ряда. Если используется инструмент Union_analysis, параметр Входные объекты (Input Features) поддерживает использование рангов приоритета, использующихся для сохранения объектов с высокой степенью точности. Ранг как опциональное значение назначается для каждого класса входного объекта, в котором 1 является самым высоким рангом.
Параметры, отображаемые в виде таблицы, называются Таблицами значений (Value Tables). Таблицы значений вводятся в главный список окна Python. Для параметра Входных объектов в инструменте Union_analysis ранг указывается после имени класса объекта вместе с запятой, разделяющей значения. Ранговая пара каждого класса объектов находится в списке больших значений (отсюда название – главный список – list-of-lists). На примере ниже показано, как создать такой список. Была создана среда рабочей области. Это позволит избежать вам повторения создания одной и той же рабочей области для каждого класса объектов.
arcpy.env.workspace = "D:/St_Johns/data.mdb/neighborhoods"
input_list = [["east", 1], ["west", 1], ["south", 1], ["north", 2]]
arcpy.Union_analysis(input_list, "D:/base/data.gdb/land_use")
Соглашение об использовании параметров (Parameter conventions)
Общая информация (In general)
- Имена параметров для всех наборов входных данных имеют префикс in_, выходной набор данных имеет префикс out_.
- Входной набор данных обычно является первым параметром, выходной набор данных обычно является последним требующимся параметром. Другие требующиеся параметры размещаются между входным и выходным набором данных.
- Опциональные параметры всегда идут после требующихся параметров.
Получение справки в окне Python.
После ввода имени команды существует несколько способов ее использования и получения справки по конкретному инструменту.
- В строке подсказки введите имя инструмента в круглых скобках: arcpy.Buffer_analysis(. В окне Справка и синтаксис отобразится информация по использованию инструмента.
- Используйте встроенную в окно Python функцию справки и введите в поле функции имя инструмента, по которому вы хотите получить справку. Справка будет отображена в главном разделе окна Python.
- Используйте встроенную в Python функцию атрибута __doc__, идущую за инструментом, для отображения строки документации. Справка будет отображена в главном разделе окна Python.
>>> arcpy.Buffer_analysis(
>>> help(arcpy.Buffer_analysis)
>>> print arcpy.Buffer_analysis.__doc__