-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
places.py
660 lines (549 loc) · 20.4 KB
/
places.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
#
# Copyright 2015 Google Inc. All rights reserved.
#
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
#
"""Performs requests to the Google Places API."""
import warnings
from googlemaps import convert
PLACES_FIND_FIELDS_BASIC = {"business_status",
"formatted_address",
"geometry",
"geometry/location",
"geometry/location/lat",
"geometry/location/lng",
"geometry/viewport",
"geometry/viewport/northeast",
"geometry/viewport/northeast/lat",
"geometry/viewport/northeast/lng",
"geometry/viewport/southwest",
"geometry/viewport/southwest/lat",
"geometry/viewport/southwest/lng",
"icon",
"name",
"permanently_closed",
"photos",
"place_id",
"plus_code",
"types",}
PLACES_FIND_FIELDS_CONTACT = {"opening_hours"}
PLACES_FIND_FIELDS_ATMOSPHERE = {"price_level", "rating", "user_ratings_total"}
PLACES_FIND_FIELDS = (
PLACES_FIND_FIELDS_BASIC
^ PLACES_FIND_FIELDS_CONTACT
^ PLACES_FIND_FIELDS_ATMOSPHERE
)
PLACES_DETAIL_FIELDS_BASIC = {"address_component",
"adr_address",
"business_status",
"formatted_address",
"geometry",
"geometry/location",
"geometry/location/lat",
"geometry/location/lng",
"geometry/viewport",
"geometry/viewport/northeast",
"geometry/viewport/northeast/lat",
"geometry/viewport/northeast/lng",
"geometry/viewport/southwest",
"geometry/viewport/southwest/lat",
"geometry/viewport/southwest/lng",
"icon",
"name",
"permanently_closed",
"photo",
"place_id",
"plus_code",
"type",
"url",
"utc_offset",
"vicinity",}
PLACES_DETAIL_FIELDS_CONTACT = {"formatted_phone_number", "international_phone_number", "opening_hours", "website"}
PLACES_DETAIL_FIELDS_ATMOSPHERE = {"price_level", "rating", "review", "user_ratings_total"}
PLACES_DETAIL_FIELDS = (
PLACES_DETAIL_FIELDS_BASIC
^ PLACES_DETAIL_FIELDS_CONTACT
^ PLACES_DETAIL_FIELDS_ATMOSPHERE
)
DEPRECATED_FIELDS = {"permanently_closed"}
DEPRECATED_FIELDS_MESSAGE = (
"Fields, %s, are deprecated. "
"Read more at https://developers.google.com/maps/deprecations."
)
def find_place(
client, input, input_type, fields=None, location_bias=None, language=None
):
"""
A Find Place request takes a text input, and returns a place.
The text input can be any kind of Places data, for example,
a name, address, or phone number.
:param input: The text input specifying which place to search for (for
example, a name, address, or phone number).
:type input: string
:param input_type: The type of input. This can be one of either 'textquery'
or 'phonenumber'.
:type input_type: string
:param fields: The fields specifying the types of place data to return. For full details see:
https://developers.google.com/places/web-service/search#FindPlaceRequests
:type fields: list
:param location_bias: Prefer results in a specified area, by specifying
either a radius plus lat/lng, or two lat/lng pairs
representing the points of a rectangle. See:
https://developers.google.com/places/web-service/search#FindPlaceRequests
:type location_bias: string
:param language: The language in which to return results.
:type language: string
:rtype: result dict with the following keys:
status: status code
candidates: list of places
"""
params = {"input": input, "inputtype": input_type}
if input_type != "textquery" and input_type != "phonenumber":
raise ValueError(
"Valid values for the `input_type` param for "
"`find_place` are 'textquery' or 'phonenumber', "
"the given value is invalid: '%s'" % input_type
)
if fields:
deprecated_fields = set(fields) & DEPRECATED_FIELDS
if deprecated_fields:
warnings.warn(
DEPRECATED_FIELDS_MESSAGE % str(list(deprecated_fields)),
DeprecationWarning,
)
invalid_fields = set(fields) - PLACES_FIND_FIELDS
if invalid_fields:
raise ValueError(
"Valid values for the `fields` param for "
"`find_place` are '%s', these given field(s) "
"are invalid: '%s'"
% ("', '".join(PLACES_FIND_FIELDS), "', '".join(invalid_fields))
)
params["fields"] = convert.join_list(",", fields)
if location_bias:
valid = ["ipbias", "point", "circle", "rectangle"]
if location_bias.split(":")[0] not in valid:
raise ValueError("location_bias should be prefixed with one of: %s" % valid)
params["locationbias"] = location_bias
if language:
params["language"] = language
return client._request("/maps/api/place/findplacefromtext/json", params)
def places(
client,
query=None,
location=None,
radius=None,
language=None,
min_price=None,
max_price=None,
open_now=False,
type=None,
region=None,
page_token=None,
):
"""
Places search.
:param query: The text string on which to search, for example: "restaurant".
:type query: string
:param location: The latitude/longitude value for which you wish to obtain the
closest, human-readable address.
:type location: string, dict, list, or tuple
:param radius: Distance in meters within which to bias results.
:type radius: int
:param language: The language in which to return results.
:type language: string
:param min_price: Restricts results to only those places with no less than
this price level. Valid values are in the range from 0 (most affordable)
to 4 (most expensive).
:type min_price: int
:param max_price: Restricts results to only those places with no greater
than this price level. Valid values are in the range from 0 (most
affordable) to 4 (most expensive).
:type max_price: int
:param open_now: Return only those places that are open for business at
the time the query is sent.
:type open_now: bool
:param type: Restricts the results to places matching the specified type.
The full list of supported types is available here:
https://developers.google.com/places/supported_types
:type type: string
:param region: The region code, optional parameter.
See more @ https://developers.google.com/places/web-service/search
:type region: string
:param page_token: Token from a previous search that when provided will
returns the next page of results for the same search.
:type page_token: string
:rtype: result dict with the following keys:
results: list of places
html_attributions: set of attributions which must be displayed
next_page_token: token for retrieving the next page of results
"""
return _places(
client,
"text",
query=query,
location=location,
radius=radius,
language=language,
min_price=min_price,
max_price=max_price,
open_now=open_now,
type=type,
region=region,
page_token=page_token,
)
def places_nearby(
client,
location=None,
radius=None,
keyword=None,
language=None,
min_price=None,
max_price=None,
name=None,
open_now=False,
rank_by=None,
type=None,
page_token=None,
):
"""
Performs nearby search for places.
:param location: The latitude/longitude value for which you wish to obtain the
closest, human-readable address.
:type location: string, dict, list, or tuple
:param radius: Distance in meters within which to bias results.
:type radius: int
:param region: The region code, optional parameter.
See more @ https://developers.google.com/places/web-service/search
:type region: string
:param keyword: A term to be matched against all content that Google has
indexed for this place.
:type keyword: string
:param language: The language in which to return results.
:type language: string
:param min_price: Restricts results to only those places with no less than
this price level. Valid values are in the range from 0
(most affordable) to 4 (most expensive).
:type min_price: int
:param max_price: Restricts results to only those places with no greater
than this price level. Valid values are in the range
from 0 (most affordable) to 4 (most expensive).
:type max_price: int
:param name: One or more terms to be matched against the names of places.
:type name: string or list of strings
:param open_now: Return only those places that are open for business at
the time the query is sent.
:type open_now: bool
:param rank_by: Specifies the order in which results are listed.
Possible values are: prominence (default), distance
:type rank_by: string
:param type: Restricts the results to places matching the specified type.
The full list of supported types is available here:
https://developers.google.com/places/supported_types
:type type: string
:param page_token: Token from a previous search that when provided will
returns the next page of results for the same search.
:type page_token: string
:rtype: result dict with the following keys:
status: status code
results: list of places
html_attributions: set of attributions which must be displayed
next_page_token: token for retrieving the next page of results
"""
if not location and not page_token:
raise ValueError("either a location or page_token arg is required")
if rank_by == "distance":
if not (keyword or name or type):
raise ValueError(
"either a keyword, name, or type arg is required "
"when rank_by is set to distance"
)
elif radius is not None:
raise ValueError(
"radius cannot be specified when rank_by is set to " "distance"
)
return _places(
client,
"nearby",
location=location,
radius=radius,
keyword=keyword,
language=language,
min_price=min_price,
max_price=max_price,
name=name,
open_now=open_now,
rank_by=rank_by,
type=type,
page_token=page_token,
)
def _places(
client,
url_part,
query=None,
location=None,
radius=None,
keyword=None,
language=None,
min_price=0,
max_price=4,
name=None,
open_now=False,
rank_by=None,
type=None,
region=None,
page_token=None,
):
"""
Internal handler for ``places`` and ``places_nearby``.
See each method's docs for arg details.
"""
params = {"minprice": min_price, "maxprice": max_price}
if query:
params["query"] = query
if location:
params["location"] = convert.latlng(location)
if radius:
params["radius"] = radius
if keyword:
params["keyword"] = keyword
if language:
params["language"] = language
if name:
params["name"] = convert.join_list(" ", name)
if open_now:
params["opennow"] = "true"
if rank_by:
params["rankby"] = rank_by
if type:
params["type"] = type
if region:
params["region"] = region
if page_token:
params["pagetoken"] = page_token
url = "/maps/api/place/%ssearch/json" % url_part
return client._request(url, params)
def place(client, place_id, session_token=None, fields=None, language=None):
"""
Comprehensive details for an individual place.
:param place_id: A textual identifier that uniquely identifies a place,
returned from a Places search.
:type place_id: string
:param session_token: A random string which identifies an autocomplete
session for billing purposes.
:type session_token: string
:param fields: The fields specifying the types of place data to return,
separated by a comma. For full details see:
https://cloud.google.com/maps-platform/user-guide/product-changes/#places
:type input: list
:param language: The language in which to return results.
:type language: string
:rtype: result dict with the following keys:
result: dict containing place details
html_attributions: set of attributions which must be displayed
"""
params = {"placeid": place_id}
if fields:
deprecated_fields = set(fields) & DEPRECATED_FIELDS
if deprecated_fields:
warnings.warn(
DEPRECATED_FIELDS_MESSAGE % str(list(deprecated_fields)),
DeprecationWarning,
)
invalid_fields = set(fields) - PLACES_DETAIL_FIELDS
if invalid_fields:
raise ValueError(
"Valid values for the `fields` param for "
"`place` are '%s', these given field(s) "
"are invalid: '%s'"
% ("', '".join(PLACES_DETAIL_FIELDS), "', '".join(invalid_fields))
)
params["fields"] = convert.join_list(",", fields)
if language:
params["language"] = language
if session_token:
params["sessiontoken"] = session_token
return client._request("/maps/api/place/details/json", params)
def places_photo(client, photo_reference, max_width=None, max_height=None):
"""
Downloads a photo from the Places API.
:param photo_reference: A string identifier that uniquely identifies a
photo, as provided by either a Places search or Places detail request.
:type photo_reference: string
:param max_width: Specifies the maximum desired width, in pixels.
:type max_width: int
:param max_height: Specifies the maximum desired height, in pixels.
:type max_height: int
:rtype: iterator containing the raw image data, which typically can be
used to save an image file locally. For example:
.. code-block:: python
f = open(local_filename, 'wb')
for chunk in client.places_photo(photo_reference, max_width=100):
if chunk:
f.write(chunk)
f.close()
"""
if not (max_width or max_height):
raise ValueError("a max_width or max_height arg is required")
params = {"photoreference": photo_reference}
if max_width:
params["maxwidth"] = max_width
if max_height:
params["maxheight"] = max_height
# "extract_body" and "stream" args here are used to return an iterable
# response containing the image file data, rather than converting from
# json.
response = client._request(
"/maps/api/place/photo",
params,
extract_body=lambda response: response,
requests_kwargs={"stream": True},
)
return response.iter_content()
def places_autocomplete(
client,
input_text,
session_token=None,
offset=None,
origin=None,
location=None,
radius=None,
language=None,
types=None,
components=None,
strict_bounds=False,
):
"""
Returns Place predictions given a textual search string and optional
geographic bounds.
:param input_text: The text string on which to search.
:type input_text: string
:param session_token: A random string which identifies an autocomplete
session for billing purposes.
:type session_token: string
:param offset: The position, in the input term, of the last character
that the service uses to match predictions. For example,
if the input is 'Google' and the offset is 3, the
service will match on 'Goo'.
:type offset: int
:param origin: The origin point from which to calculate straight-line distance
to the destination (returned as distance_meters).
If this value is omitted, straight-line distance will
not be returned.
:type origin: string, dict, list, or tuple
:param location: The latitude/longitude value for which you wish to obtain the
closest, human-readable address.
:type location: string, dict, list, or tuple
:param radius: Distance in meters within which to bias results.
:type radius: int
:param language: The language in which to return results.
:type language: string
:param types: Restricts the results to places matching the specified type.
The full list of supported types is available here:
https://developers.google.com/places/web-service/autocomplete#place_types
:type types: string
:param components: A component filter for which you wish to obtain a geocode.
Currently, you can use components to filter by up to 5 countries for
example: ``{'country': ['US', 'AU']}``
:type components: dict
:param strict_bounds: Returns only those places that are strictly within
the region defined by location and radius.
:type strict_bounds: bool
:rtype: list of predictions
"""
return _autocomplete(
client,
"",
input_text,
session_token=session_token,
offset=offset,
origin=origin,
location=location,
radius=radius,
language=language,
types=types,
components=components,
strict_bounds=strict_bounds,
)
def places_autocomplete_query(
client, input_text, offset=None, location=None, radius=None, language=None
):
"""
Returns Place predictions given a textual search query, such as
"pizza near New York", and optional geographic bounds.
:param input_text: The text query on which to search.
:type input_text: string
:param offset: The position, in the input term, of the last character
that the service uses to match predictions. For example, if the input
is 'Google' and the offset is 3, the service will match on 'Goo'.
:type offset: int
:param location: The latitude/longitude value for which you wish to obtain the
closest, human-readable address.
:type location: string, dict, list, or tuple
:param radius: Distance in meters within which to bias results.
:type radius: number
:param language: The language in which to return results.
:type language: string
:rtype: list of predictions
"""
return _autocomplete(
client,
"query",
input_text,
offset=offset,
location=location,
radius=radius,
language=language,
)
def _autocomplete(
client,
url_part,
input_text,
session_token=None,
offset=None,
origin=None,
location=None,
radius=None,
language=None,
types=None,
components=None,
strict_bounds=False,
):
"""
Internal handler for ``autocomplete`` and ``autocomplete_query``.
See each method's docs for arg details.
"""
params = {"input": input_text}
if session_token:
params["sessiontoken"] = session_token
if offset:
params["offset"] = offset
if origin:
params["origin"] = convert.latlng(origin)
if location:
params["location"] = convert.latlng(location)
if radius:
params["radius"] = radius
if language:
params["language"] = language
if types:
params["types"] = types
if components:
if len(components) != 1 or list(components.keys())[0] != "country":
raise ValueError("Only country components are supported")
params["components"] = convert.components(components)
if strict_bounds:
params["strictbounds"] = "true"
url = "/maps/api/place/%sautocomplete/json" % url_part
return client._request(url, params).get("predictions", [])