w3w python wrapper

w3w-python-wrapper

ไลบรารี Python เพื่อใช้ API ของ What3words REST

ทดสอบด้วย Python 2.7, 3.4, 3.5, 3.6 (ตรวจสอบ build travis-ci.org)

ภาพรวม

ไลบรารี Python What3words ช่วยให้คุณเข้าถึงโปรแกรมได้

• แปลงที่อยู่ 3 คำเป็นพิกัด
• แปลงพิกัดเป็น 3 คำที่อยู่
• ฟังก์ชั่น AutoSugest ที่ใช้ที่อยู่คำศัพท์ 3 คำที่ไม่ถูกต้องเล็กน้อยและแนะนำรายการที่อยู่คำ 3 คำที่ถูกต้อง
• รับส่วนของกริด 3M x 3M What3wwords สำหรับกล่องขอบเขต
• กำหนดภาษาที่อยู่ 3 คำที่รองรับ 3 คำ

การรับรองความถูกต้อง

หากต้องการใช้ห้องสมุดนี้คุณจะต้องใช้คีย์ API โปรดไปที่ https://what3words.com/select-plan และสมัครใช้งานบัญชี

การติดตั้ง

การติดตั้ง PYPI

เพื่อติดตั้ง What3words เพียง:

$ 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'

Payload ที่ส่งคืนจากวิธี convert-to-coordinates อธิบายไว้ในเอกสาร API ของ What3words REST

แปลงเป็น 3 คำที่อยู่

ฟังก์ชั่นนี้ใช้เวลาละติจูดและลองจิจูด:

• 2 พารามิเตอร์: lat=0.1234 , lng=1.5678

Payload ที่ส่งคืนจากวิธี convert-to-3wa อธิบายไว้ในเอกสาร API ของ What3words REST

autosuggest

ส่งคืนรายการที่อยู่ 3 คำตามอินพุตของผู้ใช้และพารามิเตอร์อื่น ๆ

วิธีนี้ให้การแก้ไขข้อผิดพลาดประเภทต่อไปนี้:

• การพิมพ์ข้อผิดพลาด
• ข้อผิดพลาดในการสะกดคำ
• คำพูดที่ผิด (เช่นเอกพจน์กับพหูพจน์)
• คำที่ผิดลำดับ

วิธี autosuggest จะกำหนดการแก้ไขที่เป็นไปได้กับสตริงที่อยู่ 3 คำที่ให้มาตามความน่าจะเป็นของข้อผิดพลาดในการป้อนข้อมูลที่ระบุไว้ข้างต้นและส่งคืนรายการอันดับของคำแนะนำ วิธีนี้ยังสามารถคำนึงถึงความใกล้ชิดทางภูมิศาสตร์ของการแก้ไขที่เป็นไปได้ไปยังตำแหน่งที่กำหนดเพื่อปรับปรุงคำแนะนำที่ส่งคืน

ป้อนที่อยู่ 3 คำ

คุณจะได้รับผลลัพธ์กลับมาหากสตริงที่อยู่คำ 3 คำที่คุณส่งมีสองคำแรกและอย่างน้อยตัวละครแรกของคำที่สาม; มิฉะนั้นข้อความแสดงข้อผิดพลาดจะถูกส่งคืน

การตัดและโฟกัส

เราจัดทำนโยบาย clip ต่าง ๆ เพื่อให้คุณสามารถระบุพื้นที่ทางภูมิศาสตร์ที่ใช้เพื่อแยกผลลัพธ์ที่ไม่น่าจะเกี่ยวข้องกับผู้ใช้ของคุณ เราขอแนะนำให้คุณใช้พารามิเตอร์ clip เพื่อให้ชุดผลลัพธ์ที่เป้าหมายสั้นลงและสั้นลงกับผู้ใช้ของคุณ หากคุณรู้ตำแหน่งปัจจุบันของผู้ใช้เราขอแนะนำอย่างยิ่งให้คุณใช้ focus เพื่อส่งคืนผลลัพธ์ที่น่าจะเกี่ยวข้องมากขึ้น

โดยสรุปนโยบาย clip จะใช้เพื่อ จำกัด รายชื่อผลลัพธ์ที่ได้รับการคัดเลือกโดยอัตโนมัติหลังจากนั้นหากมีการจัดหาโฟกัสสิ่งนี้จะถูกใช้เพื่อจัดอันดับผลลัพธ์ตามลำดับความเกี่ยวข้องกับโฟกัส

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

น้ำหนักบรรทุกที่ส่งคืนจากวิธี autosuggest อธิบายไว้ในเอกสาร API ของ What3words REST

ส่วนกริด

ส่งคืนส่วนของกริด 3M x 3m what3words สำหรับกล่องขอบเขต

ภาษาที่มีอยู่

ดึงรายการของภาษาที่อยู่ 3 คำที่โหลดในปัจจุบันและพร้อมใช้งานในปัจจุบัน

Payload ที่ส่งคืนจากวิธี available-languages อธิบายไว้ในเอกสาร API ของ What3words REST

ispossible3wa

วิธีนี้ใช้สตริงเป็นพารามิเตอร์และส่งคืนไม่ว่าสตริงจะอยู่ในรูปแบบของ 3WA (เช่น“ full.count.soap”) ประเภทกลับเป็นบูลีน หมายเหตุ: ไม่ตรวจสอบว่าเป็น 3WA ที่มีอยู่จริงหรือไม่

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

findpossible3wa

วิธีนี้ใช้สตริงเป็นพารามิเตอร์และค้นหาสตริงสำหรับอินสแตนซ์ใด ๆ ที่เป็นไปได้ของ 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 []

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. Fork It (https://github.com/what3words/w3w-python-wrapper แล้วคลิก "Fork")
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 - สถานที่รองรับ, อัปเดต regex, รูปแบบและการทดสอบ
• v3.2.0 08/03/22 - เพิ่มฟังก์ชั่น regex
• v3.1.1 04/10/19 - แก้ไขข้อผิดพลาดที่เกี่ยวข้องกับการตั้งค่าค่าภาษาเริ่มต้นและประเภทอินพุต AutoSugest
• v3.1.0 29/08/19 - พารามิเตอร์การสนับสนุน 'Forest -lland' สำหรับการโทร AutoSuggest
• v3.0.2 16/07/19 - รวมตัวแทนผู้ใช้ในคำขอ API
• v3.0.0 04/02/19 - wrapper อัปเดตเพื่อใช้สิ่งที่ 3words api v3
• v2.2.1 08/09/17 - การติดตั้งการติดตั้ง Python 3
• 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 - wrapper อัปเดตเพื่อใช้สิ่งที่ 3words api v2

การออกใบอนุญาต

ใบอนุญาต MIT (MIT)

สำเนาใบอนุญาตมีอยู่ในไฟล์ใบอนุญาตของที่เก็บ