Second iteration of the tests

Author: hansthen

folium/features.py

@@ -23,9 +23,9 @@
 )
 from branca.utilities import color_brewer
 
+import folium.map
 from folium.elements import JSCSSMixin
 from folium.folium import Map
-from folium.map import FeatureGroup, Icon, Layer, Marker, Popup, Tooltip
 from folium.template import Template
 from folium.utilities import (
     TypeBoundsReturn,
@@ -47,7 +47,7 @@
 from folium.vector_layers import Circle, CircleMarker, PolyLine, path_options
 
 
-class RegularPolygonMarker(JSCSSMixin, Marker):
+class RegularPolygonMarker(JSCSSMixin, folium.map.Marker):
     """
     Custom markers using the Leaflet Data Vis Framework.
 
@@ -96,8 +96,8 @@ def __init__(
         number_of_sides: int = 4,
         rotation: int = 0,
         radius: int = 15,
-        popup: Union[Popup, str, None] = None,
-        tooltip: Union[Tooltip, str, None] = None,
+        popup: Union[folium.map.Popup, str, None] = None,
+        tooltip: Union[folium.map.Tooltip, str, None] = None,
         **kwargs: TypePathOptions,
     ):
         super().__init__(location, popup=popup, tooltip=tooltip)
@@ -297,7 +297,7 @@ def __init__(
     def render(self, **kwargs):
         """Renders the HTML representation of the element."""
         parent = self._parent
-        if not isinstance(parent, (Figure, Div, Popup)):
+        if not isinstance(parent, (Figure, Div, folium.map.Popup)):
             raise TypeError(
                 "VegaLite elements can only be added to a Figure, Div, or Popup"
             )
@@ -467,7 +467,7 @@ def _embed_vegalite_v1(self, figure: Figure, parent: TypeContainer) -> None:
         )
 
 
-class GeoJson(Layer):
+class GeoJson(folium.map.Layer):
     """
     Creates a GeoJson object for plotting into a Map.
 
@@ -675,11 +675,11 @@ def __init__(
         control: bool = True,
         show: bool = True,
         smooth_factor: Optional[float] = None,
-        tooltip: Union[str, Tooltip, "GeoJsonTooltip", None] = None,
+        tooltip: Union[str, folium.map.Tooltip, "GeoJsonTooltip", None] = None,
         embed: bool = True,
         popup: Optional["GeoJsonPopup"] = None,
         zoom_on_click: bool = False,
-        marker: Union[Circle, CircleMarker, Marker, None] = None,
+        marker: Union[Circle, CircleMarker, folium.map.Marker, None] = None,
         **kwargs: Any,
     ):
         super().__init__(name=name, overlay=overlay, control=control, show=show)
@@ -693,7 +693,7 @@ def __init__(
         self.highlight = highlight_function is not None
         self.zoom_on_click = zoom_on_click
         if marker:
-            if not isinstance(marker, (Circle, CircleMarker, Marker)):
+            if not isinstance(marker, (Circle, CircleMarker, folium.map.Marker)):
                 raise TypeError(
                     "Only Marker, Circle, and CircleMarker are supported as GeoJson marker types."
                 )
@@ -721,11 +721,11 @@ def __init__(
                 self.highlight_map: dict = {}
             self.feature_identifier = self.find_identifier()
 
-        if isinstance(tooltip, (GeoJsonTooltip, Tooltip)):
+        if isinstance(tooltip, (GeoJsonTooltip, folium.map.Tooltip)):
             self.add_child(tooltip)
         elif tooltip is not None:
-            self.add_child(Tooltip(tooltip))
-        if isinstance(popup, (GeoJsonPopup, Popup)):
+            self.add_child(folium.map.Tooltip(tooltip))
+        if isinstance(popup, (GeoJsonPopup, folium.map.Popup)):
             self.add_child(popup)
 
     def process_data(self, data: Any) -> dict:
@@ -916,7 +916,7 @@ def _set_default_key(mapping: TypeStyleMapping) -> None:
         del mapping[key_longest]
 
 
-class TopoJson(JSCSSMixin, Layer):
+class TopoJson(JSCSSMixin, folium.map.Layer):
     """
     Creates a TopoJson object for plotting into a Map.
 
@@ -1011,7 +1011,7 @@ def __init__(
         control: bool = True,
         show: bool = True,
         smooth_factor: Optional[float] = None,
-        tooltip: Union[str, Tooltip, None] = None,
+        tooltip: Union[str, folium.map.Tooltip, None] = None,
     ):
         super().__init__(name=name, overlay=overlay, control=control, show=show)
         self._name = "TopoJson"
@@ -1035,10 +1035,10 @@ def __init__(
 
         self.smooth_factor = smooth_factor
 
-        if isinstance(tooltip, (GeoJsonTooltip, Tooltip)):
+        if isinstance(tooltip, (GeoJsonTooltip, folium.map.Tooltip)):
             self.add_child(tooltip)
         elif tooltip is not None:
-            self.add_child(Tooltip(tooltip))
+            self.add_child(folium.map.Tooltip(tooltip))
 
     def style_data(self) -> None:
         """Applies self.style_function to each feature of self.data."""
@@ -1377,7 +1377,7 @@ def __init__(
         self.popup_options = kwargs
 
 
-class Choropleth(FeatureGroup):
+class Choropleth(folium.map.FeatureGroup):
     """Apply a GeoJSON overlay to the map.
 
     Plot a GeoJSON overlay on the base map. There is no requirement
@@ -1855,7 +1855,7 @@ def __init__(self, format_str: Optional[str] = None, alert: bool = True):
         self.alert = alert
 
 
-class CustomIcon(Icon):
+class CustomIcon(folium.map.Icon):
     """
     Create a custom icon, based on an image.
 
@@ -1908,7 +1908,7 @@ def __init__(
         shadow_anchor: Optional[Tuple[int, int]] = None,
         popup_anchor: Optional[Tuple[int, int]] = None,
     ):
-        super(Icon, self).__init__()
+        super(folium.map.Icon, self).__init__()
         self._name = "CustomIcon"
         self.options = remove_empty(
             icon_url=image_to_url(icon_image),
@@ -1921,7 +1921,7 @@ def __init__(
         )
 
 
-class ColorLine(FeatureGroup):
+class ColorLine(folium.map.FeatureGroup):
     """
     Draw data on a map with specified colors.
 

folium/map.py

@@ -9,6 +9,7 @@
 
 from branca.element import Element, Figure, Html, MacroElement
 
+import folium.features as features
 from folium.elements import ElementAddToElement, EventHandler
 from folium.template import Template
 from folium.utilities import (
@@ -408,8 +409,7 @@ def __init__(
         # this attribute is not used by Marker, but by GeoJson
         self.icon = None
         if icon is not None:
-            self.add_child(icon)
-            self.icon = icon
+            self.set_icon(icon)
         if popup is not None:
             self.add_child(popup if isinstance(popup, Popup) else Popup(str(popup)))
         if tooltip is not None:
@@ -434,6 +434,16 @@ def render(self):
             self.add_child(self.SetIcon(marker=self, icon=self.icon))
         super().render()
 
+    def set_icon(self, icon: Union[Icon, "CustomIcon", "DivIcon"]):
+        super().add_child(icon)
+        self.icon = icon
+
+    def add_child(self, child, name=None, index=None):
+        if isinstance(child, (Icon, features.CustomIcon, features.DivIcon)):
+            self.set_icon(child)
+        else:
+            super().add_child(child, name, index)
+
 
 class Popup(MacroElement):
     """Create a Popup instance that can be linked to a Layer.

folium/plugins/search.py

@@ -1,7 +1,10 @@
 from branca.element import MacroElement
 
+from folium import FeatureGroup, GeoJson, TopoJson
 from folium.elements import JSCSSMixin
-from folium.features import FeatureGroup, GeoJson, TopoJson
+
+# from folium.map import FeatureGroup
+# from folium.features import GeoJson, TopoJson
 from folium.folium import Map
 from folium.plugins import MarkerCluster
 from folium.template import Template

requirements-dev.txt

@@ -25,6 +25,7 @@ nbval
 owslib
 pandas >=2
 pillow
+pixelmatch
 pre-commit
 pycodestyle
 pydata-sphinx-theme

tests/playwright/regressions/main.py

@@ -0,0 +1,11 @@
+import streamlit as st
+
+st.logo("https://python-visualization.github.io/folium/latest/_static/folium_logo.png")
+st.title("Python data, leaflet.js maps")
+
+st.write(
+    """
+This app is meant to store regression tests. For issues, create a
+test pages under pages with the format issue_d+.
+"""
+)

tests/playwright/regressions/pages/issue_1885.py

@@ -0,0 +1,31 @@
+from streamlit_folium import st_folium
+
+import folium
+
+# Library of Congress coordinates (latitude, longitude)
+loc_coordinates = (38.8886, -77.0047)
+
+# Create a Folium map centered around the Library of Congress
+map_lc = folium.Map(location=loc_coordinates, zoom_start=15)
+
+# Define the DivIcon with the custom icon.  This variable can be used in one marker successfully, but will fail if we use it in two markers.
+
+
+icon = folium.DivIcon(
+    icon_anchor=(15, 15),
+    html="""<div><img src="/app/static/book-open-variant-outline.png" height="35" width="35"/></div>""",
+)
+
+
+folium.Marker(
+    location=(38.886970844230866, -77.00471380332),
+    popup="Library of Congress:  James Madison Building",
+    icon=icon,
+).add_to(map_lc)
+
+folium.Marker(location=loc_coordinates, popup="Library of Congress", icon=icon).add_to(
+    map_lc
+)
+# if we save here, everything will be fine.
+
+st_folium(map_lc, width=600, height=500)

tests/playwright/regressions/pages/issue_1885_add_child.py

@@ -0,0 +1,32 @@
+from streamlit_folium import st_folium
+
+import folium
+
+# Library of Congress coordinates (latitude, longitude)
+loc_coordinates = (38.8886, -77.0047)
+
+# Create a Folium map centered around the Library of Congress
+map_lc = folium.Map(location=loc_coordinates, zoom_start=15)
+
+# Define the DivIcon with the custom icon.  This variable can be used in one marker successfully, but will fail if we use it in two markers.
+icon = folium.DivIcon(
+    icon_anchor=(15, 15),
+    html="""<div><img src="/app/static/book-open-variant-outline.png" height="35" width="35"/></div>""",
+)
+
+
+folium.Marker(
+    location=(38.886970844230866, -77.00471380332),
+    popup="Library of Congress:  James Madison Building",
+    icon=icon,
+).add_to(map_lc)
+
+marker = folium.Marker(
+    location=loc_coordinates,
+    popup="Library of Congress",
+).add_to(map_lc)
+
+marker.add_child(icon)
+# if we save here, everything will be fine.
+
+st_folium(map_lc, width=600, height=500)

tests/playwright/regressions/pages/issue_1885_add_to.py

@@ -0,0 +1,34 @@
+from streamlit_folium import st_folium
+
+import folium
+
+# Library of Congress coordinates (latitude, longitude)
+loc_coordinates = (38.8886, -77.0047)
+
+# Create a Folium map centered around the Library of Congress
+map_lc = folium.Map(location=loc_coordinates, zoom_start=15)
+
+# Define the DivIcon with the custom icon.  This variable can be used in one marker successfully, but will fail if we use it in two markers.
+
+
+icon = folium.DivIcon(
+    icon_anchor=(15, 15),
+    html="""<div><img src="/app/static/book-open-variant-outline.png" height="35" width="35"/></div>""",
+)
+
+
+folium.Marker(
+    location=(38.886970844230866, -77.00471380332),
+    popup="Library of Congress:  James Madison Building",
+    icon=icon,
+).add_to(map_lc)
+
+marker = folium.Marker(
+    location=loc_coordinates,
+    popup="Library of Congress",
+).add_to(map_lc)
+# if we save here, everything will be fine.
+
+icon.add_to(marker)
+
+st_folium(map_lc, width=600, height=500)

tests/playwright/regressions/pages/issue_1885_set_icon.py

@@ -0,0 +1,31 @@
+from streamlit_folium import st_folium
+
+import folium
+
+# Library of Congress coordinates (latitude, longitude)
+loc_coordinates = (38.8886, -77.0047)
+
+# Create a Folium map centered around the Library of Congress
+map_lc = folium.Map(location=loc_coordinates, zoom_start=15)
+
+# Define the DivIcon with the custom icon.  This variable can be used in one marker successfully, but will fail if we use it in two markers.
+
+
+icon = folium.DivIcon(
+    icon_anchor=(15, 15),
+    html="""<div><img src="/app/static/book-open-variant-outline.png" height="35" width="35"/></div>""",
+)
+
+
+marker1 = folium.Marker(
+    location=(38.886970844230866, -77.00471380332),
+    popup="Library of Congress:  James Madison Building",
+).add_to(map_lc)
+
+marker2 = folium.Marker(
+    location=loc_coordinates, popup="Library of Congress", icon=icon
+).add_to(map_lc)
+marker1.set_icon(icon)
+marker2.set_icon(icon)
+
+st_folium(map_lc, width=600, height=500)