Spec-Zone.ru › Django 5.0

Геолокация с GeoIP2

Объект GeoIP2 является оболочкой для библиотеки MaxMind geoip2 Python. [1]

Для выполнения геолокации по IP-адресу объекту GeoIP2 необходим пакет Python geoip2 и базы данных GeoIP Country и/или City в двоичном формате (CSV файлы не подойдут!), скачанные, например, с сайтов MaxMind или DB-IP. Скачайте файлы GeoLite2-Country.mmdb.gz и GeoLite2-City.mmdb.gz и распакуйте их в директорию, соответствующую настройке GEOIP_PATH.

Кроме того, рекомендуется установить библиотеку libmaxminddb C, чтобы geoip2 могла использовать более высокую скорость C-библиотеки.

Изменено в Django 4.2:

Добавлена поддержка файлов .mmdb, скачанных с DB-IP.

Пример

Вот пример его использования:

>>> from django.contrib.gis.geoip2 import GeoIP2
>>> g = GeoIP2()
>>> g.country("google.com")
{'country_code': 'US', 'country_name': 'United States'}
>>> g.city("72.14.207.99")
{'city': 'Mountain View',
'continent_code': 'NA',
'continent_name': 'North America',
'country_code': 'US',
'country_name': 'United States',
'dma_code': 807,
'is_in_european_union': False,
'latitude': 37.419200897216797,
'longitude': -122.05740356445312,
'postal_code': '94043',
'region': 'CA',
'time_zone': 'America/Los_Angeles'}
>>> g.lat_lon("salon.com")
(39.0437, -77.4875)
>>> g.lon_lat("uh.edu")
(-95.4342, 29.834)
>>> g.geos("24.124.1.80").wkt
'POINT (-97 38)'

Справочник API

class GeoIP2(path=None, cache=0, country=None, city=None)

Объект GeoIP не требует никаких параметров для использования по умолчанию. Однако, как минимум, должна быть установлена настройка GEOIP_PATH с путем к файлам данных GeoIP. Для настройки по умолчанию можно использовать следующие ключевые слова:

Ключевые аргументы Описание
path Базовая директория расположения данных GeoIP или полный путь к файлам данных города или страны (.mmdb). Предполагает, что файлы данных города и страны находятся в этой директории; переопределяет настройку GEOIP_PATH.
cache Настройки кэша при открытии данных GeoIP. Может быть целым числом из (0, 1, 2, 4, 8), соответствующим настройкам MODE_AUTO, MODE_MMAP_EXT, MODE_MMAP, и GEOIP_INDEX_CACHE C API, соответственно. По умолчанию 0 (MODE_AUTO).
country Имя файла данных GeoIP страны. По умолчанию GeoLite2-Country.mmdb. Установка этого ключевого слова переопределяет настройку GEOIP_COUNTRY.
city Имя файла данных GeoIP города. По умолчанию GeoLite2-City.mmdb. Установка этого ключевого слова переопределяет настройку GEOIP_CITY.

Методы

Инициализация

classmethod GeoIP2.open(path, cache)

Этот метод класса инициализирует объект GeoIP из заданного пути к базе данных и заданной настройкой кэша.

Запросы

Все следующие запросы могут принимать строковый IP-адрес или полное доменное имя (FQDN). Например, как '205.186.163.125' и 'djangoproject.com' являются допустимыми параметрами запроса.

GeoIP2.city(query)

Возвращает словарь с информацией о городе для заданного запроса. Некоторые значения в словаре могут быть неопределенными (None).

GeoIP2.country(query)

Возвращает словарь с кодом страны и названием страны для заданного запроса.

GeoIP2.country_code(query)

Возвращает код страны, соответствующий запросу.

GeoIP2.country_name(query)

Возвращает название страны, соответствующее запросу.

Получение координат

GeoIP2.coords(query)

Возвращает кортеж координат (долгота, широта).

GeoIP2.lon_lat(query)

Возвращает кортеж координат (долгота, широта).

GeoIP2.lat_lon(query)

Возвращает кортеж координат (широта, долгота).

GeoIP2.geos(query)

Возвращает объект Point, соответствующий запросу.

Настройки

GEOIP_PATH

Строка или pathlib.Path, указывающая директорию, где расположены файлы данных GeoIP. Эта настройка обязательна, если не задана вручную с помощью ключевого слова path при инициализации объекта GeoIP2.

GEOIP_COUNTRY

Имя файла данных GeoIP страны. По умолчанию 'GeoLite2-Country.mmdb'.

GEOIP_CITY

Имя файла данных GeoIP города. По умолчанию 'GeoLite2-City.mmdb'.

Исключения

exception GeoIP2Exception

Исключение, которое генерируется при возникновении ошибки в вызове основной библиотеки geoip2.

Сноски

[1] GeoIP(R) — зарегистрированный товарный знак MaxMind, Inc.

© Django Software Foundation and individual contributors
Licensed under the BSD License.
https://docs.djangoproject.com/en/5.0/ref/contrib/gis/geoip2/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API