restrict optimize_waypoints to not trigger when options or shortest are used

Author: nilsnolde

CHANGELOG

@@ -2,6 +2,7 @@
 
 ## 2.2.0
 
+- restrict optimize_waypoints parameter to not trigger when options or 'shortest' is used
 - Add optimize_waypoints option to directions for simple TSP
 - get rid of validators, too maintenance-heavy
 

openrouteservice/__init__.py

@@ -17,7 +17,7 @@
 # the License.
 #
 
-__version__ = "2.2.1"
+__version__ = "2.2.2"
 
 
 def get_ordinal(number):

openrouteservice/directions.py

@@ -167,7 +167,7 @@ def directions(client,
     :param optimize_waypoints: If True, a `Vroom <https://github.com/VROOM-Project/vroom>`_ instance (ORS optimization
         endpoint) will optimize the `via` waypoints, i.e. all coordinates between the first and the last. It assumes
         the first coordinate to be the start location and the last coordinate to be the end location. Only requests with
-        a minimum of 4 coordinates can be optimized. Default False.
+        a minimum of 4 coordinates, no routing options and fastest weighting. Default False.
     :type optimize_waypoints: bool
 
     :param validate: Specifies whether parameters should be validated before sending the request. Default True.
@@ -184,9 +184,13 @@ def directions(client,
     """
 
     # call optimization endpoint and get new order of waypoints
-    if optimize_waypoints is not None:
+    if optimize_waypoints is not None and not dry_run:
         if len(coordinates) <= 3:
-            warnings.warn("Less than 4 coordinates, nothing to optimize!")
+            warnings.warn("Less than 4 coordinates, nothing to optimize!", UserWarning)
+        elif options:
+            warnings.warn("Options are not compatible with optimization.", UserWarning)
+        elif preference == 'shortest':
+            warnings.warn("Shortest is not compatible with optimization.", UserWarning)
         else:
             coordinates = _optimize_waypoint_order(client, coordinates, profile)
 

setup.py

@@ -22,7 +22,7 @@ def readme():
 
 setup(
     name='openrouteservice',
-    version='2.2.1',
+    version='2.2.2',
     description='Python client for requests to openrouteservice API services',
     long_description=readme(),
     long_description_content_type='text/x-rst',

test/test_directions.py

@@ -74,3 +74,67 @@ def test_optimized_waypoints(self):
         # Too exhausting to really test this
         with self.assertRaises(openrouteservice.exceptions.ApiError):
             resp = self.client.directions(**query)
+
+    @responses.activate
+    def test_optimize_warnings(self):
+        query = deepcopy(self.valid_query)
+        query['optimize_waypoints'] = True
+
+        # Test Coordinates
+
+        responses.add(responses.POST,
+                      'https://api.openrouteservice.org/v2/directions/{}/geojson'.format(query['profile']),
+                      json=query,
+                      status=200,
+                      content_type='application/json')
+
+        with warnings.catch_warnings(record=True) as w:
+            # Cause all warnings to always be triggered.
+            warnings.simplefilter("always")
+
+            resp = self.client.directions(**query)
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, UserWarning)
+            assert "4 coordinates" in str(w[-1].message)
+
+        # Test Options
+        
+        query['coordinates'] = [[8.688641, 49.420577], [8.680916, 49.415776],[8.688641, 49.420577], [8.680916, 49.415776]]
+
+        responses.add(responses.POST,
+                      'https://api.openrouteservice.org/v2/directions/{}/geojson'.format(query['profile']),
+                      json=query,
+                      status=200,
+                      content_type='application/json')
+
+        with warnings.catch_warnings(record=True) as w:
+            # Cause all warnings to always be triggered.
+            warnings.simplefilter("always")
+
+            resp = self.client.directions(**query)
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, UserWarning)
+            assert "Options" in str(w[-1].message)
+
+        # Test Preference
+
+        query['options'] = None
+        query['preference'] = 'shortest'
+
+        responses.add(responses.POST,
+                      'https://api.openrouteservice.org/v2/directions/{}/geojson'.format(query['profile']),
+                      json=query,
+                      status=200,
+                      content_type='application/json')
+
+        with warnings.catch_warnings(record=True) as w:
+            # Cause all warnings to always be triggered.
+            warnings.simplefilter("always")
+
+            resp = self.client.directions(**query)
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, UserWarning)
+            assert "Shortest" in str(w[-1].message)