Re-factor Circle and CircleMarker (#683)

* refactor circle

* add tests

* fix typo

* update changelog

Author: ocefpaf

CHANGES.txt

@@ -12,9 +12,11 @@
 
 API changes
 
+- `Circle` and `CircleMarker` are set to leaflet's defaults and accepted all
+  `Path` optional arguments (# 683)
 - Changed default `max_bounds` to `False` to reflect leaflet's default value (rdd9999 #641)
-- Modified `Fullscreen` plugin `kwargs` to be more "pythonic."
-- All `.format` properties are now `.fmt` for consistency.
+- Modified `Fullscreen` plugin `kwargs` to be more "pythonic"
+- All `.format` properties are now `.fmt` for consistency
 
 Bug Fixes
 

examples/Features.ipynb

@@ -9,7 +9,7 @@
 from folium._version import get_versions
 
 from folium.features import (
-    CircleMarker, ClickForMarker, CustomIcon, DivIcon, GeoJson, LatLngPopup,
+    Circle, CircleMarker, ClickForMarker, CustomIcon, DivIcon, GeoJson, LatLngPopup,
     MarkerCluster, PolyLine, RegularPolygonMarker, TopoJson, Vega, VegaLite,
     WmsTileLayer,
 )
@@ -37,6 +37,7 @@
     'LinearColormap',
     'StepColormap',
     'Map',
+    'Circle',
     'CircleMarker',
     'RectangleMarker',
     'Polygon',

folium/__init__.py

@@ -17,7 +17,7 @@
 from branca.utilities import (_locations_tolist, _parse_size, image_to_url, iter_points, none_max, none_min)  # noqa
 
 from folium.map import FeatureGroup, Icon, Layer, Marker, Popup
-from folium.utilities import _validate_coordinates, _validate_location
+from folium.utilities import _parse_path, _validate_coordinates, _validate_location
 
 from jinja2 import Template
 
@@ -809,43 +809,37 @@ class Circle(Marker):
     location: tuple or list, default None
         Latitude and Longitude of Marker (Northing, Easting)
     radius: int
-        The radius of the circle in meters. For setting the radius in pixel,
-        use CircleMarker.
-    color: str, default 'black'
+        The radius of the circle in meters.
+        For setting the radius in pixel, use CircleMarker.
+    color: str, default '#3388ff'
         The color of the marker's edge in a HTML-compatible format.
-    fill_color: str, default 'black'
+    fill: bool, default False
+        If true the circle will be filled.
+    fill_color: str, default to the same as color
         The fill color of the marker in a HTML-compatible format.
-    fill_opacity: float, default 0.6
+    fill_opacity: float, default 0.2
         The fill opacity of the marker, between 0. and 1.
     popup: string or folium.Popup, default None
         Input text or visualization for object.
 
+    See http://leafletjs.com/reference-1.2.0.html#path for more otions.
+
     """
-    def __init__(self, location, radius=500, color='black',
-                 fill_color='black', fill_opacity=0.6, popup=None):
-        super(Circle, self).__init__(
-            _validate_location(location),
-            popup=popup
-        )
-        self._name = 'Circle'
-        self.radius = radius
-        self.color = color
-        self.fill_color = fill_color
-        self.fill_opacity = fill_opacity
+    def __init__(self, location, radius=10, popup=None, **kw):
+        super(Circle, self).__init__(_validate_location(location), popup=popup)
+        self._name = 'circle'
+        options = _parse_path(**kw)
+
+        options.update({'radius': radius})
+        self.options = json.dumps(options, sort_keys=True, indent=2)
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
 
             var {{this.get_name()}} = L.circle(
                 [{{this.location[0]}},{{this.location[1]}}],
-                {{ this.radius }},
-                {
-                    color: '{{ this.color }}',
-                    fillColor: '{{ this.fill_color }}',
-                    fillOpacity: {{ this.fill_opacity }}
-                    }
-                )
-                .addTo({{this._parent.get_name()}});
+                {{ this.options }}
+                ).addTo({{this._parent.get_name()}});
             {% endmacro %}
             """)
 
@@ -859,45 +853,37 @@ class CircleMarker(Marker):
     location: tuple or list, default None
         Latitude and Longitude of Marker (Northing, Easting)
     radius: int
-        The radius of the circle in pixels. For setting the radius in meter,
-        use Circle.
-    color: str, default 'black'
+        The radius of the circle in pixels.
+        For setting the radius in meter, use Circle.
+    color: str, default '#3388ff'
         The color of the marker's edge in a HTML-compatible format.
-    weight: int, default 2
-        Stroke weight in pixels
-    fill_color: str, default 'black'
+    fill: bool, default False
+        If true the circle will be filled.
+    fill_color: str, default to the same as color
         The fill color of the marker in a HTML-compatible format.
-    fill_opacity: float, default 0.6
+    fill_opacity: float, default 0.2
         The fill opacity of the marker, between 0. and 1.
     popup: string or folium.Popup, default None
         Input text or visualization for object.
 
+    See http://leafletjs.com/reference-1.2.0.html#path for more otions.
+
     """
-    def __init__(self, location, radius=500, color='black',
-                 weight=2, fill_color='black', fill_opacity=0.6,
-                 popup=None):
-        super(CircleMarker, self).__init__(location, popup=popup)
+    def __init__(self, location, radius=10, popup=None, **kw):
+        super(CircleMarker, self).__init__(_validate_location(location), popup=popup)
         self._name = 'CircleMarker'
-        self.radius = radius
-        self.color = color
-        self.weight = weight
-        self.fill_color = fill_color
-        self.fill_opacity = fill_opacity
+        options = _parse_path(**kw)
+
+        options.update({'radius': radius})
+        self.options = json.dumps(options, sort_keys=True, indent=2)
 
         self._template = Template(u"""
             {% macro script(this, kwargs) %}
 
             var {{this.get_name()}} = L.circleMarker(
                 [{{this.location[0]}},{{this.location[1]}}],
-                {
-                    color: '{{ this.color }}',
-                    weight: {{ this.weight }},
-                    fillColor: '{{ this.fill_color }}',
-                    fillOpacity: {{ this.fill_opacity }}
-                    }
-                )
-                .setRadius({{ this.radius }})
-                .addTo({{this._parent.get_name()}});
+                {{ this.options }}
+                ).addTo({{this._parent.get_name()}});
             {% endmacro %}
             """)
 

folium/features.py

@@ -48,3 +48,23 @@ def _flatten(container):
 def _isnan(values):
     """Check if there are NaNs values in the iterable."""
     return any(math.isnan(value) for value in _flatten(values))
+
+
+def _parse_path(**kw):
+    """Parse Path http://leafletjs.com/reference-1.2.0.html#path options."""
+    color = kw.pop('color', '#3388ff')
+    return {
+        'stroke': kw.pop('stroke', True),
+        'color': color,
+        'weight': kw.pop('weight', 3),
+        'opacity': kw.pop('opacity', 1.0),
+        'lineCap': kw.pop('line_cap', 'round'),
+        'lineJoin': kw.pop('line_join', 'round'),
+        'dashArray': kw.pop('dash_array', None),
+        'dashOffset': kw.pop('dash_offset', None),
+        'fill': kw.pop('fill', False),
+        'fillColor': kw.pop('fill_color', color),
+        'fillOpacity': kw.pop('fill_opacity', 0.2),
+        'fillRule': kw.pop('fill_rule', 'evenodd'),
+        'bubblingMouseEvents': kw.pop('bubbling_mouse_events', True),
+    }

