SearchCursor (arcpy)

Краткая информация

Функция SearchCursor устанавливает курсор "только для чтения" на класс объектов или таблицу. SearchCursor можно использовать для циклической обработки строковых объектов и извлечения значений полей. Поиск можно ограничить условием where или полем, и, дополнительно, отсортировать.

Обсуждение

Курсоры поиска могут работать циклически с помощью петли for или while, с использованием метода курсора next для перехода к следующей строке. При использовании метода next на курсоре для выбора всех строк таблицы с n-строками, скрипт должен выполнить N вызовов next. Вызов метода next после последней записи в таблице возвращает в качестве результата значение None, которое является особым типом данных Python, и ведет себя как место установки курсора.

Использование SearchCursor с петлей for.

import arcpy

fc = "c:/data/base.gdb/roads"
field = "StreetName"
cursor = arcpy.SearchCursor(fc)
for row in cursor:
    print(row.getValue(field))

Использование SearchCursor с петлей while.

import arcpy

fc = "c:/data/base.gdb/roads"
field = "StreetName"
cursor = arcpy.SearchCursor(fc)
row = cursor.next()
while row:
    print(row.getValue(field))
    row = cursor.next()

Синтаксис

SearchCursor (dataset, {where_clause}, {spatial_reference}, {fields}, {sort_fields})

Параметр	Объяснение	Тип данных
dataset	Класс пространственных объектов, шейп-файл или таблица со строками для поиска.	String
where_clause	Дополнительное выражение, ограничивающее строки, возвращаемые в курсоре. Дополнительные сведения о выражениях WHERE и инструкциях SQL см. в разделе О_построении_выражения_SQL.	String
spatial_reference	Если задано, объекты будет проецироваться «на лету», с помощью значения spatial_reference.	SpatialReference
fields	Поля, которые будут включены в курсор. По умолчанию включаются все поля.	String
sort_fields	Поля, используемые для сортировки строк в курсоре. Порядок по возрастанию и убыванию для каждого поля обозначается, соответственно, буквами А и D.	String

Возвращено значение

Тип данных	Объяснение
Cursor	Объект Cursor, который может обрабатывать строковые объекты.

Пример кода

SearchCursor, пример

Получение списка содержания полей Counties.shp. Курсор отсортирован по State Name и Population.

import arcpy

# Open a searchcursor
#  Input: C:/Data/Counties.shp
#  Fields: NAME; STATE_NAME; POP2000
#  Sort fields: STATE_NAME A; POP2000 D
rows = arcpy.SearchCursor("c:/data/counties.shp",
                          fields="NAME; STATE_NAME; POP2000",
                          sort_fields="STATE_NAME A; POP2000 D")

# Iterate through the rows in the cursor and print out the
# state name, county and population of each.
for row in rows:
    print("State: {0}, County: {1}, Population: {2}".format(
        row.getValue("STATE_NAME"),
        row.getValue("NAME"),
        row.getValue("POP2000")))