Fix test_multi_polyline

Author: Martin Journois

folium/features.py

@@ -8,7 +8,7 @@
 from jinja2 import Template
 import json
 
-from .utilities import color_brewer, _parse_size, legend_scaler
+from .utilities import color_brewer, _parse_size, legend_scaler, _locations_mirror, _locations_tolist
 
 from .element import Element, Figure, JavascriptLink, CssLink, Div, MacroElement
 from .map import Map, TileLayer, Icon, Marker, Popup
@@ -479,20 +479,10 @@ def __init__(self, locations, color=None, weight=None, opacity=None, latlon=True
                 Whether locations are given in the form [[lat,lon]] or not ([[lon,lat]] if False).
                 Note that the default GeoJson format is latlon=False,
                 while Leaflet polyline's default is latlon=True.
-
-                examples :
-                    # providing file
-                    GeoJson(open('foo.json'))
-
-                    # providing dict
-                    GeoJson(json.load(open('foo.json')))
-
-                    # providing string
-                    GeoJson(open('foo.json').read())
         """
         super(PolyLine, self).__init__()
         self._name = 'PolyLine'
-        self.data = [[x[1],x[0]] for x in locations] if not latlon else locations
+        self.data = _locations_mirror(locations) if not latlon else _locations_tolist(locations)
         self.color = color
         self.weight = weight
         self.opacity = opacity
@@ -509,3 +499,39 @@ def __init__(self, locations, color=None, weight=None, opacity=None, latlon=True
                 {{this._parent.get_name()}}.addLayer({{this.get_name()}});
             {% endmacro %}
             """)
+
+class MultiPolyLine(MacroElement):
+    def __init__(self, locations, color=None, weight=None, opacity=None, latlon=True):
+        """Creates a MultiPolyLine object to append into a map with Map.add_children.
+
+        Parameters
+        ----------
+            locations: list of points (latitude, longitude)
+                Latitude and Longitude of line (Northing, Easting)
+            color: string, default Leaflet's default ('#03f')
+            weight: float, default Leaflet's default (5)
+            opacity: float, default Leaflet's default (0.5)
+            latlon: bool, default True
+                Whether locations are given in the form [[lat,lon]] or not ([[lon,lat]] if False).
+                Note that the default GeoJson format is latlon=False,
+                while Leaflet polyline's default is latlon=True.
+        """
+        super(MultiPolyLine, self).__init__()
+        self._name = 'MultiPolyLine'
+        self.data = _locations_mirror(locations) if not latlon else _locations_tolist(locations)
+        self.color = color
+        self.weight = weight
+        self.opacity = opacity
+
+        self._template = Template(u"""
+            {% macro script(this, kwargs) %}
+                var {{this.get_name()}} = L.multiPolyline(
+                    {{this.data}},
+                    {
+                        {% if this.color != None %}color: '{{ this.color }}',{% endif %}
+                        {% if this.weight != None %}weight: {{ this.weight }},{% endif %}
+                        {% if this.opacity != None %}opacity: {{ this.opacity }},{% endif %}
+                        });
+                {{this._parent.get_name()}}.addLayer({{this.get_name()}});
+            {% endmacro %}
+            """)

folium/folium.py

@@ -26,7 +26,7 @@
 from .element import Element, Figure, JavascriptLink, CssLink, Div, MacroElement
 from .map import Map, TileLayer, Icon, Marker, Popup
 from .features import WmsTileLayer, RegularPolygonMarker, Vega, GeoJson, GeoJsonStyle, MarkerCluster, DivIcon,\
-    CircleMarker, LatLngPopup, ClickForMarker, ColorScale, TopoJson, PolyLine
+    CircleMarker, LatLngPopup, ClickForMarker, ColorScale, TopoJson, PolyLine, MultiPolyLine
 from .utilities import color_brewer
 #import sys
 #import base64
