googlemaps/google-maps-services-python

Multiple avoid problems

Open

#382 opened on Sep 19, 2020

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (4,085 stars) (1,304 forks)batch import
help wantedpriority: p3type: bug

Description

Problem

When I passed the avoid parameters in the distance_matrix method, it told me that it is an invalid restriction. However, I wonder if it's possible to allow multiple avoid options like avoid=tolls|highways|ferries. Thank you!

Environment details

  1. API: Distance_Matrix
  2. Win 10 v2004
  3. lib version: 4.4.2, Jupyter Notebook

Steps to reproduce

  1. Simply add multiple avoids in the distance_matrix parameter

Code example

# example
gmaps = googlemaps.Client(key=YOUR_KEY)
gmaps.distance_matrix(origins=SOMEPLACE,destinations=SOMEPLACE, mode='driving', avoid='tolls|highways|ferries')

Stack trace

# example
D:\Program_Files\Anaconda3\lib\site-packages\googlemaps\distance_matrix.py in distance_matrix(client, origins, destinations, mode, language, avoid, units, departure_time, arrival_time, transit_mode, transit_routing_preference, traffic_model, region)
    107     if avoid:
    108         if avoid not in ["tolls", "highways", "ferries"]:
--> 109             raise ValueError("Invalid route restriction.")
    110         params["avoid"] = avoid
    111 

ValueError: Invalid route restriction.

Contributor guide

Tech stack
python
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Pythonfamiliarity with Google Maps API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests support for multiple 'avoid' options in the distance matrix method. The current code in distance matrix.py (line 108-109) raises a ValueError if the 'avoid' parameter is not exactly one of ['tolls', 'highways', 'ferries']. To allow multiple avoids (e.g., 'tolls|highways'), the validation should accept a pipe delimited string or a list. Check the Google Maps API documentation to confirm the expected format. The fix involves modifying the validation logic to parse and validate each component separately. A maintainer may have additional input on preferred implementation.