folium/templates/circle_marker.js

@@ -0,0 +1,146 @@
+# -*- coding: utf-8 -*-
+
+""""
+Circle and Circle Marker Features
+---------------------------------
+
+"""
+
+from __future__ import (absolute_import, division, print_function)
+
+import json
+
+from folium import Map
+from folium.features import Circle, CircleMarker
+
+
+def test_circle():
+    m = Map()
+    radius = 10000
+    popup = 'I am {} meters'.format(radius)
+
+    circle = Circle(
+        location=[-27.551667, -48.478889],
+        radius=radius,
+        color='black',
+        weight=2,
+        fill_opacity=0.6,
+        opacity=1,
+        fill=True,
+        popup=popup,
+    )
+    circle.add_to(m)
+
+    options = {
+        'bubblingMouseEvents': True,
+        'color': 'black',
+        'dashArray': None,
+        'dashOffset': None,
+        'fill': True,
+        'fillColor': 'black',
+        'fillOpacity': 0.6,
+        'fillRule': 'evenodd',
+        'lineCap': 'round',
+        'lineJoin': 'round',
+        'opacity': 1,
+        'radius': 10000,
+        'stroke': True,
+        'weight': 2,
+    }
+
+    m._repr_html_()
+    expected_bounds = [[-27.551667, -48.478889], [-27.551667, -48.478889]]
+    expected_rendered = """
+    var {0} = L.circle(
+    [-27.551667,-48.478889],
+    {{
+    "bubblingMouseEvents": true,
+    "color": "black",
+    "dashArray": null,
+    "dashOffset": null,
+    "fill": true,
+    "fillColor": "black",
+    "fillOpacity": 0.6,
+    "fillRule": "evenodd",
+    "lineCap": "round",
+    "lineJoin": "round",
+    "opacity": 1,
+    "radius": 10000,
+    "stroke": true,
+    "weight": 2
+    }}
+    ).addTo({1});
+    """.format(circle.get_name(), m.get_name())
+
+    rendered = circle._template.module.script(circle)
+    assert rendered.strip().split() == expected_rendered.strip().split()
+    assert circle.get_bounds() == expected_bounds
+    assert json.dumps(circle.to_dict()) == circle.to_json()
+    assert circle.location == [-27.551667, -48.478889]
+    assert circle.options == json.dumps(options, sort_keys=True, indent=2)
+
+
+def test_circle_marker():
+    m = Map()
+    radius = 50
+    popup = 'I am {} pixels'.format(radius)
+
+    circle_marker = CircleMarker(
+        location=[-27.55, -48.8],
+        radius=radius,
+        color='black',
+        weight=2,
+        fill_opacity=0.6,
+        opacity=1,
+        fill=True,
+        popup=popup,
+    )
+    circle_marker.add_to(m)
+
+    options = {
+        'bubblingMouseEvents': True,
+        'color': 'black',
+        'dashArray': None,
+        'dashOffset': None,
+        'fill': True,
+        'fillColor': 'black',
+        'fillOpacity': 0.6,
+        'fillRule': 'evenodd',
+        'lineCap': 'round',
+        'lineJoin': 'round',
+        'opacity': 1,
+        'radius': 50,
+        'stroke': True,
+        'weight': 2,
+    }
+
+    m._repr_html_()
+    expected_bounds = [[-27.55, -48.8], [-27.55, -48.8]]
+    expected_rendered = """
+    var {0} = L.circleMarker(
+    [-27.55,-48.8],
+    {{
+    "bubblingMouseEvents": true,
+    "color": "black",
+    "dashArray": null,
+    "dashOffset": null,
+    "fill": true,
+    "fillColor": "black",
+    "fillOpacity": 0.6,
+    "fillRule": "evenodd",
+    "lineCap": "round",
+    "lineJoin": "round",
+    "opacity": 1,
+    "radius": 50,
+    "stroke": true,
+    "weight": 2
+    }}
+    ).addTo({1});
+    """.format(circle_marker.get_name(), m.get_name())
+
+    rendered = circle_marker._template.module.script(circle_marker)
+    assert rendered.strip().split() == expected_rendered.strip().split()
+    assert circle_marker.get_bounds() == expected_bounds
+    assert json.dumps(circle_marker.to_dict()) == circle_marker.to_json()
+    assert circle_marker.location == [-27.55, -48.8]
+    assert circle_marker.options == json.dumps(options, sort_keys=True, indent=2)