@@ -423,38 +423,60 @@ def line(self, locations,
             p.add_children(Popup(popup, max_width=popup_width))
 
         self.add_children(p)
-#    @iter_obj('multiline')
-#    def multiline(self, locations, line_color=None, line_opacity=None,
-#                  line_weight=None):
-#        """Add a multiPolyline to the map with optional styles.
-#
-#        A multiPolyline is single layer that consists of several polylines that
-#        share styling/popup.
-#
-#        Parameters
-#        ----------
-#        locations: list of lists of points (latitude, longitude)
-#            Latitude and Longitude of line (Northing, Easting)
-#        line_color: string, default Leaflet's default ('#03f')
-#        line_opacity: float, default Leaflet's default (0.5)
-#        line_weight: float, default Leaflet's default (5)
-#
-#        Note: If the optional styles are omitted, they will not be included
-#        in the HTML output and will obtain the Leaflet defaults listed above.
-#
-#        Example
-#        -------
-#        # FIXME: Add another example.
-#        >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
-#                                   [(45.5237, -122.675), (45.5237, -122.675)],
-#                                   [(45.5238, -122.675), (45.5238, -122.675)]])
-#        >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
-#                                   [(45.5237, -122.675), (45.5237, -122.675)],
-#                                   [(45.5238, -122.675), (45.5238, -122.675)]],
-#                                   line_color='red', line_weight=2,
-#                                   line_opacity=1.0)
-#        """
-#
+
+    def multiline(self, locations, line_color=None, line_opacity=None,
+                  line_weight=None,
+             popup=None, popup_width=300, latlon=True):
+        """Add a multiPolyline to the map with optional styles.
+
+        A multiPolyline is single layer that consists of several polylines that
+        share styling/popup.
+
+        Parameters
+        ----------
+        locations: list of lists of points (latitude, longitude)
+            Latitude and Longitude of line (Northing, Easting)
+        line_color: string, default Leaflet's default ('#03f')
+        line_opacity: float, default Leaflet's default (0.5)
+        line_weight: float, default Leaflet's default (5)
+        popup: string or tuple, default 'Pop Text'
+            Input text or visualization for object. Can pass either text,
+            or a tuple of the form (Vincent object, 'vis_path.json')
+            It is possible to adjust the width of text/HTML popups
+            using the optional keywords `popup_width` (default is 300px).
+        latlon: bool, default True
+            Whether locations are given in the form [[lat,lon]] or not ([[lon,lat]] if False).
+            Note that the default GeoJson format is latlon=False,
+            while Leaflet polyline's default is latlon=True.
+
+        Note: If the optional styles are omitted, they will not be included
+        in the HTML output and will obtain the Leaflet defaults listed above.
+
+        Example
+        -------
+        # FIXME: Add another example.
+        >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
+                                   [(45.5237, -122.675), (45.5237, -122.675)],
+                                   [(45.5238, -122.675), (45.5238, -122.675)]])
+        >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
+                                   [(45.5237, -122.675), (45.5237, -122.675)],
+                                   [(45.5238, -122.675), (45.5238, -122.675)]],
+                                   line_color='red', line_weight=2,
+                                   line_opacity=1.0)
+        """
+
+        p = MultiPolyLine(locations,
+                     color=line_color,
+                     weight=line_weight,
+                     opacity=line_opacity,
+                     latlon=latlon,
+                     )
+
+        if popup is not None:
+            p.add_children(Popup(popup, max_width=popup_width))
+
+        self.add_children(p)
+
 #        count = self.mark_cnt['multiline']
 #
 #        multiline_temp = self.env.get_template('multi_polyline.js')

folium/templates/multi_polyline.js

@@ -1,13 +1,5 @@
-var latLngs = [
-{% for location in locations %}
-    [
-    {% for loc in location %}
-        [{{ loc[0] }}, {{ loc[1] }}],
-    {% endfor %}
-    ],
-{% endfor %}];
-
-var {{ multiline }} = L.multiPolyline(latLngs,{
+var {{ this.get_name() }} = L.multiPolyline({{locations}},
+    {
 {% if options.color != None %}color: '{{ options.color }}',{% endif %}
 {% if options.weight != None %}weight: {{ options.weight }},{% endif %}
 {% if options.opacity != None %}opacity: {{ options.opacity }},{% endif %}

folium/utilities.py

@@ -408,3 +408,23 @@ def _parse_size(value):
         msg = "Cannot parse value {!r} as {!r}".format
         raise ValueError(msg(value, value_type))
     return value, value_type
+
+def _locations_mirror(x):
+    """Mirrors the points in a list-of-list-of-...-of-list-of-points.
+    For example _locations_mirror([[[1,2],[3,4]],[5,6],[7,8]]) = [[[2, 1], [4, 3]], [6, 5], [8, 7]]
+    """
+    if hasattr(x, '__iter__'):
+        if hasattr(x[0], '__iter__'):
+            return list(map(_locations_mirror,x))
+        else:
+            return list(x[::-1])
+    else:
+        return x
+
+def _locations_tolist(x):
+    """Transforms recusively a list of iterables into a list of list.
+    """
+    if hasattr(x, '__iter__'):
+        return list(map(_locations_tolist,x))
+    else:
+        return x

tests/test_folium.py

@@ -20,7 +20,7 @@
 from folium.element import Html
 from folium.map import Popup, Marker, Icon
 from folium.features import DivIcon, CircleMarker, LatLngPopup, GeoJson,\
-    GeoJsonStyle, ColorScale, TopoJson, PolyLine
+    GeoJsonStyle, ColorScale, TopoJson, PolyLine, MultiPolyLine
 
 
 rootpath = os.path.abspath(os.path.dirname(__file__))
@@ -586,15 +586,22 @@ def test_multi_polyline(self):
         locations = [[[45.5236, -122.6750], [45.5236, -122.6751]],
                      [[45.5237, -122.6750], [45.5237, -122.6751]],
                      [[45.5238, -122.6750], [45.5238, -122.6751]]]
-        multiline_rendered = multiline_temp.render({'multiline': 'multiline_1',
-                                                    'locations': locations,
-                                                    'options': multiline_opts})
 
+        self.setup()
         self.map.multiline(locations=locations,
                            line_color=multiline_opts['color'],
                            line_weight=multiline_opts['weight'],
                            line_opacity=multiline_opts['opacity'])
-        assert self.map.template_vars['multilines'][0][0] == multiline_rendered
+        multipolyline = [val for key,val in self.map._children.items()\
+                    if isinstance(val,MultiPolyLine)][0]
+        out = self.map._parent.render()
+
+        multiline_rendered = multiline_temp.render({'multiline': 'multiline_1',
+                                                    'this' : multipolyline,
+                                                    'locations': locations,
+                                                    'options': multiline_opts})
+
+        assert ''.join(multiline_rendered.split()) in ''.join(out.split())
 
     def test_fit_bounds(self):
         """Test fit_bounds."""