Перейти к содержанию

pynspd.AsyncNspd

pynspd.AsyncNspd

Асинхронный клиент для НСПД

Example:

async with pynspd.AsyncNspd() as nspd:
    feat = await nspd.find_zu("77:05:0001005:19")

Parameters:

Name Type Description Default
client_timeout Optional[int]

Время ожидания ответа. Если не установлен - есть вероятность бесконечного ожидания. По умолчанию None.

None
client_retries Optional[int]

Количество попыток при неудачном запросе (таймаут, неожиданный обрыв соединения, 5хх ошибки). По умолчанию 10.

None
client_retry_on_blocked_ip Optional[bool]

При получении ошибки 403 (доступ заблокирован для вашего IP), продолжать попытки запроса до исчерпания retries. Рекомендуется использовать только c ротируемыми прокси. По умолчанию False.

None
client_proxy Optional[ProxyTypes]

Адрес для проксирования запросов. По умолчанию None.

None
client_dns_resolve Optional[bool]

Использовать в запросах IP адрес НСПД вместо доменного имени. Рекомендуется включить, если используемый прокси не может сам разрешать доменные имена. По умолчанию False.

None
cache_folder_path Optional[Union[str, Path]]

Путь до папки для кэша запросов.. По умолчанию None.

None
cache_sqlite_url Optional[str]

Строка подключения для sqlite-хранилища кэша. По умолчанию None.

None
cache_redis_url Optional[str]

Строка подключения для redis-хранилища кэша. По умолчанию None.

None
cache_ttl Optional[int]

Количество времени (в секундах) сколько будет храниться кэш. По умолчанию None.

None
cache_storage Optional[AsyncBaseStorage]

Ручная настройка объекта хранилища кэша (см. https://hishel.com/advanced/storages/). По умолчанию None.

None
trust_env bool

Использовать переменные окружения для инициализации. По умолчанию True.

True

close() async

Завершение сессии

find(query, theme_id=ThemeId.REAL_ESTATE_OBJECTS) async

Найти объект по предустановленной теме

Parameters:

Name Type Description Default
query str

Поисковой запрос

required
theme_id ThemeId

Вид объекта (кадастровое деление, объект недвижимости и т.д.). По умолчанию: объекты недвижимости

REAL_ESTATE_OBJECTS

Returns:

Type Description
Optional[NspdFeature]

Положительный ответ от сервиса, либо None, если ничего не найдено

find_building(query) async

Найти ОКС по кадастровому номеру

find_in_layer(query, layer_def) async

Найти объект по определению слоя

Parameters:

Name Type Description Default
query str

Поисковой запрос

required
layer_def Type[Feat]

Определение слоя

required

Returns:

Type Description
Optional[Feat]

Валидированная модель слоя, если найдено

find_landplot(query) async

Найти ЗУ по кадастровому номеру

get_tab_data(feat, tab_name) async

Получение данных с указанной вкладки

request(method, url, params=None, json=None) async

Базовый запрос к API НСПД

safe_request(method, url, params=None, json=None) async

Базовый запрос к api НСПД с обработкой ошибок

search(query, theme_id=ThemeId.REAL_ESTATE_OBJECTS) async

Поисковой запрос по предустановленной теме

Parameters:

Name Type Description Default
query str

Поисковой запрос

required
theme_id ThemeId

Вид объекта (кадастровое деление, объект недвижимости и т.д.). По умолчанию: объекты недвижимости

REAL_ESTATE_OBJECTS

Returns:

Type Description
Optional[list[NspdFeature]]

Положительный ответ от сервиса, либо None, если ничего не найдено

search_at_coords(lat, lng, layer_def) async

Поиск объектов слоя в координатах

Parameters:

Name Type Description Default
lat float

Широта

required
lng float

Долгота

required
layer_def Type[Feat]

Тип слоя

required

Returns:

Type Description
Optional[list[Feat]]

Типизированный список объектов, если найдены

search_at_point(pt, layer_def) async

Поиск объектов слоя в точке (с типизацией)

Parameters:

Name Type Description Default
pt Point

Точка поиска

required
layer_def Type[Feat]

Тип слоя

required

Returns:

Type Description
Optional[list[Feat]]

Типизированный список объектов, если найдены

search_buildings(cn) async

Поиск ОКС по кадастровому номеру

search_buildings_at_coords(lat, lng) async

Поиск ОКС в координатах

search_buildings_at_point(pt) async

Поиск ОКС в точке

search_buildings_in_contour(countour) async

Поиск ОКС в контуре

search_in_contour(countour, layer_def) async

Поиск объектов слоя в контуре

Parameters:

Name Type Description Default
countour Union[Polygon, MultiPolygon]

Геометрический объект с контуром

required
layer_def Type[Feat]

Модель слоя

required

Returns:

Type Description
Optional[list[Feat]]

Список объектов, пересекающихся с контуром, если найден хоть один

search_in_layer(query, layer_def) async

Поиск объекта по определению слоя

Parameters:

Name Type Description Default
query str

Поисковой запрос

required
layer_def Type[Feat]

Определение слоя

required

Returns:

Type Description
Optional[list[Feat]]

Валидированная модель слоя, если найдено

search_landplots(cn) async

Поиск ЗУ по кадастровому номеру

search_landplots_at_coords(lat, lng) async

Поиск ЗУ в координатах

search_landplots_at_point(pt) async

Поиск ЗУ в точке

search_landplots_in_contour(countour) async

Поиск ЗУ в контуре

tab_build_parts(feat) async

Получение данных с вкладки "Части ОКС"

tab_composition_land(feat) async

Получение данных с вкладки "Состав ЕЗП"

Получение данных с вкладки "Связанные ЗУ"

tab_land_parts(feat) async

Получение данных с вкладки "Части ЗУ"

tab_objects_list(feat) async

Получение данных с вкладки "Объекты"

tab_permission_type(feat) async

Получение данных с вкладки "Виды разрешенного использования"