folium/utilities.py

@@ -199,42 +199,6 @@ def test_feature_group(self):
         bounds = m.get_bounds()
         assert bounds == [[45, -30], [45, 30]], bounds
 
-    def test_circle_marker(self):
-        """Test circle marker additions."""
-
-        self.m = folium.Map(location=[45.60, -122.8])
-        circ_templ = self.env.get_template('circle_marker.js')
-
-        # Single Circle marker.
-        marker = folium.features.CircleMarker([45.60, -122.8], popup='Hi')
-        self.m.add_child(marker)
-        circle_1 = circ_templ.render({'circle': marker.get_name(),
-                                      'lat': 45.60,
-                                      'lon': -122.8, 'radius': 500,
-                                      'weight': 2,
-                                      'line_color': 'black',
-                                      'fill_color': 'black',
-                                      'fill_opacity': 0.6})
-        assert (''.join(circle_1.split())[:-1] in
-                ''.join(self.m.get_root().render().split()))
-
-        # Second circle marker.
-        marker = folium.features.CircleMarker([45.70, -122.9], popup='Hi',
-                                              weight=1)
-        self.m.add_child(marker)
-        circle_2 = circ_templ.render({'circle': marker.get_name(),
-                                      'lat': 45.70,
-                                      'lon': -122.9, 'radius': 500,
-                                      'weight': 1,
-                                      'line_color': 'black',
-                                      'fill_color': 'black',
-                                      'fill_opacity': 0.6})
-        assert (''.join(circle_2.split())[:-1] in
-                ''.join(self.m.get_root().render().split()))
-
-        bounds = self.m.get_bounds()
-        assert bounds == [[45.6, -122.9], [45.7, -122.8]], bounds
-
     def test_rectangle_marker(self):
         """Test rectangle marker additions."""