w3w python wrapper

W3W-PYTHON-WRAPPER

Python库使用What3Words REST API。

用Python 2.7、3.4、3.5、3.6测试（检查Travis-ci.org构建）

概述

what3words python库为您提供了程序化访问

• 将3个单词地址转换为坐标
• 将坐标转换为3个单词地址
• AutoSuggest功能，该功能略有不正确的3个单词地址，并建议有效的3个单词地址列表
• 获取一个边界框的3M x 3M What3words网格的部分。
• 确定当前支持3个单词地址语言。

验证

要使用此库，您需要一个API密钥，请访问https://what3words.com/select-plan并注册一个帐户。

安装

PYPI安装

要安装What What 3words，简单地：

$ pip install what3words

github安装

从GitHub安装最新版本：

$ git clone https://github.com/what3words/w3w-python-wrapper.git
$ cd w3w-python-wrapper
$ python setup.py install

转换为坐标

此函数将单词参数作为3个单词的字符串'table.book.chair'

What3Words REST API文档中描述了从convert-to-coordinates方法返回的有效载荷。

转换为3个单词地址

此功能采用纬度和经度：

• 2个参数： lat=0.1234 ， lng=1.5678

What3Words REST API文档中描述了从convert-to-3wa方法返回的有效载荷。

Autosuggest

根据用户输入和其他参数返回3个单词地址的列表。

此方法为以下类型的输入错误提供更正：

• 输入错误
• 拼写错误
• 误会单词（例如，单数与复数）
• 单词错误的顺序

autosuggest方法根据上述输入错误的概率确定了对所提供的3个单词地址字符串的可能更正，并返回了排名的建议列表。该方法还可以考虑到可能的校正与给定位置的地理距离，以进一步改善返回的建议。

输入3个单词地址

只有当您提交的部分3个单词字符串包含前两个单词和至少第三个单词的第一个字符时，您才会收到结果；否则，将返回错误消息。

剪裁和聚焦

我们提供各种clip策略，允许您指定用于排除不太可能与用户相关的结果的地理区域。我们建议您使用clip参数为您的用户提供更具针对性的更短的结果集。如果您知道用户当前的位置，我们还强烈建议您使用focus返回可能更相关的结果。

总而言之， clip策略用于选择限制候选Autosuggest结果列表，然后如果提供了焦点，则将使用该结果来对结果进行排名，以与重点相关。

https://docs.what3words.com/api/v3/#autosuggest

What3Words REST API文档中描述了从autosuggest方法返回的有效载荷。

网格部分

返回一个边界框的3M x 3M What 3words网格的一部分。

可用语言

检索当前加载和可用的3个单词地址语言的列表。

What3words REST API文档中描述了从available-languages方法中返回的有效载荷。

Ispossible3wa

此方法将字符串作为参数，并返回字符串是否为3WA格式（例如“ fill.count.soap”）。返回类型是布尔值。注意：不要检查它是否是现有的现有3WA。

 isPossible3wa(“filled.count.soap”) returns True
isPossible3wa(“not a 3wa”) returns False
isPossible3wa(“not.3wa address”) returns False

findpossible3wa

此方法将字符串作为参数，并搜索字符串以获取3WA的任何可能实例 - 可能是交货说明中称为的主要方法。返回一系列匹配的项目。如果找不到匹配，则返回一个空数组。注意：不要检查它是否是现有的现有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 []

ISVALID3WA

该方法将字符串作为参数采用，然后首先将其通过W3W Regex过滤器（类似于字符串上的iSpossible3wa（）），然后调用W3W API以验证它是真实的3WA。

 isValid3wa(“filled.count.soap”) returns True
isValid3wa(“filled.count.”) returns False
isValid3wa(“python.is.cool”) returns False

代码示例

W3W-API-KEY

为了在计算机上安全存储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 )

转换为3个单词地址

 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 )

问题

查找错误还是想请求新功能？请通过提交问题让我们知道。

贡献

欢迎任何人和所有人做出贡献。

1. 叉子（https://github.com/what3words/w3w-python-wrapper，单击“叉”）
2. 创建您的功能分支（ git checkout -b my-new-feature ）
3. 提交您的更改（ git commit -am 'Add some feature' ）
4. 推到分支（ git push origin my-new-feature ）
5. 创建新的拉请求

修订历史

• v3.3.0 30/09/24-支持语言环境，更新正则格式和测试
• v3.2.0 08/03/22-添加了正则函数
• v3.1.1 04/10/19-修复与设置默认语言值和autosuggest Input -type相关的错误
• v3.1.0 29/08/19-支持AutoSuggest电话的“优先地”参数
• v3.0.2 16/07/19-在API请求中包括用户 - 代理
• v3.0.0 04/02/19-更新包装器用于使用What What3Words API V3
• v2.2.1 08/09/17- python 3安装安装已修复，多亏了@joedborg
• v2.2.0 07/09/17 -Python 3支持，感谢@Joedborg
• v2.1.1 07/09/17-更新readme：此库与Python 2兼容
• v2.1.0 28/03/17-添加了autosuggest和standardblend的多语言版本
• v2.0.2 27/10/16-发表在PYPI上
• v2.0.0 10/06/16-更新包装器使用What What3Words API V2

许可

麻省理工学院许可证（MIT）

许可证的副本可在存储库的许可证文件中可用。