Библиотека Python для использования API What3words REST.
Протестировано с помощью Python 2.7, 3,4, 3,5, 3.6 (проверьте сборку Travis-Ci.org)
Библиотека Python What3Words дает вам программный доступ к
Чтобы использовать эту библиотеку, вам понадобится ключ API, пожалуйста, посетите https://what3words.com/select-plan и зарегистрируйтесь на учетную запись.
Чтобы установить What3words, просто:
$ pip install what3words
Установка последней версии от GitHub:
$ git clone https://github.com/what3words/w3w-python-wrapper.git
$ cd w3w-python-wrapper
$ python setup.py install
Эта функция принимает параметр слова как строка из 3 слов 'table.book.chair'
Возвращенная полезная нагрузка из метода convert-to-coordinates
описана в документации API What3Words REST.
Эта функция занимает широту и долготу:
lat=0.1234
, lng=1.5678
Возвращенная полезная нагрузка из метода convert-to-3wa
описана в документации API What3Words REST.
Возвращает список из 3 адресов слов на основе ввода пользователя и других параметров.
Этот метод обеспечивает исправления для следующих типов ошибки ввода:
Метод autosuggest
определяет возможные поправки к предоставленной строке 3 слов на основе вероятности ошибок ввода, перечисленных выше, и возвращает ранжированный список предложений. Этот метод также может принять во внимание географическую близость возможных исправлений к данному месту для дальнейшего улучшения возвращенных предложений.
Вы получите результаты только в том случае, если отправленная вами частичная строка из 3 слов содержит первые два слова и, по крайней мере, первый символ третьего слова; В противном случае будет возвращено сообщение об ошибке.
Мы предоставляем различные политики clip
, чтобы позволить вам указать географическую область, которая используется для исключения результатов, которые вряд ли будут иметь отношение к вашим пользователям. Мы рекомендуем вам использовать параметр clip
, чтобы дать более целенаправленный, более короткий набор результатов вашему пользователю. Если вы знаете текущее местоположение вашего пользователя, мы также настоятельно рекомендуем вам использовать focus
, чтобы вернуть результаты, которые, вероятно, будут более актуальными.
Таким образом, политика clip
используется для необязательного ограничения списка результатов с самосовершенными кандидатами, после чего, если фокус будет предоставлен, это будет использоваться для ранжирования результатов в порядке актуальности для фокуса.
https://docs.what3words.com/api/v3/#autosuggest
Возвращенная полезная нагрузка из метода autosuggest
описана в документации API What3Words REST.
Возвращает раздел сетки 3M x 3M What3Words для ограничивающей коробки.
Извлекает список загруженных в настоящее время и доступных языков адреса адреса.
Возвращенная полезная нагрузка из метода available-languages
описана в документации API What3Words REST.
Этот метод принимает строку в качестве параметра и возвращает, находится ли строка в формате 3WA (например, «заполненный.count.soap»). Возвратный тип является логическим. Примечание: не проверяет, является ли это фактическим существующим 3WA.
isPossible3wa(“filled.count.soap”) returns True
isPossible3wa(“not a 3wa”) returns False
isPossible3wa(“not.3wa address”) returns False
Этот метод принимает строку в качестве параметра и ищет строку для любых возможных экземпляров 3wa - например, «оставить в моем крыльце на word.word.word». Скорее всего, будет основным методом, который вызывается в примечаниях по доставке. Возвращает множество подходящих предметов. Возвращает пустой массив, если совпадения не найдено. Примечание: не проверяет, является ли это фактическим существующим 3WA.
findPossible3wa(“Please leave by my porch at filled.count.soap”) will return [‘filled.count.soap’]
findPossible3wa(“Please leave by my porch at filled.count.soap or deed.tulip.judge”) will return [‘filled.count.soap’, ‘deed.tulip.judge’]
findPossible3wa(“Please leave by my porch at”) will return []
Этот метод принимает строку в качестве параметра и сначала передает ее через фильтр regex w3w (сродни вызову ispossible3wa () на строке), а затем вызывает API W3W, чтобы убедиться, что он является реальным 3WA.
isValid3wa(“filled.count.soap”) returns True
isValid3wa(“filled.count.”) returns False
isValid3wa(“python.is.cool”) returns False
Для безопасного хранения вашего ключа API на вашем компьютере вы можете определить этот ключ API, используя переменные среды вашей системы.
$ export W3W_API_KEY= < Secret API Key >
import what3words
from os import environ
api_key = environ [ 'W3W_API_KEY' ]
w3w = what3words . Geocoder ( api_key )
res = w3w . convert_to_coordinates ( 'prom.cape.pump' )
print ( res )
import what3words
from os import environ
api_key = environ [ 'W3W_API_KEY' ]
w3w = what3words . Geocoder ( api_key )
res = w3w . convert_to_3wa ( what3words . Coordinates ( 51.484463 , - 0.195405 ))
print ( res )
Найти ошибку или запрашивать новую функцию? Пожалуйста, сообщите нам об этом, отправив вопрос.
Любой и все могут внести свой вклад.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)v3.3.0
30/09/24 - Поддержка локализации, обновление, формат и тестыv3.2.0
08/03/22 - Добавлены функции режима.v3.1.1
04/10/19 - Исправлена ошибки, связанные с установкой языкового значения по умолчанию, и автозагрузкиv3.1.0
29/08/19 - Параметр «Предпочтение» для поддержкиv3.0.2
16/07/19 - включить пользовательский агент в запросах APIv3.0.0
04/02/19 - Обновленная обертка для использования What3Words API v3v2.2.1
08/09/17 - установка Python 3 Установка фиксирована благодаря @joedborgv2.2.0
07/09/17 - Поддержка Python 3, спасибо @joedborgv2.1.1
07/09/17 - Обновление readme: эта библиотека совместима с Python 2v2.1.0
28/03/17 - добавлена многоязычная версия autosuggest
и standardblend
v2.0.2
27/10/16 - опубликовано на PYPIv2.0.0
10/06/16 - Обновленная обертка для использования What3Words API V2 Лицензия MIT (MIT)
Копия лицензии доступна в файле лицензии репозитория.